Common Ad Serving Macros | |
{adid} Expands to the DSP ad object ID that the macro is placed in. Requirements Must be included in ad HTML Expected Result Expands to the numeric value of the ad ID the macro is placed in. Implementation Example <a href="{clickprefix}https://smokeybear.com/en/prevention-how-tos/campfire-safety/how-to-maintain-and-extinguish-your-campfire?adid=\{adid}" target=_blank> <img src="https://c1.rfihub.net/creative/3709515_358974005835028403?adid={adid}&r={timestamp}" width="300" height="50"></a> |
|
{adinstanceid} Description Expands to a distinct alphanumeric string with each impression served. DSP collects Ad Instance IDs automatically, associating all tracked events with the Ad Instance ID the event tracker was served through - clicks, impressions, Video quartiles, etc. are all associated with an ad instance ID. This value is then used to deduplicate tracked events. Many ad platforms have functionally similar mechanisms that are referred to by different names. When passing this value in third-party HTML, we create a correlation point between third-party reporting and DSP reporting that enables use to better diagnosis anomalous activity. Requirements Must be placed in ad HTML Expected Result Expands to a distinct value Is query able in Hive in the adsarray on tables such as impressions, video_impressions, and clicks
Implementation Example <a href="{clickprefix}https://smokeybear.com/en/prevention-how-tos/campfire-safety/how-to-maintain-and-extinguish-your-campfire?adid=\{adinstanceid}" target=_blank> <img src="https://c1.rfihub.net/creative/3709515_358974005835028403?adid={adinstanceid}&r={timestamp}" width="300" height="50"></a> |
|
{advertiserid} Description Expands to the DSP account ID that an impression belongs to. Expected Result Expands to the numeric value of the associated DSP account Implementation Example <a href="{clickprefix}https://smokeybear.com/en/prevention-how-tos/campfire-safety/how-to-maintain-and-extinguish-your-campfire?advid=\{advertiserid}" target=_blank> <img src="https://c1.rfihub.net/creative/3709515_358974005835028403?advid={advertiserid}&r={timestamp}" width="300" height="50"></a> |
|
{adxuserid} Description Expands to the AdX User ID for the given user Requirements ADX inventory Expected Result Implementation Example <a href="{clickprefix}https://smokeybear.com/en/prevention-how-tos/campfire-safety/how-to-maintain-and-extinguish-your-campfire?adxid=\{adxuserid}" target=_blank> <img src="https://c1.rfihub.net/creative/3709515_358974005835028403?adxid={adxuserid}&r={timestamp}" width="300" height="50"></a> |
|
{anchorcode} Description A DSP click tracker intended for use in raw HTML that includes the "href" and "target" attributes for an anchor tag. Expected Result Expands to a value structured similar to the following when included in a key value pair: %20href=%22https://a.rfihub.com/ak/b/c3Q9aHRtbCZhYT0zNzI0MjU3LDExMTYzMDY5NywxNTIyNTYxLDg5NTc0MzA3LDEyNjgzNywxMDYwOTg1LDc1MGJhODI2MjQ1MGQ2M2EwMWQ3NDc0YjBkOWY5ZGIxLCUyMmh0dHBzJTNBJTJGJTJGc21va2V5YmVhci5jb20lMkZlbiUyRnByZXZlbnRpb24taG93LXRvcyUyRmNhbXBmaXJlLXNhZmV0eSUyRmhvdy10by1tYWludGFpbi1hbmQtZXh0aW5ndWlzaC15b3VyLWNhbXBmaXJlJTIyLDIzOTkyLDQyMjc3MSwzMjk5ODA3NywzMzg5NjksODM3MzY5Jm10PTEmcmI9MzA2JnJlPTMzMjU3JmhjaT0mdXVpZD03NzU1MzM5NDE5MjYxNDY0NjEmZGk9JmRjPTMmZGlzcmM9MCZiaXA9MTcyLjE2NC40MC4yMDQmZGlkPXRpZF8xMDYwOTg1fG1lZF9yZWd1bGFy%22%20target=_blank%20 Expands to a value structured similar to the following when included in raw HTML: href="http://a.rfihub.com/ak/b/c3Q9aHRtbCZhYT0zNzI1MDc5LDExMTY1OTA4NSwwLDAsMCwwLDEwNTU0MWNmZjhlMDhhMzkzMzQwZmM4YTgyZjYwN2Y2LCUyMmh0dHAlM0ElMkYlMkZyb2NrZXRmdWVsaW5jLmNvbSUyMiwyNjcyOCwwLDAsMCwwJm10PTEmcmI9NDQ1JnJlPWV4dGVybmFsQWRQcmV2aWV3JmhjaT0mdXVpZD04NDYwJmRpPSZkYz0zJmRpc3JjPTAmYmlwPTE3Mi4yMi40NC4xMzU." target=_blank Note that a blank space appears before the "href" in both of the above examples Implementation Intended for use in an HTML anchor tag. Example <a href="{clickprefix}https://smokeybear.com/en/prevention-how-tos/campfire-safety/how-to-maintain-and-extinguish-your-campfire?adxid=\{adxuserid}" target=_blank> <img src="https://c1.rfihub.net/creative/3709515_358974005835028403?adxid={adxuserid}&r={timestamp}" width="300" height="50"></a> |
|
{androidadvertisingid} Description Expands to the Google Advertising ID for mobile traffic viewed through an Android device Requirements: Mobile traffic Android device
Expected Result Implementation Example <a href="{clickprefix}https://smokeybear.com/en/prevention-how-tos/campfire-safety/how-to-maintain-and-extinguish-your-campfire?andid=\{adroidadvertisingid}" target=_blank> <img src="https://c1.rfihub.net/creative/3709515_358974005835028403?andid={adroidadvertisingid}&r={timestamp}" width="300" height="50"></a> |
|
{appId} Description When included in the ad HTML for an impression served to mobile app inventory, it expands to the mobile app's ID Requirements: Requires Mobile App inventory Expectation: Expands to a value structured similarly to "appid=876544448" when served to an iOS app. In this case the numeric value is the iOS app ID. A link to the app can be created by modifying the following Example 'HTTPS://itunes.apple.com/us/app/apple-store/id' + REPLACE_WITH_APP_ID + '?mt=8' Example: HTTPS://itunes.apple.com/us/app/apple-store/id876544448?mt=8 Expands to a value structured similarly to "com.cleaner.effic.clean" when served into an Android app. A link to the app on the Google Play store can be created by appending the value to a specific URL such as in the following example. If the link does not work, then the given app was likely removed or replaced from the Google Play store: https://play.google.com/store/apps/details?id=com.cleaner.effic.clean Implementation Example <a href="{clickprefix}https://smokeybear.com/en/prevention-how-tos/campfire-safety/how-to-maintain-and-extinguish-your-campfire?appid=\{appId}" target=_blank> <img src="https://c1.rfihub.net/creative/3709515_358974005835028403?appid={appId}&r={timestamp}" width="300" height="50"></a> |
|
{appnameandversion} Description Expands to a concatenation of mobile app name and version number Requirements: Requires mobile app inventory Expected Result Expands to values structured similarly to "GO-WEATHER-ANDROID-GO-WEATHER-ANDROID-300X250-4-ANDROID-MEDIUMRECTANGLE-300X250-IAB20" and "GO+KEYBOARD_3.26" Implementation Example <a href="{clickprefix}https://smokeybear.com/en/prevention-how-tos/campfire-safety/how-to-maintain-and-extinguish-your-campfire?appnandv=\{appnameandversion}" target=_blank> <img src="https://c1.rfihub.net/creative/3709515_358974005835028403?appnandv={appnameandversion}&r={timestamp}" width="300" height="50"></a> |
|
{cachebust} Description Expands to a randomly generated alphanumeric string of characters used for cache busting. When given the choice between this and {timestamp}, the use of {timestamp} is preferred. We reserve the use of {cachebust} for rare instances where we need to generate a second random string that will have a different value than {timestamp}. Expected Result Expands to a randomly generated alphanumeric string Implementation Example <a href="{clickprefix}https://smokeybear.com/en/prevention-how-tos/campfire-safety/how-to-maintain-and-extinguish-your-campfire?cb=\{cachebust}" target=_blank> <img src="https://c1.rfihub.net/creative/3709515_358974005835028403?cb={cachebust}" width="300" height="50"></a> |
|
{campaignid} Description Expands to the DSP Campaign ID the impression is associated with Requirements: To be included in the ad HTML Expected Result Expands to the numeric value for the DSP campaign ID that the impression was served through Implementation Example <a href="{clickprefix}https://smokeybear.com/en/prevention-how-tos/campfire-safety/how-to-maintain-and-extinguish-your-campfire?cid=\{campaignid}" target=_blank> <img src="https://c1.rfihub.net/creative/3709515_358974005835028403?cid={campaignid}&r={timestamp}" width="300" height="50"></a> |
|
{city} Description Expands to the Geo-IP 'city' value for the user viewing the impression, based on DSP's known Geo-IP information Requirements: Unknown Expected Result Expands to a value structured similarly to "Anchorage,%20Ak" Implementation Example <a href="{clickprefix}https://smokeybear.com/en/prevention-how-tos/campfire-safety/how-to-maintain-and-extinguish-your-campfire?city=\{city}" target=_blank> <img src="https://c1.rfihub.net/creative/3709515_358974005835028403?city={city}&r={timestamp}" width="300" height="50"></a> |
|
{clickprefix} Description A DSP click tracker intended for use in HTML Requirements Used where the {scriptclickprefix}, {noscriptclickprefix}, and {iFrameclickprefix} macros would not be appropriate Expected Result Expands to a click-string for the given ad Implementation Typically used to prefix the URL declared in the HREF on an anchor tag when that anchor tag does not sit in the noscript element of an ad tag. If used in third-party HTML, placement in that HTML should align with vendor requirements
Example <a href="{clickprefix}https://smokeybear.com/en/prevention-how-tos/campfire-safety/how-to-maintain-and-extinguish-your-campfire?" target=_blank> <img src="https://c1.rfihub.net/creative/3709515_358974005835028403?r={timestamp}" width="300" height="50"></a> |
|
{deliverychannel} Description Expands to a the numeric delivery channel ID that the impression was served to.
Expected Result Delivery channel IDs are mapped to delivery channel names/descriptions as follows: In DSP reporting, "Other" may appear as a delivery channel when the delivery channel used cannot be determined Implementation Example <a href="{clickprefix}https://smokeybear.com/en/prevention-how-tos/campfire-safety/how-to-maintain-and-extinguish-your-campfire?aiid=\{adinstanceid}&delch={deliverychannel}" target=_blank> <img src="https://c1.rfihub.net/creative/3709515_358974005835028403?r={timestamp}&aiid={adinstanceid}&delch={deliverychannel}" width="300" height="50"></a> | DELIVERY CHANNEL NAME |
{device} Description Expands to a value describing the user's device. Potential values include the following: IPOD KINDLE UNKNOWN WINDOWS_MOBILE IPHONE IPAD COMPUTER BLACKBERRY_TABLET ANDROID_TABLET ANDROID_MOBILE
Expected Result Implementation Example <a href="{clickprefix}https://smokeybear.com/en/prevention-how-tos/campfire-safety/how-to-maintain-and-extinguish-your-campfire?dv=\{device}" target=_blank> <img src="https://c1.rfihub.net/creative/3709515_358974005835028403?r={timestamp}&dev={device}" width="300" height="50"></a> | Mobile Web |
{deviceid} Description Functionally similar to {device}, this macro expands to a value describing the user's device. Potential values include the following: IPOD KINDLE UNKNOWN WINDOWS_MOBILE IPHONE IPAD COMPUTER BLACKBERRY_TABLET ANDROID_TABLET ANDROID_MOBILE
Expected Result Implementation Example <a href="{clickprefix}https://smokeybear.com/en/prevention-how-tos/campfire-safety/how-to-maintain-and-extinguish-your-campfire?dv=\{deviceid}" target=_blank> <img src="https://c1.rfihub.net/creative/3709515_358974005835028403?r={timestamp}&dev={deviceid}" width="300" height="50"></a> | Mobile App |
{domain} Description Expands to the domain the impression is served to. Anything contained in the URL after the top-level domain is truncated. Note that this is functionally different from the {site} macro. Expected Result Implementation Example <a href="{clickprefix}https://smokeybear.com/en/prevention-how-tos/campfire-safety/how-to-maintain-and-extinguish-your-campfire?aiid=\{adinstanceid}&domain={domain}" target=_blank> <img src="https://c1.rfihub.net/creative/3709515_358974005835028403?r={timestamp}&aiid={adinstanceid}&domain={domain}" width="300" height="50"></a> | Desktop |
{googleadvertisingid} Description Functionally similar to {androidadvertisingid}, this macro expands to the Google Advertising ID for mobile traffic viewed through an Android device Requirements: Mobile traffic Android device
Expected Result Implementation Example <a href="{clickprefix}https://smokeybear.com/en/prevention-how-tos/campfire-safety/how-to-maintain-and-extinguish-your-campfire?aid=\{googleadvertisingid}" target=_blank> <img src="https://c1.rfihub.net/creative/3709515_358974005835028403?r={timestamp}&aid={googleadvertisingid}" width="300" height="50"></a> |
|
{idfa} Description Expands to the IDFA for the iOS device the user views the impression on Requirements: Expected Result Expands to an alphanumeric string structured similarly to "72939E0D-059B-4D0D-A45D-73C809AEC362". Does not always expand for mobile traffic on Android devices. Implementation Place directly in the code of an ad tag so that the macro is visible in the ad HTML displayed in DSP Place in query strings contained in an ad tag expressed as a key value pair Example <a href="{clickprefix}https://smokeybear.com/en/prevention-how-tos/campfire-safety/how-to-maintain-and-extinguish-your-campfire?aid=\{idfa}" target=_blank> <img src="https://c1.rfihub.net/creative/3709515_358974005835028403?r={timestamp}&aid={idfa}" width="300" height="50"></a> |
|
{iFrameclickprefix} Description DSP click tracker intended for implementation in the iFrame element of an ad tag. This macro expands to a distinct click-string for the given ad in the /aci/ directory path of the rfihub.com domain. This click tracker is typically used as the first hop in the click-through URL when the iFrame element of an ad tag is clicked, redirecting the user to the click-through URL for the ad. If the iFrame is contained in the noscript element of an ad tag, this click macro would be used instead of the {noscriptclickprefix} macro. Example https://a.rfihub.com/aci/b/c3Q9aHRtbCZhYT0zMDc3MDQxLDEwNjQxOTk4MywwLDAsMCwwLDY4NWIxNWVmMjQ0MjY0MDg1OTFkOTJhYzBiYWQ2Njc4LHAsMjc0ODgsMCwwLDAsMCZtdD0xJnJiPTQ0NSZyZT1leHRlcm5hbEFkUHJldmlldyZoY2k9JnV1aWQ9MTk3NzQzMjA4MzQ5MzQ1MTMyOCZkaT0mZGM9MyZkaXNyYz0w/n/ Requirements: All ad objects are required to include at least one DSP click macro Expected Result When properly implemented on an ad, the firing of this tracker will be observable in diagnostic tools such as Fiddler Implementation Placed in the iFrame element of an ad tag Typically set in a key value pair however, placement is contingent upon the specific tag handling instructions provided by the third-party Ad Server
Example <iFrame src="https://bs.serving-sys.com/Serving/adServer.bs?c=28&cn=display&pli=1073961473&w=320&h=50&ord={timestamp}&ncu=$${iFrameclickprefix}$$&ifrm=2&z=0" width=320 height=50 marginwidth=0 marginheight=0 hspace=0 vspace=0frameborder=0 scrolling="no" bordercolor="#000000"></iFrame> |
|
{ispreview} Description This macro serves as a flag used most commonly with brand safety wrapped ads. When the ad containing this macro is served into a known preview environment, this macro expands to "1". Otherwise this macro expands to a blank or a "0". By expanding to a "1" and when implemented as described in HTML Ad Macros, the brand safety vendor will disable their blocking so that the ad can pass QA and audit. Vendors supporting this include IAS and DoubleVerify. Expected Result Expands to "1" when included in an ad served into a known preview environment. Example <script src="https://fw.adsafeprotected.com/rjss/bs.serving-sys.com/40701/5157818/BurstingPipe/adServer.bs? cn=rsb&c=28&pli=13372760&PluID=0&w=300&h=250&ord={timestamp}&ucm=true&ncu=$${scriptclickprefix}$$&adsafe_preview={ispreview}"></script> <noscript> <a href="{noscriptclickprefix}https://bs.serving-sys.com/BurstingPipe/adServer.bs?cn=brd&FlightID=13372760&Page=&PluID=0&Pos=1490397706" target="_blank"> <img src="https://fw.adsafeprotected.com/rfw/bs.serving-sys.com/40701/5157817/BurstingPipe/adServer.bs? cn=bsr&FlightID=13372760&Page=&PluID=0&Pos=1490397706&adsafe_preview={ispreview}" border=0 width=300 height=250></a> </noscript> |
|
{latitude} Description Requirements Expected Result In testing, approximately 10% of impressions served to mobile traffic saw this macro return latitude data Expands to nothing if data is not available May not work in Preview and test pages
Implementation Example <a href="{clickprefix}https://smokeybear.com/en/prevention-how-tos/campfire-safety/how-to-maintain-and-extinguish-your-campfire?lat=\{latitude}&long={longitude}&aiid={adinstanceid}" target=_blank> <img src="https://c1.rfihub.net/creative/3709515_358974005835028403?r={timestamp}&aiid={adinstanceid}" width="300" height="50"></a> |
|
{lineitemid} Description Expands to the DSP line-item ID that the impression is associated with. Requirements: Must be included in the ad HTML Expected Result Expands to the numeric ID for the DSP line-item that the impression is associated with Implementation Example <a href="{clickprefix}https://smokeybear.com/en/prevention-how-tos/campfire-safety/how-to-maintain-and-extinguish-your-campfire?liid=\{lineitemid}&aiid={adinstanceid}" target=_blank> <img src="https://c1.rfihub.net/creative/3709515_358974005835028403?liid={lineitemid}&r={timestamp}" width="300" height="50"></a> |
|
{longitude} Description The DSP {longitude} macro expands to current longitude of the user based on data provided by the user's device GPS and is typically paired with the {latitude} macro. Requirements: Only works on mobile traffic sharing their location with the inventory source Should be paired with the {latitude} macro Expected Result In testing, approximately 10% of impressions served to mobile traffic saw this macro return latitude data Expands to nothing if data is not available May not work in Preview and test pages Implementation Place directly in the code of an ad tag so that the macro is visible in the ad HTML displayed in DSP Place in query strings contained in an ad tag expressed as a key-value pair Example <a href="{clickprefix}https://smokeybear.com/en/prevention-how-tos/campfire-safety/how-to-maintain-and-extinguish-your-campfire?lat=\{latitude}&long={longitude}&aiid={adinstanceid}" target=_blank> <img src="https://c1.rfihub.net/creative/3709515_358974005835028403?r={timestamp}&aiid={adinstanceid}" width="300" height="50"></a> |
|
{noscriptclickprefix} Description DSP click tracker intended for implementation in the noscript element of an ad tag. This macro expands to a distinct click-string for the given ad in the /acn/ directory path of the rfihub.com domain. This click tracker is typically used as the first hop in the click-through URL when the noscript element of an ad tag is clicked, redirecting the user to the click-through URL for the ad. Example https://a.rfihub.com/acn/b/c3Q9aHRtbCZhYT0zMDc3MDQxLDEwNjQxOTk4MywwLDAsMCwwLDY4NWIxNWVmMjQ0MjY0MDg1OTFkOTJhYzBiYWQ2Njc4LHAsMjc0ODgsMCwwLDAsMCZtdD0xJnJiPTQ0NSZyZT1leHRlcm5hbEFkUHJldmlldyZoY2k9JnV1aWQ9MTk3NzQzMjA4MzQ5MzQ1MTMyOCZkaT0mZGM9MyZkaXNyYz0w/n/ Requirements: All ad objects are required to include at least one DSP click macro Expected Result When properly implemented on an ad, the firing of this tracker will be observable in diagnostic tools such as Fiddler Implementation Placed in the noscript element of an ad tag Typically set prefixing the URL declared in the HREF however, placement is contingent upon the specific tag handling instructions provided by the third-party Ad Server
Example <noscript> <a href="{noscriptclickprefix}http://bs.serving-sys.com/BurstingPipe/BannerRedirect.asp?FlightID=xxxxxx&Page=&PluID=0&Pos=9347?" target="_blank"> <img src="http://bs.serving-sys.com/BurstingPipe/BannerSource.asp?FlightID=xxxxxx&Page=&PluID=0&Pos=9347?"border=0 width=300 height=250></a> </noscript> |
|
{osversion} Description Expands to the version of the OS the user viewing the impression is using. The value this macro expands to does not include an indication of the OS name. Expected Result Expands to the numeric version number of the OS for the user's device. Values will be expressed similarly to "11.2" or "8" May expand to "UNKNOWN" if the OS version is not available Implementation Place directly in the code of an ad tag so that the macro is visible in the ad HTML displayed in DSP Place in query strings contained in an ad tag expressed as a key value pair Example <a href="{clickprefix}https://smokeybear.com/en/prevention-how-tos/campfire-safety/how-to-maintain-and-extinguish-your-campfire?&aiid=\{adinstanceid}&osv={osversion}" target=_blank> <img src="https://c1.rfihub.net/creative/3709515_358974005835028403?r={timestamp}&aiid={adinstanceid}&osv={osversion}" width="300" height="50"></a> |
|
{placementid} Requirements: Must be served in ad HTML Implementation Place directly in the code of an ad tag so that the macro is visible in the ad HTML displayed in DSP Place in query strings contained in an ad tag expressed as a key value pair Example <a href="{clickprefix}https://smokeybear.com/en/prevention-how-tos/campfire-safety/how-to-maintain-and-extinguish-your-campfire?plid=\{placementid}" target=_blank> <img src="https://c1.rfihub.net/creative/3709515_358974005835028403?plid={placementid}&r={timestamp}" width="300" height="50"></a> |
|
{publisherid} Description Expands to the DSP definer ID for the exchange/publisher that is the inventory source. Expected Result Should work in DSP external preview, Mobile AdTester App, and open auction inventory Implementation Typically set in a key-value pair contained in an ad tag. Can be set in the query string of HTML served through DSP including in Third-Party Pixels. Example <a href="{clickprefix}https://smokeybear.com/en/prevention-how-tos/campfire-safety/how-to-maintain-and-extinguish-your-campfire?&aiid=\{adinstanceid}&pubid={publisherid}" target=_blank> <img src="https://c1.rfihub.net/creative/3709515_358974005835028403?r={timestamp}&aiid={adinstanceid}&pubid={publisherid}" width="300" height="50"></a> |
|
{publishername} Description Expands to the name of the publisher serving as an inventory provider. For example, when served through the inventory provided through Smaato, this macro will expand to the value of "Smaato". Expected Result When properly implemented on an ad, this macro will expand to the exchange/publisher name Implementation Typically set in a key-value pair contained in an ad tag. Can be set in the query string of HTML served through DSP including in Third-Party Pixels. Example: <a href="{clickprefix}https://smokeybear.com/en/prevention-how-tos/campfire-safety/how-to-maintain-and-extinguish-your-campfire?lat=\{latitude}&long={longitude}&aiid={adinstanceid}&pubname={publishername}" target=_blank> <img src="https://c1.rfihub.net/creative/3709515_358974005835028403?r={timestamp}&aiid={adinstanceid}&pubname={publishername}" width="300" height="50"></a> |
|
{rawdeviceid} Description Functionally similar to {unifiedidfa}. If the user views the impression with an iOS device, it expands to the IDFA. If the user views the impressions with an Android device, it expands to the Google Advertising ID. Requirements: Mobile traffic Android or iOS device
Expected Result Expands to the IDFA if the impression is viewed on an iOS device Expands to the Google Advertising ID if the impression is viewed on an Android device Expands to blank if the impression is viewed on a desktop Not expected to function in DSP Preview
Implementation Example <a href="{clickprefix}https://smokeybear.com/en/prevention-how-tos/campfire-safety/how-to-maintain-and-extinguish-your-campfire?rdi=\{rawdeviceid}" target=_blank> <img src="https://c1.rfihub.net/creative/3709515_358974005835028403?rdi={rawdeviceid}&r={timestamp}" width="300" height="50"></a> |
|
{scriptclickprefix} Description DSP click tracker intended for implementation in the script element of an ad tag. This macro expands to a distinct click-string for the given ad in the /acs/ directory path on the rfihub.com domain. This click tracker is typically used as the first hop in the click-through URL when the script element of an ad tag is clicked, redirecting the user to the click-through URL for the ad. Example https://a.rfihub.com/acs/b/c3Q9aHRtbCZhYT0zMDc3MDQxLDEwNjQxOTk4MywwLDAsMCwwLDY4NWIxNWVmMjQ0MjY0MDg1OTFkOTJhYzBiYWQ2Njc4LHAsMjc0ODgsMCwwLDAsMCZtdD0xJnJiPTQ0NSZyZT1leHRlcm5hbEFkUHJldmlldyZoY2k9JnV1aWQ9MTk3NzQzMjA4MzQ5MzQ1MTMyOCZkaT0mZGM9MyZkaXNyYz0w/n/ Requirements: All ad objects are required to include at least one DSP click macro Expected Result When properly implemented on an ad, the firing of this tracker will be observable in diagnostic tools such as Fiddler Implementation Placed in the script element of an ad tag Typically set in a key value pair however, placement is contingent upon the specific tag handling instructions provided by the third-party Ad Server
Example <script src="http://bs.serving-sys.com/BurstingPipe/adServer.bs?cn=sb&c=17&pli=xxxxxx&PluID=0&w=300&h=250&ncu=$${scriptclickprefix}$$&ord={timestamp}&ucm=true"> </script> |
|
{sellingmemberid} Description Originally built to support integer data, this is the exchange provided ID for an inventory seller. Requirements: For use in Ad HTML Expected Result Will expand to a 1, 0, or -1 if either no value was passed by the exchange, or the value was masked by the exchange, or DSP failed to parse the value Will not function as expected when placed in the Extra HTML fields of an ad
Implementation Place directly in the code of an ad tag so that the macro is visible in the ad HTML displayed in DSP Place in query strings contained in an ad tag expressed as a key value pair Will not function if placed in the Extra HTML fields of an ad.
Example <a href="{clickprefix}https://smokeybear.com/en/prevention-how-tos/campfire-safety/how-to-maintain-and-extinguish-your-campfire?seller=\{sellingmemberid}" target=_blank> <img src="https://c1.rfihub.net/creative/3709515_358974005835028403?seller={sellingmemberid}&r={timestamp}" width="300" height="50"></a> |
|
{sha1androidadvertisingid} Description Functionally similar to {sha1googleadvertisingid}, {shadeviceid}, and {sha1androidid}. Expands to the SHA-1 encrypted Google Advertising ID for the Android device the user views the impression on. Requirements: Mobile traffic Android device Expected Result Additional information on SHA-1 cryptography can be found on WIkipedia. Implementation Place directly in the code of an ad tag so that the macro is visible in the ad HTML displayed in DSP Place in query strings contained in an ad tag expressed as a key value pair Example <a href="{clickprefix}https://smokeybear.com/en/prevention-how-tos/campfire-safety/how-to-maintain-and-extinguish-your-campfire?did=\{sha1androidadvertisingid}" target=_blank> <img src="https://c1.rfihub.net/creative/3709515_358974005835028403?did={sha1androidadvertisingid}&r={timestamp}" width="300" height="50"></a> |
|
{sha1androidid} Description Functionally similar to {sha1googleadvertisingid}, {shadeviceid}, and {sha1androidadvertisingid}. Expands to the SHA-1 encrypted Google Advertising ID for the Android device the user views the impression on. Requirements: Mobile traffic Android device Expected Result Additional information on SHA-1 cryptography can be found on WIkipedia. Implementation Place directly in the code of an ad tag so that the macro is visible in the ad HTML displayed in DSP Place in query strings contained in an ad tag expressed as a key value pair Example: <a href="{clickprefix}https://smokeybear.com/en/prevention-how-tos/campfire-safety/how-to-maintain-and-extinguish-your-campfire?did=\{sha1androidid}" target=_blank> <img src="https://c1.rfihub.net/creative/3709515_358974005835028403?did={sha1androidid}&r={timestamp}" width="300" height="50"></a> |
|
{sha1googleadvertisingid} Description Functionally similar to {sha1androidadvertisingid}, {shadeviceid}, and {sha1androidid}. Expands to the SHA-1 encrypted Google Advertising ID for the Android device the user views the impression on. Requirements: Mobile traffic Android device Expected Result Additional information on SHA-1 cryptography can be found on WIkipedia. Implementation Place directly in the code of an ad tag so that the macro is visible in the ad HTML displayed in DSP Place in query strings contained in an ad tag expressed as a key value pair Example <a href="{clickprefix}https://smokeybear.com/en/prevention-how-tos/campfire-safety/how-to-maintain-and-extinguish-your-campfire?did=\{sha1googleadvertisingid}" target=_blank> <img src="https://c1.rfihub.net/creative/3709515_358974005835028403?did={sha1googleadvertisingid}&r={timestamp}" width="300" height="50"></a> |
|
{sha1idfa} Description Functionally similar to {shadeviceid}. Expands to the SHA-1 encrypted IDFA for the iOS device the user views the impression on. Requirements: Mobile traffic iOS device Expected Result Additional information on SHA-1 cryptography can be found on WIkipedia. Implementation Place directly in the code of an ad tag so that the macro is visible in the ad HTML displayed in DSP Place in query strings contained in an ad tag expressed as a key value pair Example: <a href="{clickprefix}https://smokeybear.com/en/prevention-how-tos/campfire-safety/how-to-maintain-and-extinguish-your-campfire?did=\{sha1idfa}" target=_blank> <img src="https://c1.rfihub.net/creative/3709515_358974005835028403?did={sha1idfa}&r={timestamp}" width="300" height="50"></a> |
|
{shadeviceid} Description Functionally similar to {sha1androidadvertisingid}, {sha1androidadvertisingid}, and {sha1idfa}. Expands to the SHA-1 encrypted Google Advertising ID for the Android device or IDFA for the iOS device that the user views the impression on. Requirements: Mobile traffic Android or iOS device Expected Result Additional information on SHA-1 cryptography can be found on WIkipedia. Implementation Place directly in the code of an ad tag so that the macro is visible in the ad HTML displayed in DSP Place in query strings contained in an ad tag expressed as a key value pair Example <a href="{clickprefix}https://smokeybear.com/en/prevention-how-tos/campfire-safety/how-to-maintain-and-extinguish-your-campfire?did=\{shadeviceid}" target=_blank> <img src="https://c1.rfihub.net/creative/3709515_358974005835028403?did={shadeviceid}&r={timestamp}" width="300" height="50"></a> |
|
{site} Description Expands to the URL the impression is served to. Note that this is functionally different from the {domain} macro. Expected Result Will expand to the Google Safeframe URL that triggers the impression when the HTML is served into a Safeframe May expand to a value structured such as "http://mob.app.com.gau.go.launcherex.gowidget.weatherwidget" when served into an Android app. Removing "http://mob.app."from this value, a link to the app on the Google Play store can be created by appending the value to a specific URL such as in the following Example https://play.google.com/store/apps/details?id=com.gau.go.launcherex.gowidget.weatherwidget May expand to a value structured similarly to "http://mob.app.1172989802" when served into an iOS app. The numeric string contained in such values is the iOS app ID for the specific app the impression was served into. A link directly to the app can be assembled as as described in this Example 'HTTPS://itunes.apple.com/us/app/apple-store/id' + REPLACE_WITH_APP_ID + '?mt=8' Example: HTTPS://itunes.apple.com/us/app/apple-store/id1172989802?mt=8 Implementation Place directly in the code of an ad tag so that the macro is visible in the ad HTML displayed in DSP Place in query strings contained in an ad tag expressed as a key value pair Example <a href="{clickprefix}https://smokeybear.com/en/prevention-how-tos/campfire-safety/how-to-maintain-and-extinguish-your-campfire?aiid=\{adinstanceid}&site={site}" target=_blank> <img src="https://c1.rfihub.net/creative/3709515_358974005835028403?r={timestamp}&aiid={adinstanceid}&site={site}" width="300" height="50"></a> |
|
{state} Description Expands to the Geo-IP value for 'state' for the user viewing the impression provided DSP is aware of this value Expected Result Expands to the Geo-IP value for 'state' for the user viewing the impression. Values will be structured similarly to "Alaska" Implementation Place directly in the code of an ad tag so that the macro is visible in the ad HTML displayed in DSP Place in query strings contained in an ad tag expressed as a key value pair Example <a href="{clickprefix}https://smokeybear.com/en/prevention-how-tos/campfire-safety/how-to-maintain-and-extinguish-your-campfire?tid=\{state}" target=_blank> <img src="https://c1.rfihub.net/creative/3709515_358974005835028403?tid={state}&r={timestamp}" width="300" height="50"></a> |
|
{tacticid} Description Expands to the DSP Tactic ID that the impression is associated with Requirements: Must be served through the ad HTML Expected Result Expands to the numeric ID for the DSP Tactic that the impression was served through Implementation Place directly in the code of an ad tag so that the macro is visible in the ad HTML displayed in DSP Place in query strings contained in an ad tag expressed as a key value pair Example <a href="{clickprefix}https://smokeybear.com/en/prevention-how-tos/campfire-safety/how-to-maintain-and-extinguish-your-campfire?tid=\{tacticid}" target=_blank> <img src="https://c1.rfihub.net/creative/3709515_358974005835028403?tid={tacticid}&r={timestamp}" width="300" height="50"></a> |
|
{timestamp} Description Expands to a numeric value based on time. Used commonly for cachebusting Expected Result Will function when included in ad HTML Implementation Place directly in the code of an ad tag so that the macro is visible in the ad HTML displayed in DSP Place in query strings contained in an ad tag expressed as a key value pair Example <a href="{clickprefix}https://smokeybear.com/en/prevention-how-tos/campfire-safety/how-to-maintain-and-extinguish-your-campfire?" target=_blank> <img src="https://c1.rfihub.net/creative/3709515_358974005835028403?&r={timestamp}" width="300" height="50"></a> |
|
{unifiedidfa} Description Functionally similar to {rawdeviceid}. If the user views the impression with an iOS device, it expands to the IDFA. If the user views the impressions with an Android device, it expands to the Google Advertising ID. Requirements: Mobile traffic Android or iOS device
Expected Result Expands to the IDFA if the impression is viewed on an iOS device Expands to the Google Advertising ID if the impression is viewed on an Android device Expands to blank if the impression is viewed on desktop Not expected to function in DSP Preview
Implementation Place directly in the code of an ad tag so that the macro is visible in the ad HTML displayed in DSP Place in query strings contained in an ad tag expressed as a key value pair Example <a href="{clickprefix}https://smokeybear.com/en/prevention-how-tos/campfire-safety/how-to-maintain-and-extinguish-your-campfire?did=\{unifieddeviceid}" target=_blank> <img src="https://c1.rfihub.net/creative/3709515_358974005835028403?did={unifieddeviceid}&r={timestamp}" width="300" height="50"></a> |
|
{userid} Description Expands to the DSP user ID for the user who views the impression Expected Result Expands to the distinct user ID for the user viewing the impression Value will be structured similarly to "2950103812322216175" Implementation Place directly in the code of an ad tag so that the macro is visible in the ad HTML displayed in DSP Place in query strings contained in an ad tag expressed as a key value pair Example <a href="{clickprefix}https://smokeybear.com/en/prevention-how-tos/campfire-safety/how-to-maintain-and-extinguish-your-campfire?uid=\{userid}" target=_blank> <img src="https://c1.rfihub.net/creative/3709515_358974005835028403?uid={userid}&r={timestamp}" width="300" height="50"></a> |
|
{zipcode} Description Expands to the Geo-IP value for postal code for the user viewing the impression provided DSP is aware of the value. Expected Result Expands to a value structured similarly to "99504" Implementation Example <a href="{clickprefix}https://smokeybear.com/en/prevention-how-tos/campfire-safety/how-to-maintain-and-extinguish-your-campfire?zid=\{zipcode}" target=_blank> <img src="https://c1.rfihub.net/creative/3709515_358974005835028403?zid={zipcode}&r={timestamp}" width="300" height="50"></a> |
|