メインコンテンツまでスキップ

プロモーションを追加する

以下に説明するように、デベロッパーコンソールまたは当社の API を介して、Aptoide Connect 上のアプリケーションの 1 つに対して新しいプロモーションを作成できます。

エンドポイント​

メソッドURL
POSThttps://ws.catappult.io/api/promotions

認証​

この API にアクセスするには、Aptoide Connect 上にアクティブなアカウントサブスクリプションを保有し、API キーで認証する必要があります（生成方法についてはこちらを確認してください）。

⚠️
必要なアカウントタイプ

プロモーションは、Partner タイプのアカウントによってのみ作成、編集、削除できます。

ヘッダー​

ヘッダー型必須説明
Api-Keystring必須API リクエストの認証に使用されます。 値はあなたの Aptoide Connect API キーです。

ボディパラメータ​

このエンドポイントは application/json または multipart/form-data のいずれかを受け付けます。 ファイルのアップロードには multipart/form-data が必要です。

パラメータ型必須説明
applicationNamestring必須プロモーションが属するアプリケーションの一意のパッケージ名（例：com.example.test）。
namestring必須プロモーションの表示名。
typestring必須プロモーションタイプ（例：SEARCH）。
descriptionstring任意プロモーションのフリーテキストの説明。
eventUidstring任意このプロモーションをリンクする既存のイベントの UUID。 設定されている場合、作成されたプロモーションの event フィールドはそのイベントを参照します。
startTimestampstring任意プロモーションの開始日時。 形式：YYYY-MM-DD HH:mm:ss。
endTimestampstring任意プロモーションの終了日時。 形式：YYYY-MM-DD HH:mm:ss。
files[<index>]file任意プロモーションの見た目を示す画像ファイル（スクリーンショットやバナーアセットなど）。multipart/form-data として送信されます。 複数の画像をアップロードするには、インデックス付きのキー（[0]、[1]、…）を使用します。

例​

JSON 経由でプロモーションを作成する

curl -X POST "https://ws.catappult.io/api/promotions" \
  -H "Api-Key: <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
    "applicationName": "com.example.test",
    "name": "Spring Promotion",
    "type": "SEARCH",
    "startTimestamp": "2027-01-01 00:00:00",
    "endTimestamp": "2027-01-02 00:00:00"
  }'

multipart/form-data 経由でアセットファイルを伴うプロモーションを作成する

curl -X POST "https://ws.catappult.io/api/promotions" \
  -H "Api-Key: <YOUR_API_KEY>" \
  -F "applicationName=com.example.test" \
  -F "name=Spring Promotion" \
  -F "type=SEARCH" \
  -F "startTimestamp=2027-01-01 00:00:00" \
  -F "endTimestamp=2027-01-02 00:00:00" \
  -F "files[0]=@/path/to/asset-1.png" \
  -F "files[1]=@/path/to/asset-2.png"

レスポンス​

成功​

API 呼び出しが HTTP 200 ステータスコードを返した場合、リクエストは成功し、プロモーションが作成されています。 レスポンス本文は、新しく作成されたプロモーションの uid（UUID 文字列）です。

レスポンスの例​

"9dbf70ff-30a4-4d82-b062-42ab24126e59"