adjust-icon

Channel setup

Some ad network partners require additional configuration values to complete their integration. Use the channel_setup parameter when creating or updating apps to provide these partner-specific settings.

How channel setup works

When you create or update an app with the /app endpoint, the API copies partner configurations from your template app. However, certain partners require app-specific values (like app IDs or API keys) that vary between apps.

Workflow

  1. Create your app using the POST /app endpoint.
  2. Once you have your partner-specific IDs, send another request with the channel_setup parameter.
  3. Include all channel setup values in each request—the API doesn’t merge values from previous requests.

Supported partners

The following partners require channel setup configuration:

PartnerRequired parametersDescription
applovinsdk_keysArray of AppLovin SDK keys for your app.
chartboostapp_id, tokenYour Chartboost app ID and app signature.
facebookapp_idYour Facebook app ID. Optionally include adimpression_forwarding to enable ad impression forwarding.
gameanalyticskeyYour unique GameAnalytics game key.
googlelink_idYour Google Ads link ID.
inmobiproperty_id, advertiser_idYour InMobi property ID and advertiser ID.
ironsourceadvertiser_id, passwordYour ironSource advertiser ID and password.
mintegralenabledSet to true to enable the Mintegral integration.
snapchatsnap_app_idYour Snapchat app ID.
tapjoyapp_idYour Tapjoy app ID.
tiktokapp_id, enabledYour TikTok app ID and whether the integration is enabled.
unityadsgame_idYour Unity Ads game ID.
vungleapp_idYour Vungle app ID.

Parameters

All parameters are passed as key-value pairs inside the channel_setup object.

AppLovin

ParameterData typeRequiredDescription
sdk_keysArray[String]YesList of AppLovin SDK keys for your app.

Chartboost

ParameterData typeRequiredDescription
app_idStringYesYour Chartboost app ID.
tokenStringYesYour Chartboost app signature.

Facebook

ParameterData typeRequiredDescription
app_idStringYesYour Facebook app ID.
adimpression_forwardingBooleanNoEnable ad impression forwarding. Default: false.

GameAnalytics

ParameterData typeRequiredDescription
keyStringYesYour unique GameAnalytics game key.

Google

ParameterData typeRequiredDescription
link_idStringYesYour Google Ads link ID.

InMobi

ParameterData typeRequiredDescription
property_idStringYesYour InMobi property ID (GMP ID).
advertiser_idStringYesYour InMobi advertiser ID.

ironSource

ParameterData typeRequiredDescription
advertiser_idStringYesYour ironSource advertiser ID.
passwordStringYesYour ironSource password.

Mintegral

ParameterData typeRequiredDescription
enabledBooleanYesSet to true to enable the Mintegral integration.

Snapchat

ParameterData typeRequiredDescription
snap_app_idStringYesYour Snapchat app ID.

Tapjoy

ParameterData typeRequiredDescription
app_idStringYesYour Tapjoy app ID.

TikTok

ParameterData typeRequiredDescription
app_idStringYesYour TikTok app ID.
enabledBooleanNoWhether the integration is enabled. Default: true.

Unity Ads

ParameterData typeRequiredDescription
game_idStringYesYour Unity Ads game ID.

Vungle

ParameterData typeRequiredDescription
app_idStringYesYour Vungle app ID.

Examples

Complete channel setup example

This example shows a request with channel setup for multiple partners:

Request - 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"
}
}
}'

Single partner setup

Configure just one partner:

Request - 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"
}
}
}'

Update channel setup for existing app

Add channel setup to an existing app by sending a new request with force_update:

Request - 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"
}
}
}'

Viewing channel setup

To view the current channel setup for an app, use the GET /app/{app_token} endpoint. The response includes a channel_setup object with the configured values:

Response
{
"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" }
}
}