When you create a tracking point in Adform platform, you need to retrieve a tracking setup ID to assign the new tracking point to it. A tracking setup ID specifies the account to which the collected site-tracking data should be sent.
You must use the tracking setup ID when setting up site tracking with any of the available tracking methods, including server-side tracking, mobile app tracking on Adform platform or with Adform partners, or client-side tracking.
Tip
For more information about site-tracking settings, see Configure Site Tracking per Advertiser.
In Adform, your tracking setup can be shared, local, or custom. You need to use Tracking Mappings API to get the correct tracking setup ID for your advertiser.
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 your tracking setup ID, Adform DSP and Ad Server user account must have this permission assigned by the business account admin:
-
Manage Site Tracking
You also need the following scope assigned to your OAuth client by Adform Support (technical@adform.com):
-
https://api.adform.com/scope/tracking.advertisertracking.readonly: Grants access to Tracking Mappings 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 a tracking setup ID with API, you must use the following ID in your requests:
|
ID |
Used To |
Retrieve From |
|---|---|---|
|
|
Specify the advertiser of the tracking setup you want to retrieve |
Note
Additional IDs might be used, but the listed one is required to pass a request.
Tip
To learn how to use Adform APIs, read Guide to Using Adform APIs.
To retrieve a tracking setup ID with API and use it to implement your tracking point:
-
GET endpoint in Tracking Mappings API: To retrieve the tracking setup ID of a particular advertiser.
-
Enter the tracking setup ID in your tracking point code, when you implement it on the website.
Note
Currently, it's not possible to create tracking points with Adform APIs. Tracking points are dynamically created once a tracking script is implemented on the advertisers website. To create tracking points upfront, use Adform platform , server-side tracking, or contact Adform Support (support@adform.com) for help.