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

イベントの追加

以下の説明のとおり、デベロッパーコンソールまたは当社の API を通じて、お使いのアプリケーションの 1 つに新しいイベントを作成できます。

エンドポイント​

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

認証​

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

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

イベントは Developer タイプのアカウントでのみ作成、編集、削除できます。

ヘッダー​

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

ボディパラメータ​

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

パラメータ型必須説明
applicationNamestring必須イベントが属するアプリケーションの一意のパッケージ名（例: com.example.test）。
namestring必須イベントの表示名。
typestring任意イベントタイプ（例: CUSTOM）。有効な値については 利用可能なイベントタイプの一覧 を参照してください。
startTimestampstring任意イベントの開始日時。形式: YYYY-MM-DD HH:mm:ss。
endTimestampstring任意イベントの終了日時。形式: YYYY-MM-DD HH:mm:ss。
allowedPartnersstring任意パートナー識別子のカンマ区切りリスト（例: APTOIDE-GAMES,APTOIDE-VANILLA）。有効な値については 利用可能なパートナーの一覧 を参照してください。
locales[<localeName>][description]string任意指定したロケールの短い説明（例: en_GB）。
locales[<localeName>][longDescription]string任意指定したロケールの長い説明。
locales[<localeName>][files][<index>]file任意指定したロケールのアセットファイル。multipart/form-data として送信されます。複数のファイルをアップロードするには、インデックス付きキー（[0]、[1]、…）を使用します。サーバーは各ファイルの ratio をその寸法から自動的に導出します。

例​

JSON 経由でイベントを作成する

curl -X POST "https://ws.catappult.io/api/events" \
  -H "Api-Key: <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
    "applicationName": "com.example.test",
    "name": "Spring Event",
    "type": "CUSTOM",
    "startTimestamp": "2027-01-01 00:00:00",
    "endTimestamp": "2027-01-02 00:00:00",
    "allowedPartners": "APTOIDE-GAMES,APTOIDE-VANILLA",
    "locales": {
      "en_GB": {
        "description": "Short description",
        "longDescription": "Long description"
      }
    }
  }'

multipart/form-data 経由でロケールファイル付きのイベントを作成する

curl -X POST "https://ws.catappult.io/api/events" \
  -H "Api-Key: <YOUR_API_KEY>" \
  -F "applicationName=com.example.test" \
  -F "name=Spring Event" \
  -F "type=CUSTOM" \
  -F "startTimestamp=2027-01-01 00:00:00" \
  -F "endTimestamp=2027-01-02 00:00:00" \
  -F "allowedPartners=APTOIDE-GAMES" \
  -F "locales[en_GB][description]=Short description" \
  -F "locales[en_GB][longDescription]=Long description" \
  -F "locales[en_GB][files][0]=@/path/to/asset-1.webp" \
  -F "locales[en_GB][files][1]=@/path/to/asset-2.webp"

レスポンス​

成功​

API 呼び出しが HTTP 200 ステータスコードを返した場合、リクエストは成功であり、イベントが作成されています。レスポンスボディは、新しく作成されたイベントの uid（UUID 文字列）です。

レスポンス例​

"538aaa1b-c3a2-40a5-97dd-6bf20645482e"