跳转到内容

Suppression API

此内容尚不支持你的语言。

Version 1.1 / August 2024

Advertisers use the Suppression API to prevent existing app users from being targeted by a campaign for that app. The API supports enabling or disabling suppression for users. You can identify users using their IDFA on iOS or GAID on Android.

Request Format

Target URLs

Use this API by making an HTTP request to one of the following base URLs:

Authentication

This API requires that you include an API key as a query parameter (api_key) in the request:

https://api.applovin.com/suppressionApps?api_key=«management_key»
https://api.applovin.com/deleteSuppressionApps?api_key=«management_key»

You can find this Management Key in the Keys tab of your account page. If the Management Key is not visible, please open a ticket here and request one be generated for you.

Add Users

To add a list of users to the suppression list, make an HTTP POST request to:

https://api.applovin.com/suppressionApps?api_key=«management_key»&package_name=«package_name»

Delete Users

To remove a list of users from the suppression list, make an HTTP POST request to:

https://api.applovin.com/deleteSuppressionApps?api_key=«management_key»&package_name=«package_name»

Query Parameters

NameTypeDescriptionRequired
package_nameStringThe bundle ID (iOS) or package name (Android) of the appYes

Post Body

The API accepts a newline-separated list of IDs in a POST request:

TypeDescriptionRequired
List of StringsA newline-separated list of Apple’s IDFA or Android’s GAID; the IDs must be in UUID formatYes

Response Format

The response is JSON-formatted:

NameTypeDescription
num_valid_idsIntegerNumber of IDs successfully processed in this request
num_invalid_idsIntegerNumber of invalid advertising IDs in this request

Errors

This API indicates errors by returning HTTP status codes:

HTTP Response CodeDescription
200Success.
400The request was not formatted properly; it was missing data or had invalid data.
403Authentication failed. Check the validity of the API Key.
500Service Unavailable.

Example Requests

Example request to add users:

Terminal window
curl -X POST --data-binary @userIds.txt "https://api.applovin.com/suppressionApps?api_key=«management_key»&package_name=com.machinezone.gow"

Example request to delete users:

Terminal window
curl -X POST --data-binary @userIds.txt "https://api.applovin.com/deleteSuppressionApps?api_key=«management_key»&package_name=com.machinezone.gow"

Where the contents of the file userIds.txt are:

c77bbe4e-6a28-11e4-bcda-14109fdf9591
f601faf5-4a83-44d6-98ef-b67c24919d39

Example Response

{
"num_valid_ids": 2,
"num_invalid_ids": 0
}