Macro | Description |
[APP_BUNDLE] | Bundle ID of the app based on the value passed in the app_bundle parameter of the Publica endpoint For example:
samsung+tv+plus+123 |
[%APP_BUNDLE%] | Encoded Bundle ID of the app based on the value passed in the app_bundle parameter of the Publica endpoint For example: samsung%2Btv%2Bplus%2B123 |
[APP_DOMAIN] | Unique identifier for the app domain For example:
mygame.myapp.io |
[APP_NAME] | Name of the app based on the value passed in the app_name parameter of the Publica endpoint For example:
My Awesome App |
[%APP_NAME%] | Encoded name of the app For example:
My%20Awesome%20App |
[APP_STORE_URL] | App store URL For example:
https://www.samsung.com/us/appstore/app/G15147002586 |
[%APP_STORE_URL%] | Encoded app store URL For example:
https%3A%2F%2Fwww.samsung.com%2Fus%2Fappstore %2Fapp%2FG15147002586 |
[BUYERUID] | Buyer UID For example:
sample-buyeruid |
[CACHEBUSTER] | Random number For example:
512343819321832 |
[CHANNEL_LABEL_ID] | Comma-separated list of the channel label internal IDs in the channel settings For example:
123,456,789 |
[CONSENT] | GDPR consent string This dimension is based on the value passed in the consent parameter of the Publica endpoint. For example:
BOQ7WlgOQ7WlgABABwAAABJOACgACAAQABA |
[CONTENT_CAT] | Comma-separated list of IAB Categories See: OpenRTB, Section 5.1 For example:
IAB8,IAB12-3 |
[%CONTENT_CAT%] | Encoded version of Comma-separated list of IAB Categories See: OpenRTB, Section 5.1 For example: IAB8%2CIAB12-3 |
[CONTENT_CHANNEL] | Name of the channel For example:
Publica TV |
[%CONTENT_CHANNEL%] | Encoded name of the channel For example: Publica+TV |
[CONTENT_CONTEXT] | Type of content being used of consumed by the user in which an ad impression will appear Possible values: 1 : Video2 : Game3 : Music4 : Application5 : Text6 : Other7 : Unknown
|
[CONTENT_DIST_ID] | Unique identifier of the content distributor |
[%CONTENT_DIST_ID%] | Encoded version of unique identifier of the content distributor |
[CONTENT_DIST_NAME] | Content distributor name |
[%CONTENT_DIST_NAME%] | Encoded version of content distributor name |
[CONTENT_EPISODE] | Number of the episode For example:
34 |
[%CONTENT_GENRE%] | Encoded genre of the content For example:
Sports (URL encoded) |
[CONTENT_ID] | Unique identifier of the content For example:
123 |
[%CONTENT_ID%] | Unique identifier of the content For example:
123 |
[CONTENT_KEYWORDS] | Comma-separated keywords associated with the content For example:
tvshow,comedy |
[%CONTENT_KEYWORDS%] | Encoded version of comma-separated keywords associated with the content For example: tvshow%2Ccomedy |
[CONTENT_LANGUAGE] | Content language using ISO-639-1-alpha-2 For example:
fr |
[CONTENT_LENGTH] | Length of content in seconds For example:
342 |
[CONTENT_NETWORK] | Network name of the content |
[%CONTENT_NETWORK%] | Encoded version of network name of the content |
[CONTENT_PROD] | Type of content produced Possible values: 0 : Unknown1 : Professional Produced2 : Prosumer3 : User Generated (UGC)
See: OpenRTB Spec v2.5 - "5.13 Production Quality" |
[CONTENT_PRODUCER_ID] | Unique identifier of the content producer or originator |
[%CONTENT_PRODUCER_ID%] | Encoded version of the unique identifier of the content producer or originator |
[CONTENT_PRODUCER_NAME] | Encoded version of the name of the content producer or originator For example:
Warner Bros |
[%CONTENT_PRODUCER_NAME%] | Encoded version of the name of the content producer or originator For example: Warner+Bros |
[CONTENT_RATING] | Rating of the content For example:
MPAA |
[%CONTENT_RATING%] | Encoded version of the rating of the content For example:
MPAA |
[CONTENT_SEASON] | Season of the content For example:
Season 3 |
[%CONTENT_SEASON%] | Encoded version of the season of the content For example: Season+3 |
[%CONTENT_SERIES%] | Encoded series of the content For example:
My%20awesome%20show |
[%CONTENT_TITLE%] | Encoded title of the content For example:
Best%20Episode%20Ever |
[CONTENT_URL] | URL of the content, for buy-side contextualization or review
For example: sweetseries.com/show |
[%CONTENT_URL%] | URL of the content, for buy-side contextualization or review
For example: sweetseries.com%2Fshow |
[COPPA] | Indicates if the request is protected by the Children's Online Privacy Protection Act Possible values: |
[COUNTRY] | Three-letter country code of the user For example:
USA [CUSTOM_4] [CUSTOM_5] [CUSTOM_6]
USA
|
[CUSTOM_74] - [CUSTOM_818]
| Additional targeting parameters used to pass partner-specific information not captured by any other targeting parameter For example: If you have distribution markets that each have a unique market ID, you could pass the market ID in Custom 5 to determine which distribution markets are consuming your streams. |
[CUSTOM_TARGETING] | Returns the value in the custom_targeting parameter of the Publica endpoint. |
[DEVICE_LANGUAGE] | Device language For example:
fr |
[DEVICE_MAKE] | Device make For example:
Samsung |
[%DEVICE_MAKE%] | Encoded device make For example:
Samsung (URL encoded)endpoint. |
[DEVICE_MODELLANGUAGE] | Device modellanguage For example:
Tizen TV 2019 |
[%DEVICE_MODEL%] | Encoded device model For example:
Tizen%20TV%202019 |
fr
|
[DEVICE_OSMAKE] | Device operating systemmake For example:
Android Samsung |
[DEVICE%DEVICE_OS_VERSIONMAKE%] | Device operating system versionEncoded device make For example:
2.1 Samsung (URL encoded) |
[DEVICE_TYPEMODEL] | Device typemodel For example:
CONNECTED_Tizen TV 2019 |
[%DEVICE_TYPE%MODEL%] | Encoded device typemodel For example:
CONNECTED_TV Tizen%20TV%202019 |
[DID] User device ID In Publica, DID is synonymous with IDFA , IFA , and TIFA .DEVICE_OS] | Device operating system For example:
ddb9a00f-7806-9973-ba1f-9c4cb0c3c25c Android |
[DMADEVICE_OS_CODEVERSION] | (US only) Nielsen three-digital DMA codeDevice operating system version Anchor |
---|
| limited_ad_tracking | limited_ad_tracking | [LIMITED_AD_TRACKING]Indicates if a user has activated Limited Ad Tracking (LAT) or opted out of targeted advertising
This dimension is based on the value passed in the is_lat
parameter For example:
803
(Los Angeles)
[DNT] | See: [LIMITED_AD_TRACKING] |
[GDPR] | Indicates GDPR acceptance This dimension is based on the value passed in the gdpr parameter of the Publica endpoint. Possible values: 0 : GDPR does not apply1 : Impression is regulated by GDPR laws
|
[GENDER] | Gender Possible values: |
[GENRE_ID] | Gender ID |
[HEIGHT] | Device’s screen height (in px) For example:
1080 |
[HOUSE_ADS] | Indicator of whether or not house ads are included This macro returns the value in the house_ads parameter of the Publica endpoint. Possible values: |
[IFA_TYPE] | Device ID type For example:
rida |
[IP] | User IP address For example:
11.11.111.111 |
[%IP%] | Encoded user IP address For example:
1111%3Afcc8%3Aa012%3A1111%3A1111%3Ac896%3Ab7d5%3A6ca6 |
2.1
|
[DEVICE_TYPE] | Device type For example:
CONNECTED_TV |
[%DEVICE_TYPE%] | Encoded device type For example:
CONNECTED_TV |
[DID] | User device ID In Publica, DID is synonymous with IDFA , IFA , and TIFA . For example:
ddb9a00f-7806-9973-ba1f-9c4cb0c3c25c |
[DMA_CODE] | (US only) Nielsen three-digital DMA code For example:
803 (Los Angeles) |
[DNT] | See: [LIMITED_AD_TRACKING] |
[GDPR] | Indicates GDPR acceptance This dimension is based on the value passed in the gdpr parameter of the Publica endpoint. Possible values: 0 : GDPR does not apply1 : Impression is regulated by GDPR laws
|
[GENDER] | Gender Possible values: |
[GENRE_ID] | Gender ID |
[GPP] | GPP consent string For example:
DBABjw~CPXxRfAPXxRfAAfKABENB-CgAAAAAAAAAAYgAAAAAAAA~1YNN |
[GPP_SID] | Array of Section ID integers For example:
[1,2]
|
[HEIGHT] | Device’s screen height (in px) For example:
1080 |
[HOUSE_ADS] | Indicator of whether or not house ads are included This macro returns the value in the house_ads parameter of the Publica endpoint. Possible values: | [MAX_AD_DURATION] | Maximum length of an ad in seconds This value should be smaller than the pod duration.0 : User has NOT opted out targeting advertising1 : User has opted out of targeting advertising
|
[LIVESTREAM] | Indicator of whether or not content is livestream enabled Possible values: |
|
[IFA_TYPE] | Device ID type For example:
rida |
[IMPMULTIPLY] | Multiplier applied to an impression that accounts for several people watching the same digital out-of-home screen at the same time For example:
6 |
[IP] | User IP address For example:
11.11.111.111 |
[%IP%] | Encoded user IP address For example:
30 1111%3Afcc8%3Aa012%3A1111%3A1111%3Ac896%3Ab7d5%3A6ca6 |
[MAXBITRATEIRIS_ID] | Maximum allowed average kilobits per secondIris ID For example:8000 iris_18719437 |
[MINIRIS_AD_DURATIONCONTEXT] | Minimum length of an ad in secondsIris Context For example:6 ic_0755895, ic_4890138 |
[MINBITRATE] Minimum allowed average kilobits per secondLAT] | Latitude from -90.0 to +90.0, where negative is south For example:
10000 |
[%PAGE_URL%] | Encoded page URL For example:
https%3A%2F%2Fwww.samsung.com |
[POD_DURATION] | Length of the ad pod in seconds For example:
60 |
[POSITION] | Position For example:
0-7 (7=Fullscreen) |
[PREFERRED_LANGUAGE] | Preferred language For example:
fr |
[RIGHTS_HOLDER] | Rights holder |
[SCHAIN] | SCHAIN string value For example:
1.0,1!exchange1.com,1234,1,,, |
[SESSION_ID] | Unique identifier for the session For example:
123 |
[SITE_ID] | Unique identifier for the channel For example:
123 |
[SITE_NAME] | Returns the value in the site_name param |
[SLOT_COUNT] | Number of ad slots to fill for a pod For example:
3 |
[SSAI_ENABLED] | SSAI enabled For example:
1 |
[SSAI_VENDOR] | SSAI vendor |
[TARGETED_DEVICE] | Targeted device For example:
Samsung%20TV |
[TIMESTAMP] | Unix timestamp For example:
126345 |
[%UA%] | Encoded user agent For example:
Mozilla%2F5.0+%28SMART-TV%3B+Linux%3B+Tizen+4.0%29+AppleWebKit%2F538.1+ %28KHTML%2C+like+Gecko%29+Version%2F4.0+TV+ Safari%2F538.1 |
[US_PRIVACY] | US Privacy string for CCPA compliance This macro returns the value passed in the us_privacy parameter of the Publica endpoint. For example:
1--- |
[WIDTH] | Device’s screen width (in px) For example:
1920 |
[YOB] | User’s year of birth For example:
1997 |