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

プロモーションの一覧

アカウントに関連付けられたプロモーションのリストは、Aptoide Connect デベロッパーコンソールを通じて、またはこの API エンドポイントを使用してプログラムから取得できます。

エンドポイント​

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

認証​

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

ヘッダー​

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

クエリパラメータ​

パラメータ

型

必須

説明

type

string

任意

プロモーションをタイプでフィルタリングします（例: SEARCH）。

applicationName

string

任意

アプリケーションの一意のパッケージ名でプロモーションをフィルタリングします（例: com.example.test）。

partnerName

string

任意

partner.name が指定された識別子に一致するプロモーションをフィルタリングします（例: APTOIDE-GAMES）。有効な値については 利用可能なパートナーの一覧 を参照してください。

startsAfter

string (date)

任意

startTimestamp が指定された日付より後のプロモーションのみを返します。形式: YYYY-MM-DD。

startsBefore

string (date)

任意

startTimestamp が指定された日付より前のプロモーションのみを返します。形式: YYYY-MM-DD。

endsAfter

string (date)

任意

endTimestamp が指定された日付より後のプロモーションのみを返します。形式: YYYY-MM-DD。

endsBefore

string (date)

任意

endTimestamp が指定された日付より前のプロモーションのみを返します。形式: YYYY-MM-DD。

リクエスト例​

curl -X GET "https://ws.catappult.io/api/promotions" \
  -H "Api-Key: <YOUR_API_KEY>"

レスポンス​

成功​

API 呼び出しが HTTP 200 ステータスコードを返した場合、リクエストは成功であり、認証されたアカウントに関連付けられたプロモーションオブジェクトの配列を返します。

プロモーションが（eventUid を介して）イベントにリンクされている場合、event フィールドにはそのイベントの埋め込み表現が含まれます。それ以外の場合は null です。

レスポンス例​

[
  {
    "uid": "9dbf70ff-30a4-4d82-b062-42ab24126e59",
    "name": "Test Promotion 1",
    "type": "SEARCH",
    "status": "active",
    "startTimestamp": "2026-03-16 00:00:00",
    "endTimestamp": "2026-04-30 00:00:00",
    "createdAt": "2026-03-26 20:47:20",
    "updatedAt": "2026-04-01 14:23:34",
    "hasStatistics": false,
    "event": {
      "uid": "56fd535b-b071-402c-a4fa-29807eb050c9",
      "name": "Test Event",
      "type": "CUSTOM",
      "status": "active",
      "startTimestamp": "2026-02-04 00:30:00",
      "endTimestamp": "2026-04-30 00:00:00",
      "createdAt": "2026-02-05 16:06:33",
      "updatedAt": "2026-04-20 15:01:53",
      "allowedPartners": ["APTOIDE-GAMES"],
      "application": {
        "name": "com.aptoide.diceroll.sdk",
        "title": "Aptoide Diceroll SDK",
        "iconUrl": "https://ws.catappult.io/api/applications/com.aptoide.diceroll.sdk/icon",
        "featureGraphicUrl": "https://ws.catappult.io/api/applications/com.aptoide.diceroll.sdk/featureGraphic"
      },
      "data": {
        "allowedPartners": "APTOIDE-GAMES",
        "applySameFilesToAllLocales": "false"
      },
      "locales": [
        {
          "localeName": "en_GB",
          "description": "Test",
          "longDescription": "Test",
          "files": [
            {
              "id": 953,
              "name": "b737866e7065a09e02a8393dd4c83a42_com-aptoide-diceroll-sdk-none-promotion-asset.webp",
              "downloadUrl": "https://cdn-catappult.aptoide.com/promotion_asset/b737866e7065a09e02a8393dd4c83a42_com-aptoide-diceroll-sdk-none-promotion-asset.webp",
              "ratio": "256:125"
            }
          ]
        }
      ]
    },
    "partner": { "name": "APTOIDE-GAMES" },
    "application": {
      "name": "com.aptoide.diceroll.sdk",
      "title": "Aptoide Diceroll SDK",
      "operatingSystem": "android",
      "iconUrl": "https://ws.catappult.io/api/applications/com.aptoide.diceroll.sdk/icon",
      "featureGraphicUrl": "https://ws.catappult.io/api/applications/com.aptoide.diceroll.sdk/featureGraphic"
    },
    "data": {
      "name": "Test Promotion 1",
      "oemId": "562c8031d4a08ba95e682a800cd04448",
      "utmContent": "search"
    },
    "files": [
      {
        "id": 385,
        "name": "64c5826a724c1bb78332c0ed67b5f83b_com-aptoide-diceroll-sdk-none-promotion-asset.png",
        "downloadUrl": "https://cdn-catappult.aptoide.com/promotion_asset/64c5826a724c1bb78332c0ed67b5f83b_com-aptoide-diceroll-sdk-none-promotion-asset.png"
      }
    ]
  }
]

エラー​

HTTP ステータスコード説明
404PARTNER-NOT-FOUNDAPI キーに関連付けられたアカウントに、リンクされたパートナーレコードがありません。