Adform has a list of variables that you can include in your site-tracking code to pass additional information, such as user login status or search term used. You have the option to change the default names of these variables to better reflect the data that they track.
Tip
For more information about site-tracking variables, see Use Name System Variables.
Customizing variable names can help you match your company's or analytics platform's naming rules. This will make it easier to report on and analyze site-tracking data.
With the Variable Names section of the Tracking Variables API, you can change the pre-defined names of the variables used in your tracking point code.
Note
The variable name change only applies to reports. You'll still see the pre-defined variable names in your tracking point code.
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 customize variable names, 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/eapi: Grants access to Tracking Variables API.
Note
If you don't have an OAuth client yet, follow the procedure in Get Authentication Credentials for Adform APIs to register one.
To customize variable names with API, you must use the following ID in your requests:
|
ID |
Used To |
Retrieve From |
|---|---|---|
|
|
Specify a campaign's site‑tracking setup |
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 customize variable names with API, use these endpoints:
-
GET endpoint in Variable Names section of Tracking Variables API: To retrieve a list of variables that are available for the provided site-tracking setup.
-
PUT endpoint in Variable Names section of Tracking Variables API: To change the name of a specific variable.
After you change the variable name, you'll be able to see the new name in your site-tracking reports.