With destinations, you can set up and manage audience data exports to external platforms, such as DSPs or DMPs. To set up a destination, you need to define its destination platform (route) and the criteria that determine which audiences to export (rule).
Tip
For more information about building routes and rules for destinations, see Manage Destinations.
Note
Destination configurations should be used only for partners that are authorized to receive the relevant audience data. Clients remain responsible for ensuring that data exports comply with applicable contractual obligations, Adform policies, and privacy laws, including any requirements relating to transparency and consent where applicable.
Setting up destinations can help you automate audience sharing and ensure that any updates to your audiences are sent to the audience receivers. You can also protect your audience data's value by only sharing it with your selected platforms and data partners.
With the Route section of the Data Management Platform API, you can create destinations for your audience exports and retrieve, update, and delete your existing destinations. With the Rule section of the Data Management Platform API, you can create and manage all your audience export rules.
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 manage destinations, Adform DMP user account must have this permission assigned by the business account admin:
-
Manage DMP Entities
Depending on your objectives and workflow, you'll need some or all of the following scopes assigned to your OAuth client by Adform Support (dmp@adform.com):
-
https://api.adform.com/scope/dmp.destinations: Grants access to the Destination, Route, and Rule sections of the Data Management Platform API. -
https://api.adform.com/scope/dmp.segments: Grants access to the Segment section of the 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 manage destinations with API, use the following IDs in your requests:
|
ID |
Used To |
Retrieve From |
|---|---|---|
|
|
Specify the data provider account to which the audience belongs |
DataProvider section in Data Management Platform API |
|
|
Specify the platform with which to build the destination setup |
Provided as part of response body after retrieving destinations (see step 1 in Workflow) |
|
|
Specify the destination to which to export audiences |
Provided as part of response body after creating a route (see step 2 in Workflow) |
|
|
Specify the audience to export |
Provided as part of response body after retrieving an audience (see step 3 in Workflow) |
Note
Additional IDs might be used, but the listed ones are required to pass a request.
After you have created audiences, you can define the rules for when to export them and the routes where to export them.
Tip
To learn how to use Adform APIs, read Guide to Using Adform APIs.
To manage destinations with API, use these endpoints:
-
(Optional) GET endpoints in Destination section of Data Management API: To retrieve a list of destination platforms available for audience export.
-
POST endpoint in Route section of Data Management API: To set up a route with a destination platform for your audience export.
-
(Optional) GET endpoints in Segments section of Data Management Platform API: To retrieve audiences to set up for export.
-
POST endpoint in Rule section of Data Management API: To create a rule for when to export an audience and to assign your audience to it.
After you've added your destination setup, you can update it as needed using the PUT endpoints in the Route and Rule sections of the Data Management Platform API.
[{"api":"Data Management Platform","titles":"Destination, Segment, Route, Rule"}]