Audiences—import an audience

Prerequisites

Prepare a CSV file with the following format and schema:

• One column
• No heading row
• No blank rows
• Rows contain a single advertising ID
• Maximum number of rows: 10 million.
• If you prepare the file using Excel, save it as a CSV (Comma delimited) (*.csv) file. Select the file type as shown in the figure that follows.

  

Example CSV file: Example_advertising_ID.csv

To upload the audience CSV file: 

1. Go to Integration > Audiences.
   The Audiences window opens.

2. Click Add Audience.
   The Audience window opens. The Build tab is displayed.

3. Enter a unique Audience Name.

4. Select the audience platform: Android or iOS.

5. Select Import Audience.
6. If it's a new audience:
   • Enter an Audience Name.
   • Click Save.
7. Click CSV Upload.
8. Choose what to do with the imported audience:
   • Add new devices: adds the list of device ids to the existing audience
   • Overwrite all existing devices: replace the entire audience with the uploaded list
   • Exclude from existing device list: remove devices in the upload list from the audience.
9. Chose the CSV file to upload.
10. Click Upload. 
    Wait for the confirmation message Uploaded successfully.
11. Click Save Audience and Proceed.
12. Select a partner to select to.
13. If necessary, follow the instructions connect to partners
14. Click Close.
    The list is not immediately available. Lists are processed with a data freshness of Daily

The import audience API is used to either add or remove devices from an audience. The API has the structure shown in the example. Use the procedure that follows to generate the API request URL and the API request body.

API request URL

https://hq1.appsflyer.com/audiences-import-api/{action}?api_token={api_token}

API request body

{
 "import_key": "{mport_key}",
 "platform": "{plaform}",
 "devices": [
             "{device}",
             "{device2}",
             "{devicen}"
            ]
}

 Before you begin:

• Ensure that you have created the audience in AppsFlyer.

To prepare an API request URL:

1. Go to Integration > Audiences.
   The Audiences window opens.

2. Click Add Audience.
   The Audience window opens. The Build tab is displayed.

3. Enter a unique Audience Name.

4. Select the audience platform: Android or iOS.

5. Select Import Audience.
6. Click API.
7. Select API Action: 
   • Add Devices: add additional device advertising IDs to an existing audience. 
   • Remove Devices: Remove a list of device advertising IDs from an existing audience.
     Note: Choosing an API Action changes the endpoint path referenced. It doesn't persist after you save the audience. When you want to add or remove devices from an audience, you can specify the action using the necessary path. 
8. Copy the API Request URL: the API token is already included in the URL.
9. Copy the API Request Body.
10. Click Save Audience and Proceed.
11. (optional) Connect your audience to partners.
12. Prepare the API including the device IDs and post the API to AppsFlyer as shown in the example above. 

Sample request to add devices

HTTP POST 
https://hq1.appsflyer.com/audience-import-api?api_token=
Accept: application/json
Content-Type: application/json
body: {
     "import_key": "EKFH2UMC5PPCU8J7M5QQCBPKIH89E6NCOB7XQFWMC",
     "platform": "android", 
     "devices": [
      "a23416b8-a21a-4051-a62f-5d3cb85e16ed",
      "09a14a6b-cce8-44f3-8f77-62eff8b5aa4f",
      "289da41f-0473-4977-89ae-8fc92234a921"
     ]
}

API limitations

• You can only add devices to one audience per request
• You can only remove devices from one audience per request
• Batch requests (multiple audiences) are not supported
• You can send up to 10,000 device IDs per request