To populate your audience with unique user IDs, you can create complex rules to automate audience data collection, or you can manually upload third-party cookies, mobile advertising IDs (MAIDs), or first-party IDs. You can use the onboarded audience data to run quick tests with the audience. For example, you can test an audience with a new partner. You can also generate a report on a set of users from another system.
Tip
For more information about when and how to manually onboard audience data, see Manually Upload and Download Audiences.
Note
Clients may upload only audience data that has been lawfully collected and for which they have the necessary rights and permissions to process and share with Adform. Where required by applicable law, valid consent or other applicable legal requirements must be satisfied before audience data is onboarded. Use of the API remains subject to the Adform DMP Audience Policies and applicable contractual documentation.
Use the onboarded audience data to populate the audience that you've created. This means that when you're uploading the IDs, you must specify the audience where you want to onboard data.
With the Cookie section of the Data Management Platform API, you can upload audience data and assign it to a specific data provider and audience ID. You can also retrieve IDs from a specific audience.
Tip
You can automate the audience import process by establishing a server-to-server transfer.
Here are the guidelines for an effective audience data upload:
-
Upload the list of IDs in .csv format.
-
Upload a maximum of 4 files at a time. File size can't exceed 100 MB.
-
Use the following structure in every row of the uploaded file:
{ID}{tab_separator}{SegmentOwnerID1},{SegmentOwnerID2},{SegmentOwnerIDn} -
Specify at least one audience, but you may specify more. Every row in the file assigns a user ID, such as a cookie, mobile, or first-party ID, to one or more audiences. After uploading the file, the IDs are added to the specified audience.
-
Create one file for each type of ID. For example, have one file for Adform cookies, one for MAIDs, and another for first-party IDs. An audience may have different types of IDs in it.
Note
Importing third-party cookies requires an ID sync between the partner and Adform. For information about synchronizing IDs, contact DMP Support (dmp@adform.com).
To authenticate and use Adform APIs, your user account must have the necessary permissions and your OAuth client must have the required scopes assigned to it.
To onboard audience data, Adform DMP user account must have this permission assigned by the business account admin:
-
Manage DMP Entities
You also need the following scope assigned to your OAuth client by Adform Support (dmp@adform.com):
-
https://api.adform.com/scope/dmp.segments: Grants access to the Cookie and UserIdentityType sections of Data Management Platform API.
Tip
If you don't have an OAuth client yet, follow the procedure in Get Authentication Credentials for Adform APIs to register one.
To onboard audience data with API, use the following ID in your requests:
|
ID |
Used To |
Retrieve From |
|---|---|---|
|
|
Specify the data provider's account to which to upload the audience data |
DataProvider section in Data Management Platform API |
|
|
Specify the audience data type (Adform cookie, external cookie, advertising ID, or first-party ID) |
Provided as part of response body after (see step 1 in Workflow) |
Note
Additional IDs might be used, but the listed ones are required to pass a request.
To onboard the data, you must first create an audience. In the in the data upload file, you must then define the owner ID of that audience.
Tip
To learn how to use Adform APIs, read Guide to Using Adform APIs.
To onboard audience data with API, use this endpoint:
-
GET endpoint in UserIdentityType section of Data Management Platform API: To retrieve the list of possible audience data types.
-
POST endpoint in Cookie section of Data Management Platform API: To upload the file with audience data to a specific data provider.