Audience API overview
Use the Tapjoy Offerwall Audience API to manage lists of devices that already have your app installed and prevent those users from receiving duplicate offers.
Read time 2 minutesLast updated 2 months ago
The Tapjoy Audience API is a REST API for creating and retrieving information about audiences that can be used for app suppression on a list of devices.
App suppression
App Suppression means the provided devices should be marked as having the associated App ID already installed. This information comes from outside our normal network/SDK data about a device. For example, an advertiser uploads a list of devices that they know already have the app installed. Tapjoy will 'suppress' the app offers, so that we do not show offers for this app to the users.Making requests
To make a API request you must first request an access token via our OAuth API. Details on how to do this are here.Required parameters and expected values
Required parameter | Expected value | Notes |
|---|---|---|
| The Advertiser account ID to authenticate the advertiser in the system. | |
| Name of the Audience. | |
| Description of the Audience. | |
| A CSV file of device IDs with no headers. | IDFA and GAID may be any case and may include hyphens; they are normalized on the backend. |
| The Tapjoy | |
| The Tapjoy | |
| List type indicating the request is for app suppression. | Allowed values: |
Note
The parameters listed (7 in total) are required for an API request, however, not all values need to be listed for each parameter in order to return a successful response from the API.
Also, each request is made against the same API endpoint.
Endpoint
All requests are made against the following endpoint.https://api.tapjoy.com/v4/audiences
Example requests
The following example shows the required headers for an authenticated API request.POST /v4/audiences Host: api.tapjoy.com Authorization: Bearer <token_string> Accept: application/json
App suppression
The following example shows the parameter values for an app suppression request.The following example shows the same request as a full curl command, including the device list file upload and query parameters.account_id: '497670f6-a152-4bdd-a717-dbe7f7635dc7' name: ' ' description: ' ' devices: device_list_3.csv offer_id: ' ' (blank for suppression lists)app_id: '6881899b-9c55-4d83-9afc-552f880289d4' list_type: 'app_suppression'
curl --header "Authorization: Bearer YOUR-TOKEN" --request POST --form devices=@/path/to/device_list.csv "https://api.tapjoy.com/v4/audiences?account_id=497670f6-a152-4bdd-a717-dbe7f7635dc7&app_id=6881899b-9c55-4d83-9afc-552f880289d4&description=LIST-DESCRIPTION&list_type=app_suppression&name=LIST-NAME&offer_id="
FAQ
As often as they want, (for example, 1hr).
There is a soft upper limit of 1 million devics. Contact engineering if you want to process more.
App Suppression - every device in the csv will be marked as having the specified app installed. Sending two lists has the effect of merging them.
App Suppression - No, when a device is marked as having the app installed there is no way to tell Tapjoy the user has uninstalled the app. If a partner wants to be able to remove devices, they should use a denylist.