Customize Tracking Points

Greta
Greta
  • Updated

Customize Name System Variables With API

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.

Authentication

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.

Prerequisites

To customize variable names with API, you must use the following ID in your requests:

ID

Used To

Retrieve From

trackingSetupId

Specify a campaign's site‑tracking setup

Tracking Variables API

Note

Additional IDs might be used, but the listed one is required to pass a request.

Workflow

Tip

To learn how to use Adform APIs, read the Guide to Using Adform APIs.

To customize variable names with API, use these endpoints:

  1. 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.

  2. 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.

Endpoints

[{"api":"Tracking Variables","titles":"Variable Names"}]

Pass Site-Tracking Variables to Third-Party Scripts With API

Site-tracking variables or macros are placeholders in the site-tracking code that you can use to pass information collected from Adform tracking points to third-party scripts. To start, you must decide on the macros that you want to use and define them in the code. Then they'll be replaced with specific data during the execution of the code. For example, you can use a macro for order ID to share conversion information with third-party pixels in Adform container tags.

Tip

For more information about site-tracking macros, see Overview of Supported Site-Tracking Macros.

Site-tracking macros can help you pass data to external tracking and analytics tools. This way, you can get insights into your user's profile and behavior on your website.

With the Macros Definitions section of the Tracking Variables API, you can see the range of macros that Adform provides for site tracking. To use the macros in your site-tracking code, you must add them manually when creating a tracking point.

Authentication

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 site-tracking macros, 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.

Prerequisites

To retrieve site-tracking macros with API, you must use the following ID in your requests:

ID

Used To

Retrieve From

trackingSetupId

Specify a campaign's site‑tracking setup

Tracking Variables API

Note

Additional IDs might be used, but the listed one is required to pass a request.

Workflow

Tip

To learn how to use Adform APIs, read the Guide to Using Adform APIs.

To pass site-tracking variables with API:

  1. GET endpoint in Macro definitions section of Tracking Variables API: To retrieve a list of macros that are available for the site-tracking setup.

  2. Use Adform platform to add the macros when you create a tracking point code.

    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.

Endpoints

[{"api":"Tracking Variables","titles":"Macros definitions"}]

macros
macros

Was this article helpful?

/
How can we make it better?

Thank you for your feedback!