Axon Campaign Management API
Axon Campaign Management APIは、アプリのプロモーションにAppLovinのAppDiscoveryを使用する広告主向けのAPIです。
Axon Campaign Management APIにリクエストを送信することで、キャンペーンとクリエイティブセットの両方を作成および更新し、新しいアセットをアップロードできます。
キャンペーン
/campaign/list
エンドポイント
このエンドポイントにGET
リクエストを送信して、アカウントにある最大100件のキャンペーンのリストを取得します。
このリストは、キャンペーンオブジェクトのJSON配列です。
選択したページにキャンペーンがない場合、このエンドポイントは空の配列を返します。
ターゲットURL
https://api.ads.axon.ai/manage/v1/campaign/list?account_id=«account-ID»
クエリパラメーター
名前 | 説明 | デフォルト |
---|---|---|
ids | コンマで区切られたキャンペーンIDのリスト。これを使用して、特定のIDを持つ結果のみをフィルターします。この方法では、最大100個のIDを指定できます。hashed_ids と一緒に含めないでください。 | null |
hashed_ids | コンマで区切られた外部キャンペーンIDのリスト。これを使用して、指定したIDを持つ結果のみをフィルターします。この方法では、最大100個のIDを指定できます。ids と一緒に含めないでください。 | null |
page | 取得する結果のページ番号。ページ番号は1から始まります。 | 1 |
size | ページごとに返される結果の数。最大100件です。 | 100 |
例
ページネーションされたリクエスト
curl --location 'https://api.ads.axon.ai/manage/v1/campaign/list?account_id=«account-ID»&size=50&page=10' \--header 'Authorization: «campaign-API-key»'
フィルターされたリクエスト
curl --location 'https://api.ads.axon.ai/manage/v1/campaign/list?account_id=«account-ID»&ids=12345' \--header 'Authorization: «campaign-API-key»'
レスポンス
[ { "id": "12345", "name": "test campaign", "status": "LIVE", "platform": "IOS", "budget": { "daily_budget_for_all_countries": 5000, "country_code_to_daily_budget": {} }, "goal": { "goal_value_for_all_countries": "10", "goal_type": "CPI", "country_code_to_goal_value": {} }, "tracking": { "tracking_method": "APPSFLYER", "impression_url": "https://impression.appsflyer.com/id1234567890?pid=applovin_int&af_siteid={APP_ID}&c={CAMPAIGN_NAME}&af_ad={AD_NAME}&af_ad_type={AD_SIZE}&af_channel={AD_TYPE}&af_c_id={CAMPAIGN_ID}&af_adset=_DEFAULT&af_ad_id={AD_ID}&af_viewthrough_lookback=24h&clickid={DID}&idfa={IDFA}&af_ip={IP}&af_lang={LOCALE}&af_ua={USER_AGENT}", "click_url": "https://app.appsflyer.com/id1234567890?pid=applovin_int&af_siteid={APP_ID}&c={CAMPAIGN_NAME}&af_ad={AD_NAME}&af_ad_type={AD_SIZE}&af_channel={AD_TYPE}&af_c_id={CAMPAIGN_ID}&af_adset=_DEFAULT&af_ad_id={AD_ID}&af_click_lookback=7d&clickid={DID}&idfa={IDFA}&af_ip={IP}&af_lang={LOCALE}&af_ua={USER_AGENT}" }, "targeting": [ { "country_code": "HR" }, { "country_code": "MF" }, { "country_code": "RW" }, { "country_code": "CO" } ], "type": "APP", "created_at": "2025-05-22T21:51:01", "package_name": "com.package.name", "itunes_id": "1234567890", "bidding_strategy": "TARGET_GOAL_WITH_CPI_BILLING", "start_date": "2025-05-23T00:00:00", "end_date": "2025-05-30T00:00:00" }]
/campaign/create
エンドポイント
新しいキャンペーンを作成するには、このエンドポイントにPOST
リクエストを送信します。
リクエストボディはキャンペーンオブジェクトです。キャンペーンオブジェクトの表のCreate
列を確認し、リクエストに含めるフィールドを決定します。
このエンドポイントは、このエンドポイントが作成したキャンペーンのキャンペーンID(id
)を含むJSONオブジェクトを返します。
ターゲットURL
https://api.ads.axon.ai/manage/v1/campaign/create?account_id=«account-ID»
例
リクエスト
curl --location 'https://api.ads.axon.ai/manage/v1/campaign/create?account_id=«account-ID»' \--header 'Content-Type: application/json' \--header 'Authorization: «campaign-API-key»' \--data '{ "name": "test", "type": "APP", "start_date": "2025-07-20T00:00:00", "end_date": "2025-07-31T00:00:00", "targeting": [ { "country_code": "US" }, { "country_code": "CA" } ], "budget": { "daily_budget_for_all_countries": 6000 }, "goal": { "goal_value_for_all_countries": "0.3", "goal_type": "CHK_ROAS", "roas_day_target": "DAY28" }, "bidding_strategy": "TARGET_GOAL_WITH_CPI_BILLING", "platform": "ANDROID", "package_name": "com.AppLovin.MaxDemoUnity", "tracking": { "tracking_method": "ADJUST", "impression_url": "https://view.adjust.com/impression/123abc?campaign={CAMPAIGN_NAME}%20({CAMPAIGN_ID})&adgroup={APP_ID}&creative={AD_NAME}&idfa={IDFA}&country={CC}&gps_adid={IDFA}&adgroup_id={PLACEMENT_ID}&ip_address={DEVICE_IP}&campaign_id={CAMPAIGN_ID}&device_type={DEVICE_TYPE}&publisher_id={APP_ID}&tracker_limit=100000&applovin_click_id={DID}&applovin_event_id={EVENT_ID}&external_tracker_ids=1&android_id_lower_sha1={HADID}", "click_url": "https://app.adjust.com/123abc?campaign={CAMPAIGN_NAME}%20({CAMPAIGN_ID})&adgroup={APP_ID}&creative={AD_NAME}&idfa={IDFA}&country={CC}&gps_adid={IDFA}&adgroup_id={PLACEMENT_ID}&ip_address={DEVICE_IP}&campaign_id={CAMPAIGN_ID}&device_type={DEVICE_TYPE}&publisher_id={APP_ID}&tracker_limit=100000&applovin_click_id={DID}&applovin_event_id={EVENT_ID}&external_tracker_ids=1&android_id_lower_sha1={HADID}" }}'
レスポンス
{ "id": "12345"}
/campaign/update
エンドポイント
既存のキャンペーンを更新するには、このエンドポイントにPOST
リクエストを送信します。
リクエストボディはキャンペーンオブジェクトです。キャンペーンオブジェクトの表のUpdate
列を確認し、リクエストに含めるフィールドを決定します。
このエンドポイントは、このエンドポイントが更新するキャンペーンのキャンペーンID (id
) を含むJSONオブジェクトを返します。
ターゲットURL
https://api.ads.axon.ai/manage/v1/campaign/update?account_id=«account-ID»
例
リクエスト
curl --location 'https://api.ads.axon.ai/manage/v1/campaign/update?account_id=«account-ID»' \--header 'Content-Type: application/json' \--header 'Authorization: «campaign-API-key»' \--data '{ "id": "12345", "name": "test", "status": "LIVE", "type": "APP", "platform": "ANDROID", "budget": { "country_code_to_daily_budget": { "CA": 5000, "US": 1000 } }, "goal": { "goal_value_for_all_countries": 0.98 }, "tracking": { "tracking_method": "ADJUST", "impression_url": "https://view.adjust.com/impression/123abc?campaign={CAMPAIGN_NAME}%20({CAMPAIGN_ID})&adgroup={APP_ID}&creative={AD_NAME}&idfa={IDFA}&country={CC}&gps_adid={IDFA}&adgroup_id={PLACEMENT_ID}&ip_address={DEVICE_IP}&campaign_id={CAMPAIGN_ID}&device_type={DEVICE_TYPE}&publisher_id={APP_ID}&tracker_limit=100000&applovin_click_id={DID}&applovin_event_id={EVENT_ID}&external_tracker_ids=1&android_id_lower_sha1={HADID}", "click_url": "https://app.adjust.com/123abc?campaign={CAMPAIGN_NAME}%20({CAMPAIGN_ID})&adgroup={APP_ID}&creative={AD_NAME}&idfa={IDFA}&country={CC}&gps_adid={IDFA}&adgroup_id={PLACEMENT_ID}&ip_address={DEVICE_IP}&campaign_id={CAMPAIGN_ID}&device_type={DEVICE_TYPE}&publisher_id={APP_ID}&tracker_limit=100000&applovin_click_id={DID}&applovin_event_id={EVENT_ID}&external_tracker_ids=1&android_id_lower_sha1={HADID}" }, "targeting": [ { "country_code": "CA" }, { "country_code": "US" } ], "created_at": "2025-07-18T10:26:32", "package_name": "com.AppLovin.MaxDemoUnity", "end_date": "2025-07-31T05:00:00"}
レスポンス
{ "id": "12345"}
キャンペーンオブジェクト
名前 | タイプ | 説明 | Create | Update |
---|---|---|---|---|
bidding_strategy | String | キャンペーンの入札戦略。有効な値は以下のとおりです。target_goal_with_cpi_billing :目標値に基づき、1件あたりの成果コストを目標水準付近にコントロールします。費用はアプリインストールごとに発生します。<br />auto_bidding_with_cpm_billing :予算を最大限に活用しつつ、可能な限り低い成果コストで結果を最大化することを目指します。費用は広告インプレッションごとに発生します。<br />maximize_results_with_cpm_billing :予算を最大限に活用して結果を最大化し、成果コストが目標値付近の範囲内に収まるよう調整します。費用は広告インプレッションごとに発生します。 | 必須 | 禁止 |
budget | Budget | キャンペーンの予算設定。予算を参照してください。 | 必須 | オプション |
created_at | String | キャンペーンの作成時間。ISO 8601形式(UTC)で表示されます。 | 対象外 | 対象外 |
end_date | String | キャンペーンの終了日。ISO 8601形式(UTC)で設定します。 | 必須 | オプション |
goal | Goal | キャンペーンの目標設定。目標を参照してください。 | 必須 | オプション |
hashed_id | String | キャンペーンの外部ID。Reporting APIのcampaign_id_external 、トラッキングURLマクロ の{CAMPAIGN_ID} 、および Campaign Management APIのcampaign_id と同じ値です。 | 禁止 | 対象外 |
id | Long | キャンペーンーンのID。 | 禁止 | 必須 |
itunes_id | Integer | キャンペーンに関連付けられたiTunes ID。 | 必須(iOSのみ) | オプション |
name | String | キャンペーン名。 | 必須 | オプション |
package_name | String | キャンペーンに関連するパッケージ名。 | 必須 | オプション |
platform | String | キャンペーンのプラットフォーム。 | 必須 | オプション |
start_date | String | キャンペーンの開始日。ISO 8601形式(UTC)で設定します。設定当日より前の日付を指定することはできません。 | 必須 | 禁止 |
status | String | キャンペーンの現在の状態。有効な値:‘LIVE’、‘PAUSED’。 | 対象外 | オプション |
targeting | array<Targeting> | キャンペーンのターゲット国。ターゲティングを参照してください。 | 必須 | オプション |
tracking | トラッキング | キャンペーンのトラッキング設定。トラッキングを参照してください。 | 必須 | オプション |
type | String | キャンペーンのタイプ。有効な値:APP | 必須 | 必須 |
ターゲティングオブジェクト
名前 | タイプ | 説明 |
---|---|---|
country_code | String | ISO 3166-1 alpha-2コードはターゲットの国を表します。たとえば、米国はUS 、フランスはFR 、日本はJP です。完全なリストについては、以下の国コード一覧表を参照してください。 |
region_codes | array<String> | 特定の国のターゲット地域を指定する地域コードの配列。これらはオプションであり、country_code がUS の場合にのみ適用されます。この配列には、有効な米国の州の略語(例:カリフォルニアはCA 、ニューヨークはNY )を含める必要があります。完全なリストについては、以下の地域コード一覧表を参照してください。 |
"targeting": [ { "country_code": "US", "region_codes": [ "CA", "FL" ] }]
予算オブジェクト
グローバル予算または国レベルの予算のいずれかを設定できます。 キャンペーンを作成する際に必要です。
名前 | タイプ | 説明 |
---|---|---|
daily_budget_for_all_countries | decimal | ターゲット国すべてに適用される統一された日次予算を指定します。 |
"budget": { "daily_budget_for_all_countries": "6000"}
名前 | タイプ | 説明 |
---|---|---|
country_code_to_daily_budget | <String、decimal> | 特定の国ごとに個別の目標値を設定します。各キーは国コード(例:US 、FR )で、値はその国の目標です。有効な国コードのリストについては、以下の国コード一覧表を参照してください。 |
"budget": { "country_code_to_daily_budget": { "US": 5000, "FR": 1000 }}
ゴールオブジェクト
目標値
目標値は目標のタイプによって異なります。 CPIはインストール単価、CPEはエンゲージメント当たりのコスト、CPPは購入あたりのコストを表します。AD_ROAS、CHK_ROAS、BLD_ROASはターゲットの日の収益率を表します。
グローバル目標または国レベルの目標のいずれかを設定できます。
名前 | タイプ | 説明 |
---|---|---|
goal_value_for_all_countries | decimal | ターゲット国すべてに適用する統一された目標値を指定します。 |
"goal": { "goal_value_for_all_countries": 0.5, ⋮}
名前 | タイプ | 説明 |
---|---|---|
country_code_to_goal_value | マップ<String、decimal> | 特定の国ごとに個別の目標値を設定します。各キーは国コード(例:US 、FR )で、値はその国の目標です。有効な国コードのリストについては、以下の国コード一覧表を参照してください。 |
"goal": { "country_code_to_goal_value": { "US": 0.9, "FR": 0.2 }, ⋮}
目標タイプ
目標タイプは、キャンペーンの最適化目標を定義します。
インストール単価<br />goal_type
値: CPI
名前 | タイプ | 説明 |
---|---|---|
goal_type | String | キャンペーンの最適化目標を定義。 |
"goal": { ⋮ "goal_type": "CPI"}
カスタムイベントあたりのコスト<br />goal_type
値: CPE
名前 | タイプ | 説明 |
---|---|---|
event_target | String | キャンペーンを最適化するイベントを指定します。 |
goal_type | String | キャンペーンの最適化目標を定義。 |
"goal": { ⋮ "goal_type": "CPE", "event_target": "level_10"}
購入あたりのコスト<br />goal_type
値:CPP
名前 | タイプ | 説明 |
---|---|---|
goal_type | String | キャンペーンの最適化目標を定義。 |
"goal": { ⋮ "goal_type": "CPP",}
広告費用対効果<br />goal_type
値:AD_ROAS
名前 | タイプ | 説明 |
---|---|---|
goal_type | String | キャンペーンの最適化目標を定義。 |
roas_day_target | String | ROASを計算する期間を指定。day0 、day7 、またはday28 のいずれかです。 |
"goal": { ⋮ "goal_type": "AD_ROAS", "roas_day_target": "d0"}
アプリ内購入による広告費用対効果<br />goal_type
値:CHK_ROAS
名前 | タイプ | 説明 |
---|---|---|
goal_type | String | キャンペーンの最適化目標を定義。 |
roas_day_target | String | ROASを計算する期間を指定。day0 、day7 、またはday28 のいずれかです。 |
"goal": { ⋮ "goal_type": "CHK_ROAS", "roas_day_target": "d28"}
総広告費用対効果<br />goal_type
値:BLD_ROAS
名前 | タイプ | 説明 |
---|---|---|
goal_type | String | キャンペーンの最適化目標を定義。 |
roas_day_target | String | ROASを計算する期間を指定。day0 、day7 、またはday28 のいずれかです。 |
"goal": { ⋮ "goal_type": "BLD_ROAS", "roas_day_target": "d7"}
トラッキングオブジェクト
このエンドポイントでキャンペーンを作成するには、このオブジェクトとすべての値が必要です。
名前 | タイプ | 説明 |
---|---|---|
click_url | String | 広告クリックのトラッキングに使用するURL。 |
impression_url | String | 広告インプレッションのトラッキングに使用するURL。 |
tracking_method | String | このキャンペーンに使用するアトリビューショントラッキングプロバイダー。完全なリストについては、以下のトラッキング方法の一覧表を参照してください。 |
"tracking": { "tracking_method": "ADJUST", "impression_url": "https://view.adjust.com/impression/123abc?campaign={CAMPAIGN_NAME}%20({CAMPAIGN_ID})&adgroup={APP_ID}&creative={AD_NAME}&idfa={IDFA}&country={CC}&gps_adid={IDFA}&adgroup_id={PLACEMENT_ID}&ip_address={DEVICE_IP}&campaign_id={CAMPAIGN_ID}&device_type={DEVICE_TYPE}&publisher_id={APP_ID}&tracker_limit=100000&applovin_click_id={DID}&applovin_event_id={EVENT_ID}&external_tracker_ids=1&android_id_lower_sha1={HADID}", "click_url": "https://app.adjust.com/123abc?campaign={CAMPAIGN_NAME}%20({CAMPAIGN_ID})&adgroup={APP_ID}&creative={AD_NAME}&idfa={IDFA}&country={CC}&gps_adid={IDFA}&adgroup_id={PLACEMENT_ID}&ip_address={DEVICE_IP}&campaign_id={CAMPAIGN_ID}&device_type={DEVICE_TYPE}&publisher_id={APP_ID}&tracker_limit=100000&applovin_click_id={DID}&applovin_event_id={EVENT_ID}&external_tracker_ids=1&android_id_lower_sha1={HADID}"}
クリエイティブセット
/creative_set/list
エンドポイント
このエンドポイントにGET
リクエストを送信して、アカウントにある最大100件のクリエイティブセットのリストを取得します。このリストはクリエイティブセットオブジェクトのJSON配列です。
選択されたページにクリエイティブセットがない場合、このエンドポイントは空の配列を返します。
ターゲットURL
https://api.ads.axon.ai/manage/v1/creative_set/list?account_id=«account-ID»
クエリパラメーター
名前 | 説明 | デフォルト |
---|---|---|
ids | コンマで区切られたクリエイティブセットIDのリスト。これを使用して、指定したIDを持つ結果のみをフィルターします。この方法では、最大100個のIDを指定できます。hashed_ids と一緒に含めないでください。 | null |
hashed_ids | コンマで区切られた外部クリエイティブセットIDのリスト。これを使用して、指定したIDを持つ結果のみをフィルターします。この方法では、最大100個のIDを指定できます。ids と一緒に含めないでください。 | null |
page | 取得する結果のページ番号。ページ番号は1から始まります。 | 1 |
size | ページごとに返される結果の数。最大100件です。 | 100 |
例
ページネーションされたリクエスト
curl --location 'https://api.ads.axon.ai/manage/v1/creative_set/list?account_id=«account-ID»&size=50&page=10' \--header 'Authorization: «campaign-API-key»'
フィルターされたリクエスト
curl --location 'https://api.ads.axon.ai/manage/v1/creative_set/list?account_id=«account-ID»&ids=56789' \--header 'Authorization: «campaign-API-key»'
レスポンス
[ { "id": "56789", "campaign_id": "12345", "type": "APP", "name": "test", "assets": [ { "id": "63085821", "name": "playable.html", "status": "ACTIVE", "url": "https://res1.applovin.com/r83948939/playable_raw.html", "type": "HOSTED_HTML", "resource_type": "HTML", }, { "id": "62453682", "name": "test1.mp4", "status": "ACTIVE", "url": "https://res1.applovin.com/r83948939/test1.mp4", "asset_type": "VID_LONG_P", "resource_type": "VIDEO", } ], "languages": [ "ENGLISH" ], "countries": [ "US" ] }]
/creative_set/list_by_campaign_id
エンドポイント
このエンドポイントにGET
リクエストを送信して、アカウントのキャンペーンIDに含まれるクリエイティブセットの情報を取得します。
このエンドポイントは一度に最大100件の結果を返します。
ターゲットURL
https://api.ads.axon.ai/manage/v1/creative_set/list_by_campaign_id?account_id=«account-ID»
クエリパラメーター
名前 | 説明 | デフォルト |
---|---|---|
ids | コンマで区切られたリストのキャンペーンID。これを使用して、指定したキャンペーンID内のクリエイティブセットのみに結果をフィルターできます。この方法では、最大100のIDを指定できます。 | null |
page | 取得する結果のページ番号。ページ番号は1から始まります。 | 1 |
size | ページごとに返される結果の数。最大100件です。 | 100 |
レスポンスボディパラメーター
名前 | 説明 |
---|---|
campaign_count | campaigns オブジェクト内のキャンペーンの数。 |
creative_set_count | 全てのキャンペーンでこのレスポンスが返されたクリエイティブセットの合計数。 |
campaigns | 返されたキャンペーンの情報を含むディクショナリー。キーはキャンペーンIDです。値はクリエイティブセットオブジェクトの配列です。 |
例
ページネーションされたリクエスト
curl --location 'https://api.ads.axon.ai/manage/v1/creative_set/list_by_campaign_id?account_id=«account-ID»&ids=56789,1648980&size=50&page=10' \--header 'Authorization: «campaign-API-key»'
フィルターされたリクエスト
curl --location 'https://api.ads.axon.ai/manage/v1/creative_set/list_by_campaign_id?account_id=«account-ID»&ids=56789' \--header 'Authorization: «campaign-API-key»'
レスポンス
{ "campaign_count": 2, "creative_set_count": 2, "campaigns": { "12345": [ { "id": "56789", "type": "APP", "name": "test", "assets": [ { "id": "63085821", "name": "playable.html", "status": "ACTIVE", "url": "https://res1.applovin.com/r83948939/playable_raw.html", "type": "HOSTED_HTML", "resource_type": "HTML", }, { "id": "62453682", "name": "test1.mp4", "status": "ACTIVE", "url": "https://res1.applovin.com/r83948939/test1.mp4", "asset_type": "VID_LONG_P", "resource_type": "VIDEO", } ], "languages": [ "ENGLISH" ], "countries": [ "US" ], "campaign_id": "56789", "product_page": "", "created_at": "2025-07-18T10:56:05" } ], "1648980": [ { "id": "27227280", "type": "APP", "name": "Test_1", "assets": [ { "id": "63085821", "name": "playable.html", "status": "ACTIVE", "url": "https://res1.applovin.com/r83948939/playable_raw.html", "type": "HOSTED_HTML", "resource_type": "HTML", }, { "id": "62453682", "name": "test1.mp4", "status": "ACTIVE", "url": "https://res1.applovin.com/r83948939/test1.mp4", "asset_type": "VID_LONG_P", "resource_type": "VIDEO", } ], "status": "PAUSED", "languages": [ "CHINESE_TRADITIONAL", "ITALIAN", "INDONESIAN" ], "countries": [], "campaign_id": "1648980", "product_page": "test.com", "created_at": "2025-06-03T23:23:12" } ] }}
/creative_set/create
エンドポイント
新しいクリエイティブセットを作成するには、このエンドポイントにPOST
リクエストを送信します。
リクエストボディはクリエイティブセットオブジェクトです。クリエイティブセットオブジェクト表のCreate
列を確認して、リクエストに含めるフィールドを決定します。
このエンドポイントは、作成するクリエイティブセットのクリエイティブセットID(id
)を含むJSONオブジェクトを返します。
ターゲットURL
https://api.ads.axon.ai/manage/v1/creative_set/create?account_id=«account-ID»
例
リクエスト
curl --location 'https://api.ads.axon.ai/manage/v1/creative_set/create?account_id=«account-ID»' \--header 'Content-Type: application/json' \--header 'Authorization: «campaign-API-key»' \--data '{ "campaign_id": "12345", "type": "APP", "name": "test", "assets": [ { "id": 62453682 } ], "languages": [ "ENGLISH" ], "countries": [ "US" ]}
レスポンス
{ "id": "56789", "version": "V2"}
/creative_set/update
エンドポイント
既存のクリエイティブセットを更新するには、このエンドポイントにPOST
リクエストを送信します。
リクエストボディはクリエイティブセットオブジェクトです。
クリエイティブセットオブジェクト表のUpdate
列を確認して、リクエストに含めるフィールドを決定します。
このエンドポイントは、更新対象のクリエイティブセットのクリエイティブセットID (id
) を含むJSONオブジェクトを返します。
ターゲットURL
https://api.ads.axon.ai/manage/v1/creative_set/update?account_id=«account-ID»
例
リクエスト
curl --location 'https://api.ads.axon.ai/manage/v1/creative_set/update?account_id=«account-ID»' \--header 'Content-Type: application/json' \--header 'Authorization: «campaign-API-key»' \--data '{ "id": "56789", "campaign_id": "12345", "type": "APP", "name": "test", "assets": [ { "id": "63085821" }, { "id": "62453682" } ], "languages": [ "ENGLISH" ], "countries": [ "US" ]}
レスポンス
{ "id": "56789", "version": "V2"}
クリエイティブセットバージョン
Adjustは2つの異なるバージョンのクリエイティブセットをサポートしています。
V1
:各アセットタイプにつき1つのアセットのみをアップロードできます。<br/>V2
:アセットタイプごとに最大10個のアセットをアップロードできます。
新しいクリエイティブセットを作成する場合、既存のクリエイティブセットであるV1
からクローンしない限り、そのバージョンは常にV2
です。
クリエイティブセットオブジェクト
名前 | タイプ | 説明 | Create | Update |
---|---|---|---|---|
assets | array<CreativeSetAsset> | クリエイティブセットに含めるアセット。CreativeSetAsset を参照してください。<br />次のファイルのみを含めることができます:HOSTED_HTML 、VID_LONG_P 、VID_SHORT_P 、IMG_BANNER <br />HOSTED_HTML ファイルを含める必要があります。 | 必須 | オプション |
campaign_id | String | このクリエイティブセットが属するキャンペーンのID。 | 必須 | 必須 |
countries | array<String> | このクリエイティブセットが配信される国のISO 3166-1 alpha-2コードのリスト。例:米国はUS 、フランスはFR 、日本はJP 。デフォルトでは全ての国が対象となります。完全なリストについては、以下の国コード一覧表を参照してください。 | オプション | オプション |
id | String | クリエイティブセットのID。 | 禁止 | 必須 |
hashed_id | String | クリエイティブセットの外部ID。Reporting APIのcreative_set_id 、トラッキングURLマクロ の{CREATIVE_SET_ID} 、および Campaign Management APIのcreative_set_id と同じ値です。 | 禁止 | 対象外 |
languages | array<Language> | 言語のリスト。デフォルトではすべての言語が対象になります。完全なリストについては、以下の言語の一覧表を参照してください。 | オプション | オプション |
name | String | クリエイティブセットの名前。 | 必須 | オプション |
product_page | String | クリエイティブセットに関連付けられたiOSカスタム製品ページまたはAndroidストアリスティング。 | オプション | オプション |
status | String | クリエイティブセットのステータス:LIVE またはPAUSED | 対象外 | オプション |
type | String | キャンペーンのタイプ。サポート対象はAPP のみです。 | 必須 | 必須 |
version | String | クリエイティブセットのバージョン。V1 はタイプごとに1つのアセットのみをサポートする古いクリエイティブセット用で、V2 はタイプごとに複数のアセットをサポートする新しいクリエイティブセット用です。 | 対象外 | 対象外 |
CreativeSetAssetオブジェクト
名前 | タイプ | 説明 | クリエイティブセットを作成 |
---|---|---|---|
id | String | アセットのID。このIDは、クリエイティブセットを作成または更新するときに使用します。 | 必須 |
name | String | アセット名。 | 対象外 |
status | String | アセットのステータス。指定可能な値はIN_REVIEW 、REJECTED 、ACTIVE 、PAUSED 、UNKNOWN です。 | 対象外 |
type | String | クリエイティブアセットのタイプ。指定可能な値は、VID_LONG_P 、VID_SHORT_P 、HOSTED_HTML 、IMG_BANNER です。 | 対象外 |
url | String | アセットのURL。例:https://res1.applovin.com/r83948939/test1.mp4 | 対象外 |
/creative_set/clone
エンドポイント
このエンドポイントにPOST
リクエストを送信して、別のキャンペーンで既存のクリエイティブセットのクローンを作成します。
このエンドポイントは、作成されたクリエイティブセットのクローンのクリエイティブセットID(id
)を含むJSONオブジェクトを返します。
ターゲットURL
https://api.ads.axon.ai/manage/v1/creative_set/clone?account_id=«account-ID»
リクエストボディパラメーター
名前 | タイプ | 説明 |
---|---|---|
campaign_id | Integer | クリエイティブセットをクローンしたいキャンペーンのID。 |
creative_set_id | Integer | クローン作成するクリエイティブセットのID。 |
status | String | クローン作成されたクリエイティブセットのステータス:LIVE またはPAUSED 。 |
例
リクエスト
curl --location 'https://api.ads.axon.ai/manage/v1/creative_set/clone?account_id=«account-ID»' \--header 'Content-Type: application/json' \--header 'Authorization: «campaign-API-key»' \--data '{ "campaign_id": "12345", "creative_set_id": "39823", "status":"live"}
レスポンス
{ "id": "56795", "version": "V1"}
アセット
/asset/list
エンドポイント
このエンドポイントにGET
リクエストを送信して、アカウントにある最大100件のキャンペーンのリストを取得します。
このリストは資産オブジェクトのJSON配列です。
選択したページにキャンペーンがない場合、このエンドポイントは空の配列を返します。
ターゲットURL
https://api.ads.axon.ai/manage/v1/asset/list?account_id=«account-ID»
クエリパラメーター
名前 | 説明 | デフォルト |
---|---|---|
ids | コンマで区切られたリストのアセットID。これを使用して、指定したIDを持つ結果のみをフィルターします。この方法では、最大100個のIDを指定できます。 | null |
page | 取得する結果のページ番号。ページ番号は1から始まります。 | 1 |
resource_type | アセットリソースタイプの種類。これを使用して、該当のリソースタイプで結果をフィルターします。指定可能な値は image 、html 、video です。 | null |
size | ページごとに返される結果の数。最大100件です。 | 100 |
アセットオブジェクト
名前 | タイプ | 説明 |
---|---|---|
asset_type | String | クリエイティブアセットのタイプ。指定可能な値はVID_LONG_P 、VID_SHORT_P 、HOSTED_HTML 、またはIMG_BANNER です。 |
id | String | アセットのID。クリエイティブセットを作成または更新する際にこれを使用します。 |
name | String | アセット名。 |
resource_type | String | アセットのリソースタイプ。指定可能な値はIMAGE 、VIDEO 、またはHTML です。 |
status | String | アセットのステータス。指定可能な値はIN_REVIEW 、REJECTED 、ACTIVE 、またはPAUSED です。 |
upload_time | String | アセットのアップロード時間。例:2025-04-27T23:34:06 |
url | String | アップロードされたアセットのURL。例:https://res1.applovin.com/r83948939/test1.mp4 |
例
ページネーションされたリクエスト
curl --location 'https://api.ads.axon.ai/manage/v1/asset/list?account_id=«account-ID»&size=50&page=10' \--header 'Authorization: «campaign-API-key»'
フィルターされたリクエスト
curl --location 'https://api.ads.axon.ai/manage/v1/asset/list?account_id=«account-ID»&ids=12345' \--header 'Authorization: «campaign-API-key»'
レスポンス
[ { "id": "65061535", "name": "playable.html", "status": "ACTIVE", "url": "https://res1.applovin.com/r83948939/playable_raw.html", "asset_type": "HOSTED_HTML", "resource_type": "HTML", "upload_time": "2025-07-04T07:25:30" }, { "id": "65061052", "name": "test1.mp4", "status": "ACTIVE", "url": "https://res1.applovin.com/r83948939/test1.mp4", "asset_type": "VID_LONG_P", "resource_type": "VIDEO", "upload_time": "2025-07-04T07:24:57" }]
/asset/upload
エンドポイント
このエンドポイントにPOST
リクエストを送信して、新しいアセットファイルをアップロードします。
一度に最大40個のファイルをアップロードできます。
合計サイズは10GBを超えてはならず、1つのファイルのサイズは1GBを超えてはなりません。
アップロード後、AppLovinはファイルの処理、最適化、レビューを行います。
このエンドポイントは、upload_id
を含むJSONオブジェクトを返します。
このIDを使用して、アップロードされたアセットのステータスをクエリで確認できます。
以下の/asset/upload_result
エンドポイントをご覧ください。
ターゲットURL
https://api.ads.axon.ai/manage/v1/asset/upload?account_id=«account-ID»
リクエストフォームのフィールド
名前 | タイプ | 説明 |
---|---|---|
files | array<File> | バッチ内の各ファイル名は一意でなければなりません。また、各ファイルにはContent-Typeが設定されている必要があります。サポートされているContent-Typeは、text/html 、image/gif 、image/jpeg 、image/png 、video/mp4 、およびvideo/quicktime です。 |
例
リクエスト
curl --location 'https://api.ads.axon.ai/manage/v1/asset/upload?account_id=«account-ID»' \--header 'Authorization: «campaign-API-key»' \--form 'files=@"/path/to/playable.html"' \--form 'files=@"/path/to/video.mp4"'
レスポンス
{ "upload_id": "c7a3db4226b24bd8bb0b38c46654aa54"}
/asset/upload_result
エンドポイント
このエンドポイントにGET
リクエストを送信して、アップロードリクエストのステータスを確認します。
このエンドポイントは、指定されたupload_id
に関する情報を含むJSONオブジェクトを返します。
ターゲットURL
https://api.ads.axon.ai/manage/v1/asset/upload_result?account_id=«account-ID»&upload_id=«upload-ID»
リクエストクエリパラメーター
名前 | タイプ | 説明 |
---|---|---|
upload_id | String | /asset/upload エンドポイントによって返されるupload_id 。 |
レスポンスボディパラメーター
名前 | タイプ | 説明 |
---|---|---|
details | array<AssetUploadDetail> | アップロードされた各ファイルの詳細。AssetUploadDetailを参照してください。 |
summary | AssetUploadSummary | アップロードされたファイルのステータスの概要。AssetUploadSummaryを参照してください。 |
upload_status | String | アップロードアセットリクエストの全体的なステータス:処理中のファイルがある場合はPENDING 、それ以外の場合はFINISHED 。 |
AssetUploadSummaryオブジェクト
名前 | タイプ | 説明 |
---|---|---|
failed | Integer | 失敗したアセット数。 |
pending | Integer | 保留中のアセット数。 |
success | Integer | 正常に処理されたアセット数。 |
total | Integer | アップロードリクエスト内のすべてのアセットの数。 |
AssetUploadDetailオブジェクト
名前 | タイプ | 説明 |
---|---|---|
error_message | String | アップロードが失敗した場合、その理由が含まれます。 |
file_status | String | アセットのアップロードステータス。指定可能な値はPENDING 、FAILURE 、またはSUCCESS です。 |
id | String | アセットのID。 |
name | String | アセット名。 |
resource_type | String | アセットのリソースタイプ。指定可能な値はIMAGE 、VIDEO 、またはHTML です。 |
uploadTime | String | アセットのアップロード時間。例:2025-04-27T23:34:06 |
url | String | アップロードされたアセットのURL。例:https://res1.applovin.com/r83948939/test1.mp4 |
例
リクエスト
curl --location 'https://api.ads.axon.ai/manage/v1/asset/upload_result?account_id=«account-ID»&upload_id=«upload-ID»' \--header 'Authorization: «campaign-API-key»' \
レスポンス
{ "summary": { "total": 2, "success": 2, "failed": 0, "pending": 0 }, "details": [ { "id": "66218554", "name": "playable.html", "uploadTime": "2025-07-19T08:24:29", "url": "https://res1.applovin.com/r0186867/b30361c076022e02ea3cc1b80a6855f5491a6d70_raw.raw", "resource_type": "HTML", "file_status": "SUCCESS" }, { "id": "65061052", "name": "test1.mp4", "uploadTime": "2025-07-19T08:24:29", "url": "https://res1.applovin.com/r83948939/test1.mp4", "resource_type": "VIDEO", "file_status": "SUCCESS", } ], "upload_status": "FINISHED"}
トラッキング方法の一覧表
API名 | MMP名 |
---|---|
adjust | Adjust |
appsflyer | AppsFlyer |
apsalar | Singular |
branch | Branch |
kochava | Kochava |
tenjin | Tenjin |
言語一覧表
<li>ALBANIAN
</li><li>ARABIC
</li><li>BASQUE
</li><li>BENGALI
</li><li>BOSNIAN
</li><li>BULGARIAN
</li><li>CATALAN
</li><li>CHINESE_SIMPLIFIED
</li><li>CHINESE_TRADITIONAL
</li><li>CROATIAN
</li><li>CZECH
</li><li>DANISH
</li><li>DUTCH
</li><li>ENGLISH
</li><li>ESTONIAN
</li><li>FARSI
</li><li>FINNISH
</li><li>FRENCH
</li><li>GEORGIAN
</li><li>GERMAN
</li><li>GREEK
</li><li>HEBREW
</li><li>HINDI
</li><li>HUNGARIAN
</li><li>ICELANDIC
</li><li>INDONESIAN
</li><li>ITALIAN
</li><li>JAPANESE
</li><li>JAVANESE
</li><li>KOREAN
</li><li>LATVIAN
</li><li>LITHUANIAN
</li><li>MACEDONIAN
</li><li>MALAY
</li><li>MARATHI
</li><li>NORWEGIAN
</li><li>POLISH
</li><li>PORTUGESE
</li><li>ROMANIAN
</li><li>RUSSIAN
</li><li>SERBIAN
</li><li>SLOVAK
</li><li>SLOVENIAN
</li><li>SPANISH
</li><li>SUNDANESE
</li><li>SWEDISH
</li><li>THAI
</li><li>TURKISH
</li><li>UIGHUR
</li><li>UKRAINIAN
</li><li>URDU
</li><li>VIETNAMESE
</li>
国コード一覧表
AD
AE
AF
AG
AI
AL
AM
AO
AR
AS
AT
AU
AW
AX
AZ
BA
BB
BD
BE
BF
BG
BH
BI
BJ
BL
BM
BN
BO
BQ
BR
BS
BT
BW
BY
BZ
CA
CD
CF
CG
CH
CI
CK
CL
CM
CN
CO
CR
CV
CW
CY
CZ
DE
DJ
DK
DM
DO
DZ
EC
EE
EG
EH
ER
ES
ET
FI
FJ
FK
FM
FO
FR
GA
GB
GD
GE
GF
GG
GH
GI
GL
GM
GN
GP
GQ
GR
GT
GU
GW
GY
HK
HN
HR
HT
HU
ID
IE
IL
IM
IN
IQ
IS
IT
JE
JM
JO
JP
KE
KG
KH
KI
KM
KN
KR
KW
KY
KZ
LA
LB
LC
LI
LK
LR
LS
LT
LU
LV
LY
MA
MC
MD
ME
MF
MG
MH
MK
ML
MM
MN
MO
MP
MQ
MR
MS
MT
MU
MV
MW
MX
MY
MZ
NA
NC
NE
NF
NG
NI
NL
NO
NP
NQ
NR
NU
NZ
OM
PA
PE
PF
PG
PH
PK
PL
PM
PN
PR
PS
PT
PW
PY
QA
RE
RO
RS
RU
RW
SA
SB
SC
SD
SE
SG
SH
SI
SJ
SK
SL
SM
SN
SO
SR
SS
ST
SV
SX
SZ
TC
TD
TG
TH
TJ
TK
TL
TM
TN
TO
TR
TT
TV
TW
TZ
UA
UG
US
UY
UZ
VA
VC
VE
VG
VI
VN
VU
WF
WS
XK
YE
YT
ZA
ZM
ZW
地域コード一覧表
AK
(アラスカ)AL
(アラバマ)AR
(アーカンソー)AZ
(アリゾナ)CA
(カリフォルニア)CO
(コロラド)CT
(コネチカット)DC
(コロンビア特別区)DE
(デラウェア)FL
(フロリダ)GA
(ジョージア)HI
(ハワイ)IA
(アイオワ)ID
(アイダホ)IL
(イリノイ)IN
(インディアナ)KS
(カンザス)KY
(ケンタッキー)LA
(ルイジアナ)MA
(マサチューセッツ)MD
(メリーランド)ME
(メイン)MI
(ミシガン)MN
(ミネソタ)MO
(ミズーリ)MS
(ミシシッピ)MT
(モンタナ)ND
(ノースダコタ)NE
(ネブラスカ)NH
(ニューハンプシャー)NJ
(ニュージャージー)NM
(ニューメキシコ)NV
(ネバダ)NY
(ニューヨーク)OH
(オハイオ)OK
(オクラホマ)OR
(オレゴン)PA
(ペンシルベニア)PR
(プエルトリコ)RI
(ロードアイランド)SC
(サウスカロライナ)SD
(サウスダコタ)TN
(テネシー)TX
(テキサス)UT
(ユタ)VA
(バージニア)VT
(バーモント)WA
(ワシントン)WI
(ウィスコンシン)WV
(ウェストバージニア)WY
(ワイオミング)
NC
(ノースカロライナ)