Axon Campaign Management API
Axon Campaign Management API 适用于使用 AppLovin 的 AppDiscovery 来推广其应用的广告主。
您可以通过向 Axon Campaign Management API 发送请求来创建和更新 Campaign 和广告素材组,并上传新资源。
Campaign
/campaign/list
终端
向此终端发送 GET
请求,以检索您账户中最多 100 个 Campaign 的列表。
此列表是 Campaign 对象的 JSON 数组。
如果选定页面上没有 Campaign,此终端将返回一个空数组。
目标 URL
https://api.ads.axon.ai/manage/v1/campaign/list?account_id=«account-ID»
查询参数
名称 | 描述 | 默认 |
---|---|---|
ids | 用逗号分隔的 Campaign ID 列表。使用此列表将结果筛选为仅具有指定 ID 的结果。通过这种方式,您最多可以指定 100 个 ID。不要将此与 hashed_ids 一起使用。 | null |
hashed_ids | 用逗号分隔的 Campaign 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
请求以创建新的 Campaign。请求体是 Campaign 对象。
查看 Campaign 对象表的 创建
列,以确定应在请求中包含哪些字段。
此终端返回一个 JSON 对象,其中包含此终端创建的 Campaign 的 Campaign ID (id
)。
目标 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
请求以更新现有的 Campaign。
请求体是 Campaign 对象。查看 Campaign 对象表的 更新
列,以确定应在请求中包含哪些字段。
此终端返回一个 JSON 对象,其中包含此终端更新的 Campaign 的 Campaign ID (id
)。
目标 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"}
Campaign 对象
名称 | 类型 | 描述 | 创建 | 更新 |
---|---|---|---|---|
bidding_strategy | String | Bidding strategy for the campaign. Valid values include: target_goal_with_cpi_billing : We will aim to control the cost per result around your target goal. You will be charged on each app install.<br />auto_bidding_with_cpm_billing : We will aim to fully utilize your budget while maximizing results at the lowest possible cost per result. You will be charged on every ad impression.<br />maximize_results_with_cpm_billing : We will aim to fully utilize your budget while maximizing results, ensuring the cost per result stays within a certain range around your target goal. You will be charged on every ad impression. | 必要 | 禁止 |
budget | Budget | Campaign 的预算设置。查看预算。 | 必要 | 可选 |
created_at | String | Campaign 的创建时间,采用 ISO 8601 格式 (UTC)。 | 已忽略 | 已忽略 |
end_date | String | Campaign 的结束日期,采用 ISO 8601 格式 (UTC)。 | 必要 | 可选 |
goal | Goal | Campaign 的目标设置。请参阅目标。 | 必要 | 可选 |
hashed_id . | String | The external ID of the campaign. It is the same value as the campaign_id_external in the Reporting API, the {CAMPAIGN_ID} Tracking URL Macro and the campaign_id in the Campaign Management API. | 禁止 | 已忽略 |
id | Long | Campaign ID。 | 禁止 | 必要 |
itunes_id | Integer | 与 Campaign 关联的 iTunes ID。 | 必需 (仅限 iOS) | 可选 |
name | String | Campaign 名称。 | 必要 | 可选 |
package_name | String | 与 Campaign 相关的包名。 | 必要 | 可选 |
platform | String | Campaign 的平台。 | 必要 | 可选 |
start_date | String | Campaign 的开始日期,采用 ISO 8601 格式 (UTC)。不能早于今天的日期。 | 必要 | 禁止 |
status | String | Campaign 的当前状态。有效值:LIVE 、PAUSED 。 | 已忽略 | 可选 |
targeting | array<Targeting> | Campaign 的国家/地区投放目标。请参阅定向。 | 必要 | 可选 |
tracking | Tracking | Campaign 的跟踪设置。请参阅跟踪。 | 必要 | 可选 |
type | String | Campaign 类型。有效值: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" ] }]
预算对象
您可以设置全球预算或国家级预算。 创建 Campaign 时必须设置此项。
名称 | 类型 | 描述 |
---|---|---|
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 | Map<String, decimal> | 为特定国家设置单独的目标值,其中每个键是一个国家代码 (例如 US 、FR ),而目标值是该国家的目标。请参阅下方国家代码表以获取完整的有效国家代码列表。 |
"goal": { "country_code_to_goal_value": { "US": 0.9, "FR": 0.2 }, ⋮}
目标类型
目标类型定义了 Campaign 的优化目标。
单次安装成本。<br/>goal_type
值:CPI
名称 | 类型 | 描述 |
---|---|---|
goal_type | String | 定义 Campaign 的优化目标。 |
"goal": { ⋮ "goal_type": "CPI"}
每自定义事件成本。<br/>goal_type
值:CPE
名称 | 类型 | 描述 |
---|---|---|
event_target | String | 指定 Campaign 针对哪些事件进行优化。 |
goal_type | String | 定义 Campaign 的优化目标。 |
"goal": { ⋮ "goal_type": "CPE", "event_target": "level_10"}
每购买者成本。<br/>goal_type
值:CPP
名称 | 类型 | 描述 |
---|---|---|
goal_type | String | 定义 Campaign 的优化目标。 |
"goal": { ⋮ "goal_type": "CPP",}
广告相关广告支出回报率。<br/>goal_type
值:AD_ROAS
名称 | 类型 | 描述 |
---|---|---|
goal_type | String | 定义 Campaign 的优化目标。 |
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 | 定义 Campaign 的优化目标。 |
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 | 定义 Campaign 的优化目标。 |
roas_day_target | String | 指定用于计算 ROAS 的时间窗口。以下之一:day0 、day7 、day28 |
"goal": { ⋮ "goal_type": "BLD_ROAS", "roas_day_target": "d7"}
跟踪对象
创建 Campaign 时,此终端需要此对象及其全部值。
名称 | 类型 | 描述 |
---|---|---|
click_url | String | 用于跟踪广告点击的 URL。 |
impression_url | String | 用于跟踪广告展示的 URL。 |
tracking_method | String | 用于此 Campaign 的归因跟踪供应商。请参阅下方的跟踪方法表以获取完整列表。 |
"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
请求来调取您账户中一组 Campaign ID 中包含的素材集信息。该终端一次最多返回 100 个结果。
目标 URL
https://api.ads.axon.ai/manage/v1/creative_set/list_by_campaign_id?account_id=«account-ID»
查询参数
名称 | 描述 | 默认 |
---|---|---|
ids | 通过逗号分隔的 Campaign ID 列表。使用此过滤器来过滤结果,仅显示指定 Campaign ID 中的素材集。您最多可以指定 100 个 ID。 | null |
page | 要检索的结果页码。第一页是第 1 页。 | 1 |
size | 每页要返回的结果数量。最大数量为 100。 | 100 |
响应体参数
名称 | 描述 |
---|---|
campaign_count | campaigns 对象中的 Campaign 数量。 |
creative_set_count | 此响应中返回的全部 Campaign 的素材集总数。 |
campaigns | 包含返回 Campaign 相关信息的字典。键即 Campaign 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
请求以创建新的素材组。
请求体是素材组对象。
查看素材组对象表的 创建
列,以确定应在请求中包含哪些字段。
此终端返回一个 JSON 对象,其中包含此终端创建的素材组的素材组 ID (id
)。
目标 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
请求以更新现有的素材组。
请求体是素材组对象。
查看素材组对象表的 更新
列,以确定应在请求中包含哪些字段。
此终端返回一个 JSON 对象,其中包含此终端更新的素材组的素材组 ID (id
)。
目标 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"}
Creative Set Versions
We support two different creative set versions:
V1
: You may upload only a single asset of each asset type.<br />V2
: You may upload up to 10 assets for each asset type.
When you create a new creative set, its version is always V2
unless you clone it from a previously-existing creative set that is V1
.
素材组对象
名称 | 类型 | 描述 | 创建 | 更新 |
---|---|---|---|---|
assets | array<CreativeSetAsset> | Assets to include in the creative set. Please refer to CreativeSetAsset. <br /> May only contain the following: HOSTED_HTML , VID_LONG_P , VID_SHORT_P , IMG_BANNER <br />Must contain a HOSTED_HTML file. | 必要 | 可选 |
campaign_id | String | 此素材组所属的 Campaign 的 ID。 | 必要 | 必要 |
countries | array<String> | 投放该素材集的 ISO 3166-1 alpha-2 代码列表。例如,US 代表美国,FR 代表法国,JP 代表日本。默认全部国家/地区。请参阅下方国家代码表以获取完整列表。 | 可选 | 可选 |
id | String | 素材组 ID。 | 禁止 | 必要 |
hashed_id | String | The external ID of the creative set. It is the same value as the creative_set_id in the Reporting API, the {CREATIVE_SET_ID} Tracking URL Macro and the creative_set_id in the Campaign Management API. | 禁止 | 已忽略 |
languages | array<Language> | 语言列表。默认为全部语言。请参阅下面的语言表以获取完整列表。 | 可选 | 可选 |
name | String | 素材组的名称。 | 必要 | 可选 |
product_page | String | 与素材组关联的 iOS 自定义产品页或 Android 商品详情。 | 可选 | 可选 |
status | String | 素材组的状态:LIVE 或 PAUSED | 已忽略 | 可选 |
type | String | Campaign 类型。仅支持 APP 。 | 必要 | 必要 |
version | String | The creative set version. V1 for older creative sets that only support a single asset per type, V2 for new creative set that support multiple assets per type. | 已忽略 | 已忽略 |
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
请求,以将现有素材组克隆到其他 Campaign。
此终端返回一个 JSON 对象,其中包含生成的克隆素材组的素材组 ID (id
)。
目标 URL
https://api.ads.axon.ai/manage/v1/creative_set/clone?account_id=«account-ID»
请求体参数
名称 | 类型 | 描述 |
---|---|---|
campaign_id | Integer | 您要将素材组克隆到的 Campaign 的 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 个 Campaign 的列表。
此列表是资源对象的 JSON 数组。
如果选定页面上没有 Campaign,此终端将返回一个空数组。
目标 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,单个文件大小不得超过 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
请求以检查上传请求的状态。
此终端返回一个 JSON 对象,其中包含有关指定 upload_id
的信息。
目标 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
(蒙大拿州)NC
(北卡罗莱纳州)ND
(北达科他州)NE
(内布拉斯加州)NH
(新罕布什尔州)NJ
(新泽西州)NM
(新墨西哥州)NV
(内华达州)NY
(纽约州)OH
(俄亥俄州)OK
(俄克拉荷马州)OR
(俄勒冈州)PA
(宾夕法尼亚州)PR
(波多黎各)RI
(罗德岛州)SC
(南卡罗莱纳州)SD
(南达科他州)TN
(田纳西州)TX
(得克萨斯州)UT
(犹他州)VA
(弗吉尼亚州)VT
(佛蒙特州)WA
(华盛顿州)WI
(威斯康星州)WV
(西弗吉尼亚州)WY
(怀俄明州)