Bulk Create Audiences With API

Vaida
Vaida
  • Updated

To streamline your audience creation, you can import a template with your entire taxonomy to Adform DMP, including both IAB taxonomy and custom categories. You can also export the imported files to update them and then import the taxonomy again. With this, you can ensure that your categories and audiences always are up to date.

Tip

For more information about creating taxonomies in bulk, see Manage Taxonomy.

With taxonomy import and export, you can create your audiences in bulk and prepare them to receive audience data. After you have your taxonomy available in Adform DMP, you can start onboarding data to populate your audiences.

With the Taxonomy section of the Data Management Platform API, you can import your own taxonomy to create your audiences, and export or delete the imported taxonomy files. With the Category, Segment, and Unified Taxonomy sections of the Data Management Platform API, you can retrieve the categories and audiences you already created, and standard IAB categories to use in your taxonomy.

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 bulk create 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.categories: Grants access to the Category section of the Data Management Platform API.

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

  • http://https://api.adform.com/scope/dmp.authenticated: Grants access to the Unified Taxonomy 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 bulk create audiences with API, use the following ID 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

Note

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

Workflow

You can bulk create all your categories and audiences with a single taxonomy import. If you already have a category and an audience created, you can retrieve them to include in your taxonomy file.

Tip

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

To bulk create audiences with API, use these endpoints:

  1. (Optional) GET endpoints in Category section of Data Management Platform API: To retrieve the existing custom categories to use in your taxonomy file.

  2. (Optional) GET endpoints in Segments section of Data Management Platform API: To retrieve the existing audiences to use in your taxonomy file.

  3. GET endpoint in UnifiedTaxonomy section of Data Management Platform API: To retrieve a list of IAB categories to use in your taxonomy file.

  4. Use this template to prepare your taxonomy file.

  5. POST endpoint in Taxonomy section of Data Management Platform API: To import your taxonomy file.

After you've created your audiences, you can continue onboarding audience data using API or through a server-to-server transfer.

Endpoints

[{"api":"Data Management Platform","titles":"Category, Segment, Taxonomy, UnifiedTaxonomy"}]

Was this article helpful?

/
How we can make it better?

Thank you for your feedback!