Tracking Macros

Click Link (Destination URL) Macros

Click link macros can be used to insert dynamic data into your click link. You should use this if you want to:

  • Send data from SiteScout RTB to your own tracking software.
  • Give each creative in your campaign a unique click link.
  • Send data from SiteScout RTB to your landing page.

To measure conversions/goals/revenue on the DSP itself, read our Conversion Tracking guide.

List of Macros

The following macros can be used in destination click URLs or impression tracker URLs.

Macro

Explanation

{adId}

Passes the unique ID # of the ad for the impression/click.

{appId}

Passes a numeric ID (for Apple) or bundle name (for Google) specific to the mobile app responsible for generating the click. Example values: “383763″ (Apple) or “com.google.mygoogleapp” (Google) (mobile only)

{appType}

Passes a string that outputs the origin or type of application responsible for the click. Example values: “APP_STORE” (Apple) or “PLAY_STORE” (Google) (mobile only)

{campaignId}

Passes the unique ID # of the campaign for the impression/click.

{campaignName}

Passes the name of the campaign, URL encoded.

{campaignGroupId}

Passes the unique ID # of the group for the impression/click.

{campaignGroupName}

Passes the name of the group, URL encoded.

{carrier}

Passes the name of the mobile carrier for the impression/click. (mobile only)

{contextualIds}

Passes a comma-separated list of contextual segment IDs that were matched for the impression.

{demographicIds}

Passes a comma-separated list of data segment IDs that were matched for the impression.

{device}

Passes the name of the device for the impression/click. (mobile only)

{dimensions}

Size of the ad unit as a string, i.e. “300x250”.

{domain}

Passes the domain name for the impression/click.

{googleAdvertisingId}

Unhashed Google Advertising ID, when available. (mobile only, only impressions from Android devices)

{hashedAndroidId}

SHA1 hashed Android ID, when available. (mobile only, only available on some Android impressions, deprecated)

{hashedGoogleAdvertisingId}

SH1 hashed Google Advertising ID, when available. (mobile only, only impressions from Android devices)

{hashedIdfa}

SHA1 hashed Apple IDFA, when available. (mobile only, only impressions from Apple devices)

{hashedIfa}

SHA1 hash of mobile advertising identifier (IFA), when available. (mobile only)

{idfa}

Unhashed Apple IDFA, when available. (mobile only, only impressions from Apple devices)

{ifa}

Unhashed mobile advertising identifier (IFA) – specifically, Google Advertising ID or iOS IDFA, when available. Could also contain other advertising identifiers in future such as Windows Advertising ID. (mobile only)

{networkId}

Passes the unique ID # of the exchange for the impression/click.

{pagePosition}

Page position of the ad (i.e. "aboveTheFold", "belowTheFold", "Unknown")

{pageUrl}

When used in a destination click URL or impression tracker URL, it passes only the domain name to prevent the chance of generating URL that is too long and fails to function.

{postbackId}

Passes a unique identifier representing the current click/impression. This is used to attribute conversions when postback (server to server, S2S) conversions are used. Only processed by click server. 

{publisherId}

Passes the ID of the publisher (where supported by exchanges)

{siteId}

Passes the unique ID # of the site for the impression/click.

{trafficType}

Traffic type (i.e. "MOBILE_WEB", "WEB", "MOBILE_APP", etc.)

(Note: All macros are currently case-sensitive!)

Here are a few examples of how these macros can be used in your campaign. A common use of macros in destination click URLs is to pass information to Google Analytics, so these examples assume Google Analytics is installed on the destination site. Google Analytics documentation explains in more detail how Google Analytics can receive parameters in the click URL.

Here are a few examples of how these macros can be used in your campaign:

Example 1: Send the Creative ID as a variable

http://www.myclicklink.com/?ad={adId}

In this example, your link will be different for each banner/creative that is served, which allows you to track the individual performance of each creative by enabling you to attribute conversions after someone has clicked on your ad. If you have 3 banners in your campaign with ID #s 123, 345 and 567 respectively you will end up with 3 different click links depending on which banner is served:

Banner A: http://www.myclicklink.com/?ad=123
Banner B: http://www.myclicklink.com/?ad=345
Banner C: http://www.myclicklink.com/?ad=567

Example 2: Send the Site ID as a variable

http://www.myclicklink.com/?site={siteId}

In this example your link will be different for each site that your campaign is served on. If you are serving on www.site1.com (ID 1-123), www.site2.com (ID 2-543) and www.site3.com (ID 3-876) you will end up with 3 different click links depending on which site the campaign was served:

www.site1.com: http://www.myclicklink.com/?site=1-123
www.site2.com: http://www.myclicklink.com/?site=2-543
www.site3.com: http://www.myclicklink.com/?site=3-876

Example 3: Create a unique destination URL for each banner

http://www.myclicklink.com/somepage.html?site={siteId}&adid={adId}&campaignId={campaignId}

Get creative with click link macros to control the data and behavior behind your campaign traffic. In this example, the traffic is being sent to an HTML page that has the same name as the creative ID. This will allow you to have a different destination for each banner/creative in your campaign. In order to do this you first need to look at the ID #s of your creatives and then create HTML pages to match those IDs.

At the same time, this click URL is also sending siteId as an argument so it can be recorded as data.

The final URL might look like this:

http://www.myclicklink.com/somepage.html?site=1-123&adid=1234&campaignid=43211

Have more questions? Submit a request