プロモーションを編集する

既存のプロモーションは、Aptoide Connect デベロッパーコンソール を通じて、またはこの API エンドポイントを介してプログラムで更新できます。

エンドポイント

メソッド	URL
PATCH	https://ws.catappult.io/api/promotions/{uid}

認証

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

⚠️

必要なアカウントタイプ

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

ヘッダー

ヘッダー	タイプ	必須	説明
Api-Key	string	必須	API リクエストの認証に使用されます。値は Aptoide Connect の API キーです。

パスパラメーター

パラメーター	タイプ	説明
uid	string	プロモーションの一意の識別子 (UUID) (例: 9dbf70ff-30a4-4d82-b062-42ab24126e59)。

ボディパラメーター

すべてのボディパラメーターは 任意 です。リクエストに含めたフィールドのみが更新されます。このエンドポイントは application/json または multipart/form-data のいずれかを受け付けます。

パラメーター	タイプ	説明
name	string	プロモーションの表示名を更新します。
description	string	プロモーションのフリーテキスト説明を更新します。
eventUid	string	このプロモーションを UUID で既存のイベントにリンクします。プロモーションの event フィールドが、そのイベントを参照するように更新されます。
startTimestamp	string	新しいプロモーション開始日時。形式: YYYY-MM-DD HH:mm:ss。
endTimestamp	string	新しいプロモーション終了日時。形式: YYYY-MM-DD HH:mm:ss。
partnerName	string	所有パートナー識別子を更新します。有効な値については利用可能なパートナーの一覧を参照してください。
files[<index>]	file	プロモーションの外観を示す画像ファイル (スクリーンショットやバナーアセットなど)。multipart/form-data として送信されます。複数の画像をアップロードするには、インデックス付きのキー ([0]、[1] など) を使用してください。
filesIds	string	保持する既存のファイル ID のカンマ区切りリスト (例: 385,386)。ID がリストに 含まれていない 既存のファイルは削除されます。一部のファイルを保持して新しいファイルを追加するには、files[<index>] と組み合わせてください。

⚠️

注記

編集時に以前にアップロードしたファイルを保持するには、それらの ID を filesIds にリストします。それらを省略すると、保存されているファイルが削除されます。

ファイルのアップロードには multipart/form-data が必要です。JSON を介して送信することはできません。

例

JSON を介してテキストフィールドを更新する

curl -X PATCH "https://ws.catappult.io/api/promotions/9dbf70ff-30a4-4d82-b062-42ab24126e59" \
  -H "Api-Key: <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Updated Promotion Name",
    "startTimestamp": "2026-03-16 00:00:00",
    "endTimestamp": "2026-04-30 00:00:00"
  }'

既存のファイルを保持して新しいファイルを追加する

curl -X PATCH "https://ws.catappult.io/api/promotions/9dbf70ff-30a4-4d82-b062-42ab24126e59" \
  -H "Api-Key: <YOUR_API_KEY>" \
  -F "filesIds=385" \
  -F "files[0]=@/path/to/new-asset.png"

レスポンス

成功

API 呼び出しが HTTP 200 ステータスコード を返した場合、リクエストは 成功 しており、プロモーションが更新されています。

レスポンス例

"Promotion updated."