アプリ内製品の追加または編集
この API エンドポイントを介して、1 回のリクエストで新しいアプリ内製品を追加したり、既存のものを更新したりできます。指定した sku を持つアプリ内製品が存在しない場合は作成されます。すでに存在する場合は、指定した値で更新されます。
エンドポイント
| メソッド | URL |
|---|---|
| PUT | https://ws.catappult.io/api/applications/{applicationName}/consumables/{sku} |
認証
この API にアクセスするには、Aptoide Connect でアクティブなアカウントサブスクリプションを持ち、API キーで認証する必要があります(API キーの生成方法についてはこちらを確認してください)。
⚠️
必要なアカウントタイプ
アプリ内製品は、タイプが Developer のアカウントによってのみ作成または編集できます。
ヘッダー
| ヘッダー | タイプ | 必須 | 説明 |
|---|---|---|---|
Api-Key | string | 必須 | API リクエストを認証するために使用されます。値は Aptoide Connect の API キーです。 |
パスパラメータ
| パラメータ | タイプ | 説明 |
|---|---|---|
applicationName | string | アプリケーションの一意のパッケージ名(例: com.example.test)。 |
sku | string | 追加または更新するアプリ内製品の一意の識別子(例: product01)。 |
クエリパラメータ
パラメータ | タイプ | 必須 | 説明 |
|---|---|---|---|
|
| 任意(デフォルト: | アプリ内製品のオペレーティングシステムを指定します。可能な値: |
ボディパラメータ
⚠️
重要
すべてのパラメータは、ファイルをアップロードする代わりに URL を指定する場合でも、常にフォームデータ(multipart/form-data)として送信する必要があります。
JSON リクエストはサポートされていません。各フィールドを送信するには、cURL で -F フラグを使用してください。
注記:
- 国別の小売価格が定義されていない場合、最終的な請求額は購入時に参照価格から自動的に換算されます。
- すべての countryPrices パラメータ(
countryPrices[<country_code>][...])は、サポートされている任意の ISO 3166-1 alpha-2 国コードを使用できます。 - すべての locale パラメータ(
locales[<language_code>][...])は、任意の ISO 639 言語コードを使用できます。複数の言語の locale パラメータを一度に指定できますが、デフォルトとして設定できるのは 1 つのみです。
| パラメータ | タイプ | 必須 | 説明 |
|---|---|---|---|
referencePriceCurrency | string | 必須 | 参照価格の ISO 4217 通貨コード。利用可能な通貨コードを参照してください。 |
referencePriceAmount | string | 必須 | 参照価格の数値。 |
countryPrices[<country_code>] | string | 任意 | 指定した国での価格。 |
locales[<language_code>][title] | string | 任意 | 指定した言語でのタイトル。 |
locales[<language_code>][description] | string | 任意 | 指定した言語での説明。 |
locales[<language_code>][isDefault] | boolean | 任意 | この言語をデフォルトとして設定します。 |
レスポンス
成功
API 呼び出しが HTTP 200 ステータスコードを返した場合、リクエストは成功しており、アプリ内製品が作成または更新されています。
例
アプリ com.example.app 内のアプリ内製品 product01 の例。参照価格は 1 EUR、アメリカ合衆国(US)の国別価格は 2 USD に設定され、英語(en)のローカライズされたコンテンツを含みます(cURL)
curl -X PUT "https://ws.catappult.io/api/applications/com.example.app/consumables/product01?operatingSystem=android" \
-H "Api-Key: YOUR_API_KEY" \
-F "referencePriceCurrency=EUR" \
-F "referencePriceAmount=1" \
-F "countryPrices[US]=2" \
-F "locales[en][title]=Title" \
-F "locales[en][description]=Description" \
-F "locales[en][isDefault]=true"