adjust-icon

渠道源 (channel) 设置

有些广告渠道合作伙伴需要额外的配置值才能完成集成。在创建或更新应用时,请使用 channel_setup 参数提供合作伙伴特定设置。

渠道设置工作原理

当您使用/app 终端创建或更新应用时,API 会从您的模板应用中复制合作伙伴配置。不过,部分合作伙伴对应用特定值 (如应用 ID 或 API 密钥) 的要求因应用而异。

工作流程

  1. 使用 POST /app 终端 创建应用。
  2. 在 platforms.android.channel_setup 或 platforms.ios.channel_setup 中发送合作伙伴专属值。旧版请求使用顶层 channel_setup。
  3. 仅发送您要更改的值。API 会将其与为该平台保存的值合并。

受支持的合作伙伴

下列合作伙伴需要渠道设置配置:

合作伙伴必要参数描述
applovinsdk_keys应用的 AppLovin SDK key 数组。
chartboostapp_id, token您的 Chartboost 应用 ID 和应用签名。
facebookapp_id您的 Facebook 应用 ID。您可以选择包含 adimpression_forwarding 以启用广告展示转发。
gameanalyticskey您的唯一 GameAnalytics 游戏密钥。
googlelink_id您的 Google Ads 链接 ID。
inmobiproperty_id, advertiser_id您的 InMobi property ID 和广告主 ID。
ironsourceadvertiser_id, password您的 ironSource 广告主 ID 和密码。
mintegralenabled设置为 true 以启用 Mintegral 集成。
snapchatsnap_app_id您的 Snapchat 应用 ID。
tapjoyapp_id您的 Tapjoy 应用 ID。
tiktokapp_id, enabled您的 TikTok 应用 ID 以及集成是否已启用。
unityadsgame_id您的 Unity Ads 游戏 ID。
vungleapp_id您的 Vungle 应用 ID。

参数

所有参数均须采用键值对形式,在 channel_setup 对象中传送。

AppLovin

参数数据类型必要参数描述
sdk_keysArray[String]是应用的 AppLovin SDK key 列表。

Chartboost

参数数据类型必要参数描述
app_idString是您的 Chartboost 应用 ID。
tokenString是您的 Chartboost 应用签名。

Facebook

参数数据类型必要参数描述
app_idString是您的 Facebook 应用 ID。
adimpression_forwardingBoolean否启用广告展示转发。默认为 false。

GameAnalytics

参数数据类型必要参数描述
keyString是您的唯一 GameAnalytics 游戏密钥。

Google

参数数据类型必要参数描述
link_idString是您的 Google Ads 链接 ID。

InMobi

参数数据类型必要参数描述
property_idString是您的 InMobi property ID (GMP ID)。
advertiser_idString是您的 Inmobi 广告主 ID。

ironSource

参数数据类型必要参数描述
advertiser_idString是您的 ironSource 广告主 ID。
passwordString是您的 ironSource 密码。

Mintegral

参数数据类型必要参数描述
enabledBoolean是设置为 true 以启用 Mintegral 集成。

Snapchat

参数数据类型必要参数描述
snap_app_idString是您的 Snapchat 应用 ID。

Tapjoy

参数数据类型必要参数描述
app_idString是您的 Tapjoy 应用 ID。

TikTok

参数数据类型必要参数描述
app_idString是您的 TikTok 应用 ID。
enabledBoolean否是否启用集成。默认为 true。

Unity Ads

参数数据类型必要参数描述
game_idString是您的 Unity Ads 游戏 ID。

Vungle

参数数据类型必要参数描述
app_idString是您的 Vungle 应用 ID。

示例

完整渠道源设置示例

此示例显示了针对多个合作伙伴的渠道设置请求:

请求 - cURL
curl --location 'https://automate.adjust.com/app-automation/app' \
--header 'Authorization: Bearer {your-adjust-api-token}' \
--header 'Content-Type: application/json' \
--data '{
"name": "My App",
"bundle_id": "com.example.myapp",
"store_id": "com.example.myapp",
"platform": "android",
"channel_setup": {
"applovin": {
"sdk_keys": ["sdk_key_1", "sdk_key_2"]
},
"chartboost": {
"app_id": "chartboost_app_id",
"token": "app_signature"
},
"facebook": {
"app_id": "123456789",
"adimpression_forwarding": true
},
"gameanalytics": {
"key": "unique_game_key"
},
"google": {
"link_id": "adwords_link_id"
},
"inmobi": {
"property_id": "inmobi_property_id",
"advertiser_id": "advertiser_id"
},
"ironsource": {
"advertiser_id": "6734",
"password": "abc123"
},
"mintegral": {
"enabled": true
},
"snapchat": {
"snap_app_id": "snapchat_app_id"
},
"tapjoy": {
"app_id": "tapjoy_app_id"
},
"tiktok": {
"app_id": "5464534",
"enabled": true
},
"unityads": {
"game_id": "unity_game_id"
},
"vungle": {
"app_id": "vungle_app_id"
}
}
}'

单一合作伙伴设置

仅配置一位合作伙伴:

请求 - cURL
curl --location 'https://automate.adjust.com/app-automation/app' \
--header 'Authorization: Bearer {your-adjust-api-token}' \
--header 'Content-Type: application/json' \
--data '{
"name": "My App",
"bundle_id": "com.example.myapp",
"store_id": "com.example.myapp",
"platform": "android",
"channel_setup": {
"facebook": {
"app_id": "987654321"
}
}
}'

更新现有应用的渠道设置

发送带有 force_update 的新请求,可为现有应用添加渠道设置:

请求 - cURL
curl --location 'https://automate.adjust.com/app-automation/app' \
--header 'Authorization: Bearer {your-adjust-api-token}' \
--header 'Content-Type: application/json' \
--data '{
"name": "My App",
"bundle_id": "com.example.myapp",
"store_id": "com.example.myapp",
"platform": "android",
"force_update": true,
"channel_setup": {
"google": {
"link_id": "new_google_link_id"
},
"facebook": {
"app_id": "updated_facebook_id"
}
}
}'

查看渠道设置

要查看应用当前的渠道设置,请使用 GET /app/{app_token} 终端。响应中包含带有已配置值的 channel_setup 对象:

响应
{
"name": "My App",
"store_id": "com.example.myapp",
"platform": "android",
"adjust_app_token": "abc123xyz",
"channel_setup": {
"facebook": { "app_id": "123456789" },
"google": { "link_id": "adwords_link_id" },
"snapchat": { "snap_app_id": "snapchat_app_id" }
}
}

EventLinking

EventLinking 会将 Adjust 事件映射到合作伙伴接收的事件名称。在 override_settings.partners 中使用 events_linking 通过 API 对其进行设置。这适用于每个支持 EventLinking 的合作伙伴,包括 Google。

EventLinking 的工作原理

  • events_linking 是 Adjust 事件名称到合作伙伴事件名称的映射。
  • 合作伙伴按 name 进行匹配,每个合作伙伴都有自己的映射。
  • 合作伙伴必须已集成到应用中,并且这些事件必须已经存在。请先使用 POST /events 终端 创建事件。
  • 通过 POST /app 或 POST /app/{app_token} 发送 events_linking。每个请求适用于一个应用。若要在多个应用中链接事件,请将映射存储在模板应用中并进行迁移,或者针对每个应用重复该请求。
  • 链接仅会创建或更新映射。它绝不会从目标应用中移除映射。
请求正文 - Google 的链接事件
{
"override_settings": {
"partners": [
{
"name": "google",
"events_linking": {
"purchase": "purchase_completed",
"registration": "sign_up"
}
}
]
}
}

如需查看当前映射,请使用 sections=partners 调用GET /app/{app_token}/settings,并读取合作伙伴的 events_linking。

Google

Google Ads 会自动链接每个 Adjust 事件。默认情况下,每个事件都会以 event_{AdjustEventName} 的形式发送到 Google Ads,因此您只需 events_linking 即可使用其他名称。如果您与 Google Ads 共享应用内收入,请至少映射一个收入事件。有关命名规则和完整行为,请参阅 Adjust 帮助中心中的设置 Google Ads。