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. Send partner-specific values in platforms.android.channel_setup or platforms.ios.channel_setup. Legacy requests use top-level channel_setup.
3. Send only the values you want to change. The API merges them with the values saved for that platform.

Supported partners

The following partners require channel setup configuration:

Parameters

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

AppLovin

Chartboost

Facebook

GameAnalytics

Google

InMobi

ironSource

Mintegral

Snapchat

Tapjoy

TikTok

Unity Ads

Vungle

Examples

Complete channel setup example

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

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:

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:

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:

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

Event linking

Event linking maps an Adjust event to the event name a partner receives. Use events_linking inside override_settings.partners to set it through the API. This applies to every partner that supports event linking, including Google.

How event linking works

• events_linking is a map from the Adjust event name to the partner event name.
• Partners are matched by name, and each partner has its own map.
• The partner must already be integrated on the app, and the events must exist. Create events with the POST /events endpoint first.
• Send events_linking with POST /app or POST /app/{app_token}. Each request applies to one app. To link events on many apps, store the mapping in the template app and migrate it, or repeat the request for each app.
• Linking only creates or updates mappings. It never removes a mapping from the target app.

{
   "override_settings": {
      "partners": [
         {
            "name": "google",
            "events_linking": {
               "purchase": "purchase_completed",
               "registration": "sign_up"
            }
         }
      ]
   }
}

To view current mappings, call GET /app/{app_token}/settings with sections=partners and read events_linking for the partner.

Google

Google Ads links every Adjust event automatically. By default, each event is sent to Google Ads as event_{AdjustEventName}, so you only need events_linking to use a different name. If you share in-app revenue with Google Ads, map at least one revenue event. For naming rules and the full behavior, see Set up Google Ads in the Adjust Help Center.