Campaign Management API

These APIs are for advertisers who use AppLovin’s App Discovery to promote their apps. Advertisers (and users who have advertising access to their company’s account) can create an OAuth application to manage authentication to access these APIs. Alternatively, advertisers can create third-party OAuth applications to help manage campaigns across many different advertising clients.

Third-Party App Authorization Flow

This section is for companies who use the Campaign Management API on behalf of other companies who use third-party apps. If you manage your own company’s campaigns, use a first-party OAuth app and skip to the API Request Authentication section.

AppLovin supports the standard OAuth web application flow. All query parameters are required. Send users to this URL to prompt them to authorize your app to manage their campaigns:

Third-Party App Authorization Flow Target URL

https://oauth.applovin.com/oauth/initialize

Table of Third-Party App Authorization Request Query Parameters

Third-Party App Authorization Flow Sample Request

https://oauth.applovin.com/oauth/initialize?response_type=code&client_id=34af7c430e24bbccbc647ca3dd5ac858&redirect_uri=https%3A%2F%2Fmydomain.com%2Foauth_code&scope=campaigns%3Awrite%20creatives%3Awrite&state=ab13221308fe6abad1d1

After the user consents to using your OAuth app, Applovin sends a callback to your redirect_uri with the user’s authentication code.

Table of Third-Party App Authorization Response Query Parameters

Third-Party App Authorization Flow Sample Callback Request

https://mydomain.com/oauth_code?code=9aa19842db327e4e43cc426e6ad6c2d1eacd2e3d464&state=ab13221308fe6abad1d1

API Request Authentication

Issue a POST request to this endpoint to generate a session token from your Client ID and Client Secrets. The session token lasts for 60 minutes for first-party OAuth applications. Put the access token you retrieve from this endpoint in the accessToken.access_token field in the response on all other requests with the header Authorization: Bearer access_token.

Authentication Target URL

https://oauth.applovin.com/oauth/v1/access_token

Authentication Content Type

multipart/form-data

Table of Access Token Form Fields

Sample First-Party App Response Body

{
  "accessToken":{
    "token_type":"Bearer",
    "expires_in":3600,
    "access_token":"cLXHaoel3iWi5Z3D"
  }
}

Sample Third-Party App Response Body

{
  "accessToken": {
    "token_type": "Bearer",
    "expires_in": 3600,
    "access_token": "JeUqLpg1KbJTICq4J28gNfV0TWGDedLDZgwlq3W91R2_eiNG1IwTznW8twia7",
    "refresh_token": "c75742c98f382264fca6a0a5759354b6eb95ea1a7c44d0e0b22e36ff26f8"
  }
}

/campaign/campaign_id

Issue a GET request to this endpoint to view an individual campaign’s details.

Issue a POST request to this endpoint to edit an individual campaign’s details, or to create a new campaign. When you create a new campaign, don’t fill in the campaign_id in the request URL nor in the request body.

/campaign/campaign_id Target URL

https://o.applovin.com/campaign_management/v1/campaign/campaign_id

/campaign/campaign_id Sample Response Body

{
  "name": "Test Campaign Name - iOS",
  "campaign_id": "29d66efc22ae53a201e1532265b83f12",
  "package_name": "123456789",
  "bundle_id":"com.sample.app.ios",
  "platform": "ios",
  "category": "101",
  "bid_type": "CPI",
  "tracking_method": "adjust",
  "status": true,
  "created_at": "2021-06-29 00:00:00",
  "impressions": 21,
  "clicks": 4,
  "installs": 1,
  "spend": "1.4300"
}

/campaign/campaign_id Sample Request Body (Update)

{
  "campaign_id": "29d66efc22ae53a201e1532265b83f12",
  "status": false
}

/campaign/campaign_id Sample Request Body (Create)

{
  "name": "My New Campaign Name",
  "package_name": "987654321",
  "bundle_id":"com.sample.app.ios",
  "platform": "ios",
  "category": "108",
  "bid_type": "CPE",
  "tracking_method": "adjust",
  "status": "true"
}

Table of /campaign/campaign_id Request/Response Body Fields

/campaigns

Issue a GET request to this endpoint to view all campaigns. There is no ability to make edits to campaigns with this endpoint.

/campaigns Target URL

https://o.applovin.com/campaign_management/v1/campaigns

/campaigns Sample Response Body

[
 {
  "name": "Test Campaign Name - iOS",
  "campaign_id": "29d66efc22ae53a201e1532265b83f12",
  "package_name": "123456789",
  "bundle_id": "com.sample.app.ios",
  "platform": "ios",
  "category": "101",
  "bid_type": "CPI",
  "tracking_method": "adjust",
  "status": false,
  "created_at": "2021-06-29 00:00:00",
  "impressions": 21,
  "clicks": 4,
  "installs": 1,
  "spend": "1.4300"
 },
 {
  "name": "Test Campaign Name - Android",
  "campaign_id": "265b83f129d66efc22ae201e153253a2",
  "package_name": "com.sample.app.android",
  "platform": "android",
  "category": "201",
  "bid_type": "CPI",
  "status": false,
  "created_at": "2021-06-29 00:00:00",
  "impressions": 39,
  "clicks": 9,
  "installs": 2,
  "spend": "1.8600"
 }
]

Table of /campaigns Response Body Fields

See the table of request/response fields from /campaign/campaign_id.

/creative_set/creative_set_id

Issue a POST request to this endpoint to update a creative set’s name or to create a new creative set. To create a new creative set, don’t fill in the creative_set_id in the request URL nor in the request body. A creative set is a collection of assets that can be combined together to generate many ads so that you do not need to upload each asset multiple times. Creative sets also include information about the languages that the underlying assets are in.

/creative_set/creative_set_id Target URL

https://o.applovin.com/campaign_management/v1/creative_set/creative_set_id

/creative_set/creative_set_id Sample Response Body

{
  "campaign_id":"f87ece84f46b55cfbf24427ff8746a40",
  "name":"My Test Creative Set 0",
  "countries":["us","gb"],
  "languages":[
    "en"
  ],
  "ads":[],
  "assets":[],
  "product_page": null
}

Table of /creative_set/creative_set_id Request/Response Body Fields

Table of Asset Object Fields

/creative_sets/campaign_id

Issue a GET request to this endpoint to view all creative sets associated with a campaign.

/creative_sets/campaign_id Target URL

https://o.applovin.com/campaign_management/v1/creative_sets/campaign_id

/creative_sets/campaign_id Sample Response Body

[
  {
    "campaign_id":"f87ece84f46b55cfbf24427ff8746a40",
    "name":"My Test Creative Set 0",
    "countries":["us","gb"],
    "languages":[
      "en"
    ],
    "ads":[…],
    "assets":[…],
    "product_page": null
  }
]

Table of /creative_sets/campaign_id Response Body Fields

See the table of request/response fields from /creative_set/creative_set_id.

/creative_set_assets/creative_set_id

Issue a POST request to this endpoint to upload, update, or remove an asset associated with a creative set. Only one asset can be managed per request. The response will include all assets in the creative set.

These requests use a form structure, JSON-style bodies will generate an error.

POST /creative_set_assets/creative_set_id Target URL

https://o.applovin.com/campaign_management/v1/creative_set_assets/creative_set_id

POST /creative_set_assets/creative_set_id Content Type

multipart/form-data

Table of Request Asset Form Fields

Sample POST /creative_set_assets/creative_set_id Response Body

[
  {
    "asset":"https://res1.applovin.com/oab7a439/foobidyfoo_v23_phone.mp4",
    "status":"ready",
    "type":"VID_LONG_P"
  },
  {
    "asset":"Help the heroes to defeat the villains and save the world!",
    "status":"ready",
    "type":"TXT_SUBTITLE"
  }
]

Table of POST /creative_set_assets/creative_set_id Response Asset Object Fields

/ad/ad_id

Issue a GET request to this endpoint to view an ad’s properties.

Issue a POST request to this endpoint to edit an ad’s name or status. Ads are automatically created once all required assets for that ad template are uploaded to a creative set via the UI or an API call to /creative_set/creative_set_id.

/ad/ad_id Target URL

https://o.applovin.com/campaign_management/v1/ad/ad_id

/ad/ad_id Sample Response Body

{
  "name":"Banner_AppIconSimple_MyTestCreativeSet0",
  "id":10780437,
  "creative_set_name":"My Test Creative Set 0",
  "creative_set_id":"37057c98a951078bf06b6d7c3561fd1a",
  "size":"BANNER",
  "status":true,
  "template":"App Icon Simple"
}

Table of /ad/ad_id Request/Response Body Fields

/ads/creative_set_id

Issue a GET request to this endpoint to view all ads associated with a creative set.

/ads/creative_set_id Target URL

https://o.applovin.com/campaign_management/v1/ads/creative_set_id

/ads/creative_set_id Sample Response Body

[
  {
    "name":"Banner_AppIconSimple_MyTestCreativeSet0",
    "id":10780437,
    "creative_set_name":"My Test Creative Set 0",
    "creative_set_id":"37057c98a951078bf06b6d7c3561fd1a",
    "size":"BANNER",
    "status":true,
    "template":"App Icon Simple"
  }
]

Table of Ad Object Fields

See the table of request/response fields from /ad/ad_id.

/creative_sets/campaign_id

Issue a GET request to this endpoint to view all creative sets associated with a campaign.

/creative_sets/campaign_id Target URL

https://o.applovin.com/campaign_management/v1/creative_sets/campaign_id

/creative_sets/campaign_id Sample Response Body

[
  {
    "campaign_id":"f87ece84f46b55cfbf24427ff8746a40",
    "name":"My Test Creative Set 0",
    "countries":["us","gb"],
    "languages":[
      "en"
    ],
    "ads":[…],
    "assets":[…],
    "product_page": null
  }
]

Table of /creative_sets/campaign_id Response Body Fields

See the table of request/response fields from /ad/ad_id.

/campaign_targets/campaign_id

Issue a GET request to this endpoint to view a campaign’s targeting, URLs, bids, and budgets.

Issue a POST request to this endpoint to update those attributes.

/campaign_targets/campaign_id Target URL

https://o.applovin.com/campaign_management/v1/campaign_targets/campaign_id

/campaign_targets/campaign_id Sample Response Body

{
  "bid_type": "CPI",
  "countries":[
    {
      "DEFAULT":{
        "click_url":"https://app.adjust.com/123abc?campaign={CAMPAIGN_NAME}%20({CAMPAIGN_ID})&adgroup={APP_ID}&creative={AD_NAME}&idfa={IDFA}&country={CC}&gps_adid={IDFA}&campaign_id={CAMPAIGN_ID}&device_type={DEVICE_TYPE}&publisher_id={APP_ID}&tracker_limit=100000&applovin_click_id={DID}&external_tracker_ids=1&android_id_lower_sha1={HADID}",
        "impression_url":"https://s2s.adjust.com/impression/123abc?campaign={CAMPAIGN_NAME}%20({CAMPAIGN_ID})&adgroup={APP_ID}&creative={AD_NAME}&idfa={IDFA}&country={CC}&gps_adid={IDFA}&campaign_id={CAMPAIGN_ID}&device_type={DEVICE_TYPE}&publisher_id={APP_ID}&tracker_limit=100000&applovin_click_id={DID}&external_tracker_ids=1&android_id_lower_sha1={HADID}&s2s=1"
      }
    },
    {
      "us":{
        "bid":2.9,
        "budget":300,
        "disabled":false
      }
    },
    {
      "gb":{
        "bid":2.5,
        "budget":250,
        "disabled":false
      }
    }
  ],
  "device_types":[
    "phone"
  ],
  "os_major_version_min":9
}

Table of /campaign_targets/campaign_id Request/Response Body Fields

Table of Fields for Countries Objects

The bid, budget, and URL values should either be in the DEFAULT object or in each country-specific object (i.e. the campaign either has a total budget shared by all countries, or each country needs a specific budget). A POST request to this endpoint will only update countries that are included. Targeted countries that are not included in the request will not be updated. To disable a country, set disabled to true.

/source_bids/campaign_id

Issue a GET request to this endpoint to view all the override app source bids of a campaign.

Issue a GET request to this endpoint with optional limit and offset query parameters to paginate through the override app source bids of a campaign.

Issue a POST request to this endpoint to update or add more source bid overrides.

/source_bids/campaign_id Target URLs

• https://o.applovin.com/campaign_management/v1/source_bids/campaign_id

• https://o.applovin.com/campaign_management/v1/source_bids/campaign_id?limit=xxxx&offset=yyyy

/source_bids/campaign_id Sample Response Body

[
 {
  "app_id": "da605e6f950f1aec838816df845e95e0c8d5cb7a994d71ae0ef2",
  "app_id_external": "f950f1aec838816df845e95e0c8da605e6",
  "bid_override_percentage": "default",
  "bid_value": "1.14",
  "country": "us",
 },
 {
  "app_id": "ecf49bef2a8026d53f7a3d245e890cc0b59b85c82c16c8d63bf4a5",
  "app_id_external": "50f1aec838816da605e6f9df845e95e0c8",
  "bid_override_percentage": "10",
  "bid_value": "default",
  "country": "ca",
 }
]

/source_bids/campaign_id?limit=2&offset=2000 Sample Response Body

[
 {
  "total row count": 8192,
  "offset": 2000,
  "limit": 2,
  "source_bids": [
   {
    "app_id": "da605e6f950flaec838816df845e95e0c8d5cb7a994d71ae0ef2",
    "app_id_external": "f950flaec838816df845e95e0c8da605e6",
    "bid_override_percentage": "default",
    "bid_value": "1.14",
    "country": "us",
   },{
    "app_id": "ecf49bef2a8026d53f7a3d245e890cc0b59b85c82c16c8d63bf4a5",
    "app_id_external": "50flaec838816da605e6f9df845e95e0c8",
    "bid_override_percentatage": "10",
    "bid_value": "default",
    "country": "ca",
   }
  ]
 }
]

Table of/source_bids/campaign_id Request/Response Body Fields

Table of /source_bids/campaign_id?limit=xxxx&offset=yyyy Response Body Fields

/sources/campaign_id

Issue a GET request to this endpoint to view the status of sources where a campaign is serving.

Issue a POST request to this endpoint to update the status of sources across a campaign.

/sources/campaign_id Target URLs

• https://o.applovin.com/campaign_management/v1/sources/campaign_id

• https://o.applovin.com/campaign_management/v1/sources/campaign_id?limit=xxxx&offset=yyyy

/sources/campaign_id Sample Response Body

[
  {
    "app_id": "da605e6f950f1aec838816df845e95e0c8d5cb7a994d71ae0ef2",
    "app_id_external": "3a2ccd1298a9eaa1a5de114c323c8b1d",
    "status": true
  },
  {
    "app_id": "ecf49bef2a8026d53f7a3d245e890cc0b59b85c82c16c8d63bf4a5",
    "app_id_external": "ca3cc7d0636891d98ee2267a34d5301e",
    "status": false
  }
]

/sources/campaign_id?limit=2&offset=2000 Sample Response Body

{
  "offset": 2000,
  "limit": 2,
  "sources": [
    {
      "app_id": "da605e6f950f1aec838816df845e95e0c8d5cb7a994d71ae0ef2",
      "app_id_external": "3a2ccd1298a9eaa1a5de114c323c8b1d",
      "status": true
    },
    {
      "app_id": "ecf49bef2a8026d53f7a3d245e890cc0b59b85c82c16c8d63bf4a5",
      "app_id_external": "ca3cc7d0636891d98ee2267a34d5301e",
      "status": false
    }
  ]
}

Table of /sources/campaign_id Request/Response Body Fields

Table of /sources/campaign_id?limit=xxxx&offset=yyyy Response Body Fields

Table of Tracking Methods

Language Codes

Asset Types

Templates