A macro is a placeholder that can be replaced with specific data depending on the context during the execution of the code. For a macro to be replaced, you must define it. You can add site-tracking macros to tracking codes to help pass information collected from Adform tracking points to third-party scripts. For example, use a macro for order ID to share conversion information with the third-party pixels implemented in Adform container tags.
With the Macros Definitions section of the Tracking Variables API, you can see the range of macros that Adform provides for site tracking.
To retrieve a list of defined macros for your campaign's site tracking setup, you need the tracking setup ID of the campaign to use in your requests.
Note
For more information, see Overview of Supported Site-Tracking Macros.
To start working with Tracking Variables API, you need:
-
Adform DSP or Ad Server user account that has these permissions assigned:
-
Manage Site Tracking
-
-
The following scopes assigned to your OAuth client by Adform Support (technical@adform.com):
-
https://api.adform.com/scope/eapi: Grants full access to all endpoints of the Tracking Variables API.
-
-
The following ID 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.