有些广告渠道合作伙伴需要额外的配置值才能完成集成。在创建或更新应用时,请使用 channel_setup 参数提供合作伙伴特定设置。
渠道设置工作原理
当您使用/app 终端创建或更新应用时,API 会从您的模板应用中复制合作伙伴配置。不过,部分合作伙伴对应用特定值 (如应用 ID 或 API 密钥) 的要求因应用而异。
工作流程
- 使用
POST /app 终端 创建应用。
- 获得合作伙伴特定 ID 后,请再次发送带有
channel_setup 参数的请求。
- 在每个请求中包含 所有 渠道设置值。API 不会合并之前请求的值。
受支持的合作伙伴
下列合作伙伴需要渠道设置配置:
| 合作伙伴 | 必要参数 | 描述 |
|---|
applovin | sdk_keys | 应用的 AppLovin SDK key 数组。 |
chartboost | app_id, token | 您的 Chartboost 应用 ID 和应用签名。 |
facebook | app_id | 您的 Facebook 应用 ID。您可以选择包含 adimpression_forwarding 以启用广告展示转发。 |
gameanalytics | key | 您的唯一 GameAnalytics 游戏密钥。 |
google | link_id | 您的 Google Ads 链接 ID。 |
inmobi | property_id, advertiser_id | 您的 InMobi property ID 和广告主 ID。 |
ironsource | advertiser_id, password | 您的 ironSource 广告主 ID 和密码。 |
mintegral | enabled | 设置为 true 以启用 Mintegral 集成。 |
snapchat | snap_app_id | 您的 Snapchat 应用 ID。 |
tapjoy | app_id | 您的 Tapjoy 应用 ID。 |
tiktok | app_id, enabled | 您的 TikTok 应用 ID 以及集成是否已启用。 |
unityads | game_id | 您的 Unity Ads 游戏 ID。 |
vungle | app_id | 您的 Vungle 应用 ID。 |
参数
所有参数均须采用键值对形式,在 channel_setup 对象中传送。
AppLovin
| 参数 | 数据类型 | 必要参数 | 描述 |
|---|
sdk_keys | Array[String] | 是 | 应用的 AppLovin SDK key 列表。 |
Chartboost
| 参数 | 数据类型 | 必要参数 | 描述 |
|---|
app_id | String | 是 | 您的 Chartboost 应用 ID。 |
token | String | 是 | 您的 Chartboost 应用签名。 |
Facebook
| 参数 | 数据类型 | 必要参数 | 描述 |
|---|
app_id | String | 是 | 您的 Facebook 应用 ID。 |
adimpression_forwarding | Boolean | 否 | 启用广告展示转发。默认为 false。 |
GameAnalytics
| 参数 | 数据类型 | 必要参数 | 描述 |
|---|
key | String | 是 | 您的唯一 GameAnalytics 游戏密钥。 |
Google
| 参数 | 数据类型 | 必要参数 | 描述 |
|---|
link_id | String | 是 | 您的 Google Ads 链接 ID。 |
InMobi
| 参数 | 数据类型 | 必要参数 | 描述 |
|---|
property_id | String | 是 | 您的 InMobi property ID (GMP ID)。 |
advertiser_id | String | 是 | 您的 Inmobi 广告主 ID。 |
ironSource
| 参数 | 数据类型 | 必要参数 | 描述 |
|---|
advertiser_id | String | 是 | 您的 ironSource 广告主 ID。 |
password | String | 是 | 您的 ironSource 密码。 |
Mintegral
| 参数 | 数据类型 | 必要参数 | 描述 |
|---|
enabled | Boolean | 是 | 设置为 true 以启用 Mintegral 集成。 |
Snapchat
| 参数 | 数据类型 | 必要参数 | 描述 |
|---|
snap_app_id | String | 是 | 您的 Snapchat 应用 ID。 |
Tapjoy
| 参数 | 数据类型 | 必要参数 | 描述 |
|---|
app_id | String | 是 | 您的 Tapjoy 应用 ID。 |
TikTok
| 参数 | 数据类型 | 必要参数 | 描述 |
|---|
app_id | String | 是 | 您的 TikTok 应用 ID。 |
enabled | Boolean | 否 | 是否启用集成。默认为 true。 |
Unity Ads
| 参数 | 数据类型 | 必要参数 | 描述 |
|---|
game_id | String | 是 | 您的 Unity Ads 游戏 ID。 |
Vungle
| 参数 | 数据类型 | 必要参数 | 描述 |
|---|
app_id | String | 是 | 您的 Vungle 应用 ID。 |
示例
完整渠道源设置示例
此示例显示了针对多个合作伙伴的渠道设置请求:
curl --location 'https://automate.adjust.com/app-automation/app' \
--header 'Authorization: Bearer {your-adjust-api-token}' \
--header 'Content-Type: application/json' \
"bundle_id": "com.example.myapp",
"store_id": "com.example.myapp",
"sdk_keys": ["sdk_key_1", "sdk_key_2"]
"app_id": "chartboost_app_id",
"adimpression_forwarding": true
"link_id": "adwords_link_id"
"property_id": "inmobi_property_id",
"advertiser_id": "advertiser_id"
"snap_app_id": "snapchat_app_id"
"app_id": "tapjoy_app_id"
"game_id": "unity_game_id"
"app_id": "vungle_app_id"
单一合作伙伴设置
仅配置一位合作伙伴:
curl --location 'https://automate.adjust.com/app-automation/app' \
--header 'Authorization: Bearer {your-adjust-api-token}' \
--header 'Content-Type: application/json' \
"bundle_id": "com.example.myapp",
"store_id": "com.example.myapp",
更新现有应用的渠道设置
发送带有 force_update 的新请求,可为现有应用添加渠道设置:
curl --location 'https://automate.adjust.com/app-automation/app' \
--header 'Authorization: Bearer {your-adjust-api-token}' \
--header 'Content-Type: application/json' \
"bundle_id": "com.example.myapp",
"store_id": "com.example.myapp",
"link_id": "new_google_link_id"
"app_id": "updated_facebook_id"
查看渠道设置
要查看应用当前的渠道设置,请使用 GET /app/{app_token} 终端。响应中包含带有已配置值的 channel_setup 对象:
"store_id": "com.example.myapp",
"adjust_app_token": "abc123xyz",
"facebook": { "app_id": "123456789" },
"google": { "link_id": "adwords_link_id" },
"snapchat": { "snap_app_id": "snapchat_app_id" }