Access rights control the visibility of segments (audiences) for advertisers in the Audience Marketplace. Advertisers can set audience access rights to share data with other advertisers or publishers. Data providers can set the access rights to share certain parts of the taxonomy or audiences only with individual advertisers in the marketplace. Access rights can be applied at the data provider (DMP account) level or for individual segments. 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).
The Data Management Platform API provides four sections to help manage audience access rights:
-
DataProviderDataUsagePermissions: Retrieve and update data usage policies at the data provider level.
-
SegmentDataUsagePermissions: Retrieve and update data usage policies for specific audiences.
-
Country: Retrieve a list of all available countries or list them by data provider ID.
-
Agency: Retrieve a list of all available agencies or list them by agency ID and data provider ID.
Note
Use country, agency, and advertiser IDs in the DataProviderDataUsagePermissions and SegmentDataUsagePermissions sections of the Data Management Platform API.
To start working with audience access-related API sections, you need:
-
Adform DMP user account that has these permissions assigned:
-
Manage DMP Entities
-
-
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 and some endpoints in Agency and Country sections of the Data Management Platform API.
-
https://api.adform.com/scope/dmp.accountpermissions.readonly: Grants read-only access to the SegmentDataUsagePermissions and DataProviderDataUsagePermissions sections and some endpoints in Agency and Country sections of the Data Management Platform API.
-
https://api.adform.com/scope/dmp.agencies.readonly: Grants read-only access to some endpoints in the Agency section of the Data Management Platform API.
-
https://api.adform.com/scope/dmp.athenticated: Grants read-only access to some endpoints in the Country section of the Data Management Platform API.
-
-
The following IDs to use in your requests:
Note
Additional IDs might be used, but the listed ones are required to pass a request.
Note
If you don't have an OAuth client yet, follow the procedure in Get Authentication Credentials for Adform APIs to register one.
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":"DataProvider, DataProviderDataUsagePermissions, SegmentDataUsagePermissions, Country, Agency"}]