利用可能なプロモーションタイプの一覧
このエンドポイントは、(type フィールドを介して)プロモーションを定義する際に使用できる、指定したパートナーで利用可能なすべてのタイプの一覧を返します。利用可能なタイプのセットはパートナーによって異なります。
エンドポイント
| メソッド | URL |
|---|---|
| GET | https://ws.catappult.io/api/promotions/partners/{partnerName}/types |
認証
この API にアクセスするには、Aptoide Connect でアクティブなアカウントサブスクリプションを保有し、API キーで認証する必要があります(生成方法はこちらを確認してください)。
ヘッダー
| ヘッダー | 型 | 必須 | 説明 |
|---|---|---|---|
Api-Key | string | 必須 | API リクエストの認証に使用されます。値は Aptoide Connect の API キーです。 |
パスパラメータ
| パラメータ | 型 | 説明 |
|---|---|---|
partnerName | string | プロモーションタイプを一覧表示したいパートナーの識別子(例: APTOIDE-GAMES)。有効な値については、利用可能なパートナーの一覧を参照してください。 |
リクエスト例
curl -X GET "https://ws.catappult.io/api/promotions/partners/APTOIDE-GAMES/types" \
-H "Api-Key: <YOUR_API_KEY>"
レスポンス
成功
API 呼び出しが HTTP 200 ステータスコードを返した場合、リクエストは成功であり、指定したパートナーで有効なプロモーションタイプ文字列の JSON 配列が返されます。
レスポンス例
[
"EDITORS-CHOICE",
"EDITORIAL-ARTICLE",
"HOME-BUNDLE",
"PROMOTIONAL-CARD",
"GAMES-OF-THE-WEEK",
"SEARCH",
"APPVIEW-POST-INSTALL"
]