Master data files stored on the Adform server contain raw data that your campaigns have collected from online transactions, such as clicks, impressions, events, and tracking points.
You can export the master data and metadata files from Adform and import them into your own business analytic tool to make your own calculations and dashboards. You can also provide the data to your stakeholders to help determine business decisions.
Note
Master data is available for an additional fee. For more information, please contact your Adform representative.
With the Master Data API, you can access a list of available master data files and download them.
When working with a master data file, keep in mind that:
-
Adform prepares files approximately every 60 minutes.
-
File sizes vary based on client specifics and can range from a few kilobytes to over one gigabyte.
-
Adform stores these files for 7 days, but can store files for up to 2 months for an extra charge.
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 retrieve master data, your Adform DSP or Ad Server user account must have the master data service enabled by your Adform representative.
You also need the following scope assigned to your OAuth client by Adform Support (technical@adform.com):
-
https://api.adform.com/scope/buyer.masterdata: Grants access to Master Data 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 retrieve master data with API, use the following IDs in your requests:
|
ID |
Used To |
Retrieve From |
|---|---|---|
|
|
Specify the ID of a specific master data file you want to retrieve |
Your Adform representative |
|
|
Specify the ID of a master data setup for your account. One agency can have multiple setup IDs. |
Your Adform Representative |
Note
Additional IDs might be used, but the listed ones are required to pass a request.
Tip
To learn how to use Adform APIs, read Guide to Using Adform APIs.
To retrieve master data with API, use this endpoint:
-
GET endpoints in Master Data API: To retrieve master data files.