Ad Unit Management API
您可以向 Ad Unit Management API 发送请求,来查看和管理 MAX 广告单元。
该 API 有 5 个终端:
/ad_unit
终端:- 向
/ad_unit/«ad-unit-ID»
发送GET
请求,以查看特定广告单元的详细信息。 - 向
/ad_unit/
发送POST
请求,以创建新的广告单元。 - 向
/ad_unit/«ad-unit-ID»
发送POST
请求,以管理广告单元的广告平台配置。 - 向
/ad_unit/«ad-unit-ID»/«segment-ID»
发送GET
请求,以获取广告单元的用户分群瀑布流。 - 向
/ad_unit/«ad-unit-ID»/«segment-ID»
发送POST
请求,以创建、编辑、弃用、采纳或移除广告单元的用户分群瀑布流。
- 向
/ad_units
终端- 向
/ad_units
发送GET
请求,以查看所有广告单元的详细信息。
- 向
/ad_unit_experiment
终端- 向
/ad_unit_experiment/«ad-unit-ID»
发送GET
请求,以查看广告单元实验的详细信息。 - 如果该广告单元当前没有正在运行的实验,向
/ad_unit_experiment/«ad-unit-ID»
发送POST
请求,以创建新的广告单元实验。 - 向
/ad_unit_experiment/«ad-unit-ID»
发送POST
请求,以采纳或弃用广告单元实验。 - 向
/ad_unit_experiment/«ad-unit-ID»/«segment_id»
发送GET
请求,以获取广告单元实验的用户分群瀑布流。 - 向
/ad_unit_experiment/«ad-unit-ID»/«segment_id»
发送POST
请求,以创建、编辑、弃用、采纳或移除广告单元实验的用户分群瀑布流。
- 向
/test_device
终端- 向
/test_device
发送POST
请求,以创建新的测试设备。 - 向
/test_device/«test-device-ID»
发送GET
请求,以查看特定测试设备的详细信息。 - 向
/test_device/«test-device-ID»
发送POST
请求,以管理测试设备的配置。
- 向
/test_devices
终端- 向
/test_devices
发送GET
请求,以查看所有测试设备的详细信息。
- 向
下方版块将更详细地阐释这些终端。
/ad_unit
终端
要创建广告单元,请向此终端发送 POST
请求。请在请求体中添加下方所述的必填字段。每个请求只能创建一个广告单元。
目标 URL
https://o.applovin.com/mediation/v1/ad_unit
POST
请求体
{ "name": "My Inter Ad Unit", "platform": "ios", "package_name": "com.test.app", "ad_format": "INTER"}
响应体
{ "id": "1234567890abcdef", "name": "My Inter Ad Unit", "platform": "ios", "package_name": "com.test.app", "ad_format": "INTER", "has_active_experiment": false, "disabled": false}
请求/响应体字段对照表
名称 | 描述 | 示例 | 创建时必需 (POST ) |
---|---|---|---|
ad_format | 广告单元的格式。 | INTER , BANNER , REWARD | true |
disabled | 该广告单元是否已禁用 (只读)。 | false | false |
has_active_experiment | 该广告单元是否有正在进行的实验 (只读)。 | false | false |
id | 广告单元 ID。在创建广告单元时,请不要包含此信息。该信息会在创建请求的响应中返回。 | 1234567890abcdef | false |
名称 | 广告单元的名称。 | "Mr. Bullet Rewarded" | true |
package_name | 与该广告单元关联的应用的包名 / Bundle ID。 | com.my.test.app | true |
platform | 广告单元的平台。 | ios , android | true |
template_size | 原生广告模板。仅限原生广告单元。 | small_template_1 , medium_template_1 , custom_template_1 | true |
/ad_unit/«ad-unit-ID»
终端
使用此终端查看 (GET
) 或编辑 (POST
) 广告单元配置。(要创建、更新、采纳或禁用广告单元实验,请参阅下文所述的 /ad_unit_experiment/
终端。MAX 会使用您在此处设置的 CPM 值来定义瀑布流。但是,如果您为账户和特定广告平台配置为启用 Auto CPM,那么此处设置的值就是默认 CPM 值。Auto CPM 接收到新值后,该默认 CPM 值就不再适用。
要更详细地查看广告单元,请添加查询参数 fields
。将该参数的值设置为以逗号分隔的值列表,列出您要查看的所有其他字段的名称。可能的 fields
包括:ad_network_settings
(仅限激活状态),disabled_ad_network_settings
(仅限禁用状态),frequency_capping_settings
,bid_floors
,segments
,banner_refresh_settings
和 mrec_refresh_settings
。请参阅下文说明,了解与这些 fields
值对应的对象。
目标 URL
https://o.applovin.com/mediation/v1/ad_unit/«ad-unit-ID»?fields=ad_network_settings,disabled_ad_network_settings,frequency_capping_settings,bid_floors,banner_refresh_settings,segments
示例
GET
响应体
{ "id": "1234567890abcdef", "name": "My Inter Ad Unit", "platform": "ios", "package_name": "com.test.app", "ad_format": "INTER", "has_active_experiment": false, "disabled": false, "ad_network_settings": [ { "FACEBOOK_NETWORK": { "disabled": false, "ad_network_ad_units": [ { "ad_network_ad_unit_id": "8247030622430922_5618972399256249", "disabled": false } ] } }, { "ADMOB_NETWORK": { "disabled": false, "ad_network_app_id": "ca-app-pub-3555987499620362~3024971981", "ad_network_ad_units": [ { "ad_network_ad_unit_id": "ca-app-pub-3555987499620362/4382996128", "disabled": false, "cpm": "30.00", "countries": { "type": "INCLUDE", "values": [ "us", "ca", "gb", "au" ] } }, { "ad_network_ad_unit_id": "ca-app-pub-3555987499620362/5476585941", "disabled": false, "cpm": "20.00", "countries": { "type": "EXCLUDE", "values": [ "us", "ca", "gb", "au" ] } } ] } } ], "frequency_capping_settings": [ { "type": "time", "time_capping_settings": { "day_limit": 10, "minute_frequency": 10 }, "session_capping_settings": { "session_limit": 0 }, "countries" : { "type": "INCLUDE", "values" : [ "ca", "us" ] } } ], "bid_floors": [ { "country_group_name": "t1 eng", "cpm": "10.00", "countries": { "type": "INCLUDE", "values": [ "au", "ca", "gb", "nz", "us" ] } }, { "country_group_name": "eea", "cpm": "5.00", "countries": { "type": "INCLUDE", "values": [ "at", "pt", "ro", "se", "si", "sk" ] } } ], "banner_refresh_settings":{ "interval": 0 }, "segments":[ { "id": 347324, "name": "LAT iPads", "id_type": "no_id", "device_type": "tablets", "segment_keys": [ [ "+1:2" ] ] } ]}
POST
请求体
{ "id":"«ad-unit-ID»", "name":"«ad-unit-name»", "platform":"«ad-unit-platform»", "ad_format":"«ad-unit-format»", "package_name":"«ad-unit-package-name»", "ad_network_settings": [ { "ADMOB_NETWORK": { "disabled": true, "ad_network_app_id": "ca-app-pub-3555987499620362~3024971981", "ad_network_ad_units": [] } } ], "frequency_capping_settings": [ { "type": "time", "time_capping_settings": { "day_limit": 10, "minute_frequency": 10 }, "session_capping_settings": { "session_limit": 0 }, "countries" : { "type": "INCLUDE", "values" : [ "ca", "us" ] } } ]}
响应
响应中返回所有广告单元的详细信息。
ad_network_settings
数组
每个已配置的广告平台ad_network_settings
数组都包含 1 个广告平台对象。每个广告平台对象的键是该平台 API 名称 (例如 FACEBOOK_NETWORK
)。每个广告平台都有特定的必要字段。请参阅下方的广告平台对象对照表及其之后的表格,了解这些字段的含义。要了解如何设置平台 API 名称对象键和部分字段,请参阅广告平台表格。
广告平台对象
名称 | 描述 | 示例 |
---|---|---|
ad_network_ad_units | 对象列表,描述特定广告平台的广告单元。部分广告平台必须填写该值。 | 请参阅 ad_network_ad_units 对象。 |
ad_network_app_id | 平台 App ID。部分广告平台不提供该值,部分广告平台则必须填写该值。请参阅广告平台表格。 | ca-app-pub-3555987499620362~3024971981 |
ad_network_app_key | 平台 App Key。部分广告平台不提供该值,部分广告平台则必须填写该值。请参阅广告平台表格。 | 123456789 |
bid_floors | 描述该广告单元 CPM 底价的对象。请参阅 bid_floors 对象。 | 可选。 |
disabled | 指示该广告单元中的广告平台启用还是禁用。可选。 | false |
frequency_cap_settings | 已弃用。 | |
frequency_capping_settings | 对象列表,描述如何设置该广告单元的频率上限。可选。 | 请参阅 frequency_capping_settings 对象。 |
ad_network_ad_units
对象
您对特定广告平台所做的变更不会影响其他广告平台的配置。如果您只更新其中的一个广告平台,那么就无需发送包含所有广告平台的请求。如需更改特定广告平台配置的一部分,请务必添加 MAX 广告单元中与该广告平台关联的所有信息。要向现有广告平台添加新的广告分层,请在请求中包含该广告平台的所有其他广告分层。如果您将某个广告平台的所有广告分层都标记为 disabled
,该广告平台就会被禁用。
名称 | 描述 | 示例 |
---|---|---|
ad_network_ad_unit_id (必要) | 广告平台广告单元的 ID。部分平台没有该值,可能会返回 “N/A ”。请参阅下方广告平台表格。 | ca-app-pub-3555987499620362/4382996128 |
cpm (必要,竞价广告平台除外) | 每次展示该广告单元的广告时支付的 CPM。 | 20.00 |
countries (必要) | 该对象会描述此特定广告平台的广告单元在任何国家/地区的白名单/黑名单。 | 请参阅 countries 对象。 |
disabled (可选) | 指示广告平台的广告单元是否激活。 | false |
countries
对象
该对象说明指定 ad_network_ad_unit
中包含或排除的国家/地区。
名称 | 描述 | 示例 | 必要 |
---|---|---|---|
type | 指示是否应将这些国家/地区列入白名单或黑名单。 | INCLUDE , EXCLUDE | true |
values | 由两个字母组成的 ISO 国家代码列表。如果列表为空,则表示所有国家/地区,与类型 INCLUDE 或 EXCLUDE 无关。 | ["us", "ca", "jp"] | true |
frequency_capping_settings
对象
频率上限分为两种,一种基于会话,另一种基于时间。基于会话的频率上限,是指每位用户最多能在一个会话中看到多少个广告。基于时间的频率上限,则指用户在指定时间范围内 (以分钟计) 能看到的广告数量。
名称 | 描述 | 示例 |
---|---|---|
countries (必要) | 适用该上限的国家/地区。请参阅 countries 对象,了解各字段的说明。频率上限当前仅支持 type=INCLUDE 。frequency_capping_objects 中的国家不可重叠。 | { "type": "INCLUDE", "values": ["at", "pt", "ro", "se", "si", "sk"] } |
session_capping_settings (type==session 时必要) | 该对象描述用户在每次会话 (session_limit ) 中能看到的最大广告数量。如果 type =time ,则设置为 session_limit=0 。 | {"session_limit": 10} |
time_capping_settings (type =time 时必要) | 该对象描述每天广告数量 (day_limit ) ,以及广告间隔时间 (minute_frequency )。如果 type =session ,则将 day_limit 和 minute_frequency 设为 0 。 | {"day_limit": 10, "minute_frequency": 10} |
type (必要) | 要使用的频率上限类型。 | time , session |
bid_floors
对象
该对象定义您要与特定国家/地区相关联的任何 CPM 底价。未定义底价的国家/地区将没有竞价下限。如果您的更新请求包含 bid_floors
对象,那么请在请求中加入最低限价的完整列表。
名称 | 描述 | 示例 | 必要 |
---|---|---|---|
countries | 与底价关联的国家/地区列表。请参阅 countries 对象,了解该对象的说明。此处仅支持 type=INCLUDE 。 | { "type": "INCLUDE", "values": ["at", "pt", "ro", "se", "si", "sk"] } | true |
country_group_name | 描述国家组的名称。 | "T1 EN Speaking" | true |
cpm | 针对该广告单元的每个展示,各广告平台需给出的最低 CPM 值。如果针对该组中的国家/地区,没有达到该值的广告,那么 MAX 就不会填充广告请求。 | 2.00 | true |
banner_refresh_settings
对象
该对象定义了横幅广告单元刷新时间间隔,以及调取新横幅广告的频率。如果您将 interval
设置为 0
,那么该广告单元将以 MAX 指定的默认频率刷新。
名称 | 描述 | 示例 |
---|---|---|
interval | 刷新横幅位前等待的时间 (以秒计)。可能的值为 0、10、15、20、30、45、60 和 300。 | 10 |
mrec_refresh_settings
对象
该对象定义了 MREC 广告单元刷新时间间隔,以及调取新 MREC 广告的频率。如果您将 interval
设置为 0
,那么该广告单元将以 MAX 指定的默认频率刷新。
名称 | 描述 | 示例 |
---|---|---|
interval | 刷新 MREC 广告位前等待的时间 (以秒计)。可能的值为 0、10、15、20、30、45、60 和 300。 | 10 |
segment
对象
该对象用于定义用户分群定向规则,为不同的分群分配不同的广告单元瀑布流。您可以根据 ID 状态和设备类型进行用户分群。请参阅 SDK 集成指南 > 您的平台 > 概述 > 数据和关键词传递文档,了解更多信息。
在主广告单元上,segment
对象包含在名为 segments
(复数) 的列表中。该瀑布流细分为只读列表,仅与该广告单元关联。查看指定了细分的广告单元瀑布流或创建新瀑布流时,细分对象就会与 segment
键 (单数) 相关联。
名称 | 描述 | 示例 |
---|---|---|
device_type | 设备类型定向。选项包括 "all" (默认),"phones" ,"tablets" 。 | "tablets" |
id | 与该分群关联的瀑布流 ID。创建新瀑布流时,请不要包含该值。 | 81234 |
id_type | 设备 ID 定向。选项包括 "all" (默认),"id_only" ,"no_id" 。 | "no_id" |
名称 | 该瀑布流的名称。 | "No-ID iPhones" |
segment_keys | 指示定义该分群键和值的数组。 | [ "+101:202" ] |
可能出现的错误
名称 | 描述 | 示例 |
---|---|---|
Bad Request | HTTP 响应代码 | 400 |
Unauthorized | HTTP 响应代码 | 401 |
Forbidden | HTTP 响应代码 | 403 |
/ad_units
终端
使用此终端查看所有活跃广告单元的基本详情。向此终端发送的 GET 请求仅会返回活跃的广告单元。您无法通过该 API 禁用或激活广告单元。要禁用或激活广告单元,请在 UI 中进行设置。
在请求中包含查询参数 fields
,您就能获得所有活跃广告单元的详细信息。将该参数的值设置为以逗号分隔的值列表,列出您要查看的所有其他字段的名称。可能的 fields
包括 ad_network_settings
,frequency_capping_settings
和 bid_floors
。如同您使用 /ad_unit/«ad-unit-ID»
终端 请求单一广告单元,会自动返回对应对象一样——您在请求额外的字段时,返回的字段值就会与这些对应对象的值相同。
如果广告单元过多,您向该终端发送的请求可能会超时,或返回 500
响应代码。您可以添加查询参数 limit
,限制返回的广告单元数量。将该值设置为整数,指示请求应返回的广告单元数量。要对所有广告单元分页查询,请添加查询参数 offset
。将该值设置为整数,描述应当跳过总列表中的多少个广告单元,才会显示结果集中的首个结果。如果 offset
值大于广告单元总量,响应就会返回一个空数组。
目标 URL
https://o.applovin.com/mediation/v1/ad_units
示例
GET
响应体
[ { "name": "My Inter Ad Unit", "platform": "ios", "package_name": "com.test.app", "ad_format": "INTER", "ad_unit_id": "45de6aa565cf865f", "has_active_experiment": false, "disabled": false }, { "name": "My Rewarded Ad Unit", "platform": "android", "package_name": "com.test.app", "ad_format": "REWARD", "ad_unit_id": "565c45df8e6aa65f", "has_active_experiment": false, "disabled": false }]
广告单元对象
名称 | 描述 | 示例 |
---|---|---|
ad_format | 广告单元的格式。 | INTER , BANNER , REWARD |
ad_unit_id | 广告单元 ID。 | 1234567890abcdef |
disabled | 该广告单元是否已禁用 (只读)。 | false |
has_active_experiment | 该广告单元是否有正在进行的实验 (只读)。 | false |
名称 | 广告单元的名称。 | "Mr. Bullet Rewarded" |
package_name | 与该广告单元关联的应用的包名 / Bundle ID。 | com.my.test.app |
platform | 广告单元的平台。 | ios , android |
可能出现的错误
名称 | 描述 | 示例 |
---|---|---|
Bad Request | HTTP 响应代码 | 400 |
Unauthorized | HTTP 响应代码 | 401 |
Forbidden | HTTP 响应代码 | 403 |
/ad_unit_experiment/«ad-unit-ID»
终端
您可以使用此终端来创建、查看、编辑、采纳或弃用广告单元实验。要更详细地查看所有广告单元实验,请在请求中包含查询参数 fields。将该参数的值设置为以逗号分隔的字段名称列表,列出您要查看的值的字段名称。
可能的 fields
包括 ad_network_settings
、frequency_capping_settings
和 bid_floors
。请参阅上文,了解与这些 fields
值对应的对象。
目标 URL
https://o.applovin.com/mediation/v1/ad_unit_experiment/«ad-unit-ID»?fields=ad_network_settings,frequency_capping_settings,bid_floors
示例
GET
响应体
{ "id": "e74c3b7797b0ce7a", "experiment_name": "add_admob_inter_lines", "platform": "ios", "ad_format": "INTER", "package_name": "com.testapp.test", "disabled": false, "promote": false, "deprecate": false, "ad_network_settings": [ { "ADMOB_NETWORK": { "disabled": true, "ad_network_app_id": "ca-app-pub-3555987499620362~3024971981", "ad_network_ad_units": [] } } ], "frequency_capping_settings": [ { "type": "time", "time_capping_settings": { "day_limit": 10, "minute_frequency": 10 }, "session_capping_settings": { "session_limit": 0 }, "countries" : { "type": "INCLUDE", "values" : [ "ca", "us" ] } } ], "bid_floors": [ { "country_group_name": "t1 eng", "cpm": "10.00", "countries": { "type": "INCLUDE", "values": [ "au", "ca" ] } } ]}
POST
创建实验请求体
向该终端发送实验创建请求时,请在请求体中排除 id
值,或将该值设置为 null。
{ "experiment_name": "test_adjusting_frequency_cap", "frequency_capping_settings": […]}
创建实验响应体
{ "id": "e74c3b7797b0ce7a", "experiment_name": "test_adjusting_frequency_cap", "disabled": false, "promote": false, "deprecate": false, "ad_network_settings":[{…}], // same as parent ad unit "frequency_capping_settings": […], "bid_floors":[{…}] // same as parent ad unit}
弃用实验请求体
{ "id": "e74c3b7797b0ce7a", "experiment_name": "test_adjusting_frequency_cap", "promote": false, "deprecate": true}
弃用实验响应体
{ "message": "Experiment successfully deprecated"}
采纳实验请求体
{ "id": "e74c3b7797b0ce7a", "experiment_name": "test_adjusting_frequency_cap", "promote": true, "deprecate": false}
采纳实验响应体
{ "message": "Experiment successfully promoted"}
广告单元实验对象
名称 | 描述 | 示例 | 必要 |
---|---|---|---|
ad_network_settings | 广告平台配置。 | 请参阅 /ad_unit/«ad-unit-ID» 终端。 | false |
bid_floors | 竞价最低限价。 | 请参阅 /ad_unit/«ad-unit-ID» 终端。 | false |
deprecate | 是否要弃用此实验。 | true | false |
disabled | 广告单元是否已禁用。 | false | false (只读) |
experiment_name | 广告单元实验的名称。 | "aggressive_freq_caps" | Create 和 Edit 为 true,Promote 和 Deprecate 为 false。 |
frequency_capping_settings | 频率上限设置。 | 请参阅 /ad_unit/«ad-unit-ID» 终端。 | false |
id | 广告单元 ID (与父级广告单元 ID 相同)。 | "e74c3b7797b0ce7a" | Edit、Promote 或 Deprecate 为 true;Create 为 false (必须缺失或为空) |
promote | 是否要采用此实验。 | true | false |
test_group_allocation | 参与本次测试的用户百分比。可能的值为:50、25、10 和 5。 | 25 | false |
可能出现的错误
名称 | 描述 | 示例 |
---|---|---|
Bad Request | HTTP 响应代码 | 400 |
Unauthorized | HTTP 响应代码 | 401 |
Forbidden | HTTP 响应代码 | 403 |
/test_device
终端
要创建测试设备,请向此终端发送 POST
请求。请在请求体中添加下方所述的必填字段。每个请求只能创建一个测试设备。
目标 URL
https://o.applovin.com/mediation/v1/test_device
示例
请求体
{ "name": "My Test Device", "device_id": "2fc1d626-22d4-4ba4-82e3-10ca1ad1abe1", "disabled": false, "network": "APPLOVIN_NETWORK"}
响应体
{ "name": "My Test Device", "device_id": "2fc1d626-22d4-4ba4-82e3-10ca1ad1abe1", "disabled": false, "network": "APPLOVIN_NETWORK"}
请求/响应体字段对照表
名称 | 描述 | 示例 | 创建时必需 (POST ) |
---|---|---|---|
device_id | 测试设备的 IDFA。 | "2fc1d626-22d4-4ba4-82e3-10ca1ad1abe1" | true |
disabled | 设备 ID 的状态 (禁用或启用)。 | false | true |
名称 | 测试设备的名称。 | "My Test Device" | true |
network | 已启用设备 ID 测试模式的平台。 | APPLOVIN_NETWORK | true |
/test_device/«test-device-ID»
终端
使用此终端查看 (GET
) 或编辑 (POST
) 测试设备配置。
目标 URL
https://o.applovin.com/mediation/v1/test_device/«test-device-ID»
示例
目标 URL
https://o.applovin.com/mediation/v1/test_device/2fc1d626-22d4-4ba4-82e3-10ca1ad1abe1
GET
响应体
{ "name": "My Test Device", "device_id": "2fc1d626-22d4-4ba4-82e3-10ca1ad1abe1", "disabled": false, "network": "APPLOVIN_NETWORK"}
POST
请求体
{ "name": "My Test Device", "device_id": "2fc1d626-22d4-4ba4-82e3-10ca1ad1abe1", "disabled": true, "network": "FACEBOOK_NETWORK"}
响应体
{ "name": "My Test Device", "device_id": "2fc1d626-22d4-4ba4-82e3-10ca1ad1abe1", "disabled": true, "network": "FACEBOOK_NETWORK"}
该 JSON 对象与 /test_device
终端 返回的对象相同。
/test_devices
终端
使用此终端查看您的账户中所有测试设备的基本详情。响应中同时包含已禁用和启用的测试设备。
目标 URL
https://o.applovin.com/mediation/v1/test_devices
示例
响应体
{ "name": "My Test Device", "device_id": "2fc1d626-22d4-4ba4-82e3-10ca1ad1abe1", "disabled": false, "network": "APPLOVIN_NETWORK"},{ "name": "My Test Device 2", "device_id": "2fc1d626-22d4-4ba4-82e3-10ca1ad1abe2", "disabled": false, "network": "FACEBOOK_NETWORK"}
这些 JSON 对象与 /test_device
终端 返回的对象相同。
多瀑布流
您可以基于用户分群,为指定广告单元创建额外的瀑布流。您可以使用与本页中其他请求类似的结构,创建或编辑瀑布流,或创建/编辑/弃用/采用瀑布流实验。要指定应用请求的用户分群,请在终端末尾附加 /«segment-ID»
,其中 «segment-ID» 为广告单元响应中来自 segment
对象的 id
值。新分群的初始瀑布流与广告单元默认配置的瀑布流相同。请参阅 segment 对象,进一步了解如何定义用户分群。
示例
GET
获取广告单元 1234567890abcdef 中 segment ID 213 的瀑布流:
https://o.applovin.com/mediation/v1/ad_unit/1234567890abcdef/213
获取广告单元 1234567890abcdef 中 segment ID 213 的实验瀑布流:
https://o.applovin.com/mediation/v1/ad_unit_experiment/1234567890abcdef/213
POST
为广告单元 1234567890abcdef 中 No-ID iPhone 用户创建新瀑布流:
https://o.applovin.com/mediation/v1/ad_unit/1234567890abcdef
{ "id": "1234567890abcdef", // ad unit ID "name": "MyApp_iOS_Banners", // ad unit name "platform": "ios", "ad_format": "BANNER", "package_name": "com.company.myapp", "disabled": false, "segment": { "name": "No-ID iPhones", // waterfall name "id_type": "no_id", "device_type": "phones", "segment_keys": [ [ "+1:2" ] ] }}
移除广告单元 1234567890abcdef 中 segment ID 213 的瀑布流 (将 disabled
设为 true
):
https://o.applovin.com/mediation/v1/ad_unit/1234567890abcdef/213
{ "id": "1234567890abcdef", // ad unit ID "name": "MyApp_iOS_Banners", // ad unit name "platform": "ios", "ad_format": "BANNER", "package_name": "com.company.myapp", "disabled": true}
广告平台
参考该表格,了解广告单元 API 用于广告平台和应用标识符的名称,与各广告平台内部名称之间的对应关系。如果此处列出的广告平台具有 ad_network_app_id
(ID) 或 ad_network_app_key
(Key) 值,那么在发送 ad_network_settings
对象更新请求时,就必须提供该值。如果表格中并未列出平台相应字段的值,则无需提供。
广告平台 | 广告平台 API 名称 | ID | Key | Ad Unit ID |
---|---|---|---|---|
AdColony Bidding | ADCOLONY_NETWORK | App ID | ⸺ | Zone ID |
AdMob | ADMOB_NETWORK | Google App ID | ⸺ | Ad Unit ID |
AdMob Native | ADMOB_NATIVE_NETWORK | Google App ID | ⸺ | Ad Unit ID |
BidMachine Bidding | BIDMACHINE_BIDDING | Source ID | ⸺ | ⸺ |
BIGO Ads Bidding | BIGO_BIDDING | App ID | ⸺ | Slot ID |
Chartboost | CHARTBOOST_NETWORK | App ID | App Signature | Ad Location |
CSJ | CSJ_NETWORK | App ID | ⸺ | Slot ID |
DT Exchange | FYBER_NETWORK | App ID | ⸺ | Spot ID |
DT Exchange Bidding | FYBER_BIDDING | App ID | ⸺ | Placement ID |
Google Ad Manager | GOOGLE_AD_MANAGER_NETWORK | ⸺ | ⸺ | Placement ID |
Google Ad Manager Native | GOOGLE_AD_MANAGER_NATIVE_NETWORK | ⸺ | ⸺ | Placement ID |
Google Bidding | ADMOB_BIDDING | Google App ID | ⸺ | Ad Unit ID |
HyprMX | HYPRMX_NETWORK | Distributor ID | ⸺ | Placement Name |
InMobi | INMOBI_NETWORK | Account ID | ⸺ | Placement ID |
InMobi Bidding | INMOBI_BIDDING | Account ID | ⸺ | Placement ID |
ironSource | IRONSOURCE_NETWORK | App Key | ⸺ | Instance ID |
ironSource Bidding | IRONSOURCE_BIDDING | App Key | ⸺ | Instance ID |
Liftoff Monetize | VUNGLE_NETWORK | App ID | ⸺ | Placement Reference ID |
Liftoff Monetize Bidding | VUNGLE_BIDDING | App ID | ⸺ | Placement Reference ID |
LINE | LINE_NETWORK | App ID | ⸺ | Slot ID |
LINE Native | LINE_NATIVE_NETWORK | App ID | ⸺ | Slot ID |
Maio | MAIO_NETWORK | Media ID | ⸺ | Zone ID |
Meta Audience Network | FACEBOOK_MEDIATE | ⸺ | ⸺ | Placement ID |
Meta Audience Network Bidding | FACEBOOK_NETWORK | ⸺ | ⸺ | Placement ID |
Meta Audience Network Native Bidding | FACEBOOK_NATIVE_BIDDING | ⸺ | ⸺ | Placement ID |
Mintegral1 | MINTEGRAL_NETWORK | App ID | App Key | Ad Unit ID |
Mintegral Bidding1 | MINTEGRAL_BIDDING | App ID | App Key | Ad Unit ID |
Mintegral Native Bidding1 | MINTEGRAL_NATIVE_BIDDING | App ID | App Key | Ad Unit ID |
MobileFuse | MOBILEFUSE_NETWORK | Publisher ID | ⸺ | Placement ID |
MobileFuse Bidding | MOBILEFUSE_BIDDING | ⸺ | ⸺ | Placement ID |
MobileFuse Native Bidding | MOBILEFUSE_NATIVE_BIDDING | ⸺ | ⸺ | Placement ID |
Moloco Bidding | MOLOCO_BIDDING | ⸺ | App Key | Ad Unit ID |
Ogury | OGURY_PRESAGE_NETWORK | Asset Key | ⸺ | Ad Unit ID |
Ogury Bidding | OGURY_PRESAGE_BIDDING | Asset Key | ⸺ | Ad Unit ID |
Pangle | TIKTOK_NETWORK | App ID | ⸺ | Slot ID |
Pangle Bidding | TIKTOK_BIDDING | App ID | ⸺ | Slot ID |
Pangle Native | TIKTOK_NATIVE_NETWORK | App ID | ⸺ | Slot ID |
Pangle Native Bidding | TIKTOK_NATIVE_BIDDING | App ID | ⸺ | Slot ID |
PubMatic Bidding | PUBMATIC_BIDDING | Publisher ID | Profile ID | Ad Unit ID |
Smaato | SMAATO_NETWORK | Publisher ID | ⸺ | Ad Space ID |
Smaato Bidding | SMAATO_BIDDING | Publisher ID | ⸺ | Ad Space ID |
Smaato Native Bidding | SMAATO_NATIVE_BIDDING | Publisher ID | ⸺ | Ad Space ID |
Tapjoy Bidding | TAPJOY_NETWORK | SDK Key | ⸺ | Placement Name |
Tencent | TENCENT_NETWORK | App ID | ⸺ | Ad Slot ID |
Unity Ads | UNITY_NETWORK | Game ID | ⸺ | Placement ID |
Unity Bidding | UNITY_BIDDING | Game ID | ⸺ | Placement ID |
Verve Group Bidding | VERVE_BIDDING | App Token | ⸺ | Zone Reference |
VK Ad Network | MYTARGET_NETWORK | ⸺ | ⸺ | Placement ID |
VK Ad Network Bidding | MYTARGET_BIDDING | ⸺ | ⸺ | Placement ID |
VK Ad Network Native Bidding | MYTARGET_NATIVE_BIDDING | ⸺ | ⸺ | Placement ID |
Yandex | YANDEX_NETWORK | ⸺ | ⸺ | Block ID |
Yandex Bidding | YANDEX_BIDDING | ⸺ | ⸺ | Block ID |
YSO Network Bidding | YSO_BIDDING | ⸺ | ⸺ | Key |
1 Mintegral / Mintegral Bidding 可能包含额外的 Placement ID。该 ID 会通过调用顶层对象中的 extraParameters
对象进行处理。extraParameters
对象有名为 ad_network_optional_placement_id
的字段,该字段会采用此 Placement ID 值。
请参阅下方示例:
{ "MINTEGRAL_NETWORK": { "disabled": false, "targets": {}, "ad_network_ad_units": [ { "ad_network_ad_unit_id": "1232524", "extraParameters": null, "disabled": false, "cpm": "1.23", "countries": { "type": "INCLUDE", "values": [] } } ], "ad_network_app_id": "testappId", "ad_network_app_key": "testappKey", "extraParameters": { "ad_network_optional_placement_id": "1234354" } }}