Manage Audience Access Rights With API

Greta
Greta
  • Updated

If you want to share your audiences in the Audience Marketplace, audience access rights allow you to control the visibility of your audiences. You can set access rights to make your audiences available only to certain advertisers or publishers. You can also choose to share only certain parts of your taxonomy.

Tip

For guidelines on how to manage your audience access, see Distribute Your Data in Audience Marketplace.

You can apply audience access rights on the data provider (DMP account) level or for individual audiences. There's also an option to set restrictions based on a country and agency.

Note

Some DMP accounts don't have access to this functionality. For information, contact Adform Support (dmp@adform.com).

With the DataProviderDataUsagePermissions section of the Data Management Platform API, you can define data usage policies on the data provider level, while the SegmentDataUsagePermissions section helps to manage access for specific audiences. To define specific countries and agencies that can have access to your audiences, you also need to use Country and Agency sections of the Data Management Platform API.

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 manage audience access rights, 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.accountpermissions: Grants access to the SegmentDataUsagePermissions and DataProviderDataUsagePermissions sections of the Data Management Platform API.

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

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

Prerequisites

To manage audience access rights with API, use the following IDs in your requests:

ID

Used To

Retrieve From

dataProviderId

Specify the data provider for which you want to define audience access rights

DataProvider section in Data Management Platform API

segmentId

Specify the audiences for which you want to define access rights

Segment section in Data Management Platform API

Workflow

After you've created an audience, you can set audience access rights to make it available only to select advertisers or publishers.

Tip

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

To manage audience access rights with API, use these endpoints:

  1. (Optional) GET endpoints in Country section of Data Management Platform API: To retrieve the list of available countries.

  2. (Optional) GET endpoints in Agency section of Data Management Platform API: To retrieve the list of available agencies.

  3. PUT endpoint in DataProviderDataUsagePermissions section of Data Management Platform API: To define audience access rights on the data provider level.

  4. PUT endpoint in SegmentDataUsagePermissions section of Data Management Platform API: To define audience access rights on the audience level.

Endpoints

Tip

See examples of how to retrieve and update data usage policies for data providers and audiences in DMP Postman collection.

[{"api":"Data Management Platform","titles":"DataProviderDataUsagePermissions, SegmentDataUsagePermissions, Country, Agency"}]

Was this article helpful?

/
How we can make it better?

Thank you for your feedback!