Build Complex Audiences With API

Vaida
Vaida
  • Updated

After creating an audience, you can add complex rules for the data sources that you want to collect user information from. Using audience building rules, you can define the criteria a unique user ID (UUID) has to meet to be added to an audience, in this way creating unique and effective target audiences for your campaigns.

Tip

For more information about defining criteria for building audiences, see Build Audiences.

Note

When creating audiences, clients should ensure that the underlying data has been lawfully collected and may be used for the intended purpose. Audience creation involving demographic information, geolocation, behavioral targeting, or similar attributes should comply with applicable privacy laws, contractual restrictions, and Adform policies, including any restrictions relating to sensitive categories of personal data.

You can define building segmentation rules to fit the specific needs of your campaign. For example, you can narrow down an audience by demographics or geolocation, or retarget visitors who have shown interest in a specific product but haven't purchased it yet.

Important

You need specific access to use the audience builder. For more information, contact DMP Support (dmp@adform.com).

With the Segmentation Rule section of the Data Management Platform API, you can create new audience building rules and retrieve, update, or delete existing rules.

Authentication

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 build complex audiences, Adform DMP user account must have this permission assigned by the business account admin:

  • Manage DMP Entities

You also need the following scopes assigned to your OAuth client by Adform Support (dmp@adform.com):

  • https://api.adform.com/scope/dmp.segments: Grants access to the Segment section of the Data Management Platform API.

  • https://api.adform.com/scope/dmp.segmentbuilder: Grants access to the Segmentation Rule 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.

Prerequisites

To build complex audiences with API, use the following IDs in your requests:

ID

Used To

Retrieve From

dataProviderId

Specify the data provider account to which the audience belongs

DataProvider section in Data Management Platform API

segmentId

Specify the audience to assign audience segmentation rules to

Provided as part of response body after retrieving an audience (see step 1 in Workflow)

Note

Additional IDs might be used, but the listed ones are required to pass a request.

Workflow

After you've created an audience, you can add audience building rules to build complex audiences.

Tip

To learn how to use Adform APIs, read Guide to Using Adform APIs.

To build complex audiences with API, use these endpoints:

  1. GET endpoints in Segments section of Data Management Platform API: To retrieve audiences to assign audience building rules to.

  2. POST endpoint in Segmentation Rule section of Data Management Platform API: To create a building rule for the audience.

After you've added a building rule to your audience, your DMP account will start to populate that audience with unique user IDs matching that rule. You can then create additional rules and target that audience in your programmatic line items or share it with advertisers.

Endpoints

[{"api":"Data Management Platform","titles":"Segment, SegmentationRule"}]

Was this article helpful?

/
How we can make it better?

Thank you for your feedback!