Supported Macros Reference

Macro

Description

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

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

Unique identifier for the app domain

For example: 
mygame.myapp.io

Name of the app based on the value passed in the app_name parameter of the Publica endpoint

For example: 
My Awesome App

Encoded name of the app

For example: 
My%20Awesome%20App

App store URL

For example: 
https://www.samsung.com/us/appstore/app/G15147002586

Buyer UID

For example:
sample-buyeruid

Random number

For example:
512343819321832

Comma-separated list of the channel label internal IDs in the channel settings

For example:
123,456,789

GDPR consent string

This dimension is based on the value passed in the consent parameter of the Publica endpoint.

For example:
BOQ7WlgOQ7WlgABABwAAABJOACgACAAQABA

Comma-separated list of IAB Categories

See: OpenRTB, Section 5.1

For example:
IAB8,IAB12-3

Encoded version of Comma-separated list of IAB Categories

See: OpenRTB, Section 5.1

For example:
IAB8%2CIAB12-3

Name of the channel

For example:
Publica TV

Encoded name of the channel

For example:

Publica+TV

Type of content being used of consumed by the user in which an ad impression will appear

Possible values:

• 1: Video
• 2: Game
• 3: Music
• 4: Application
• 5: Text
• 6: Other
• 7: Unknown

Number of the episode

For example:
34

Encoded genre of the content

For example:
Sports (URL encoded)

Unique identifier of the content

For example:
123

Unique identifier of the content

For example:
123

Comma-separated keywords associated with the content

For example:
tvshow,comedy

Encoded version of comma-separated keywords associated with the content

For example:

tvshow%2Ccomedy

Content language using ISO-639-1-alpha-2

For example:
fr

Length of content in seconds

For example:
342

Type of content produced

Possible values:

• 0: Unknown
• 1: Professional Produced
• 2: Prosumer
• 3: User Generated (UGC)

See: OpenRTB Spec v2.5 - "5.13 Production Quality"

Encoded version of the name of the content producer or originator

For example:
Warner Bros

Encoded version of the name of the content producer or originator

For example:

Warner+Bros

Rating of the content

For example:
MPAA

Encoded version of the rating of the content

For example:
MPAA

Season of the content

For example:
Season 3

Encoded version of the season of the content

For example:

Season+3

Encoded series of the content

For example:
My%20awesome%20show

Encoded title of the content

For example:
Best%20Episode%20Ever

URL of the content, for buy-side contextualization or review

For example:

sweetseries.com/show

URL of the content, for buy-side contextualization or review

For example:

sweetseries.com%2Fshow

Indicates if the request is protected by the Children's Online Privacy Protection Act

Possible values:

• 0: Requests that are NOT protected by the COPPA

• 1: Requests that are protected by the COPPA

Three-letter country code of the user

For example:
USA

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.

Device language

For example:
fr

Device make

For example:
Samsung

Encoded device make

For example:
Samsung (URL encoded)

Device model

For example:
Tizen TV 2019

Encoded device model

For example:
Tizen%20TV%202019

Device operating system

For example:
Android

Device operating system version

For example:
2.1

Device type

For example:
CONNECTED_TV

Encoded device type

For example:
CONNECTED_TV

User device ID

In Publica, DID is synonymous with IDFA, IFA, and TIFA.

For example:
ddb9a00f-7806-9973-ba1f-9c4cb0c3c25c

(US only) Nielsen three-digital DMA code

For example:
803 (Los Angeles)

See: [LIMITED_AD_TRACKING]

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 apply
• 1: Impression is regulated by GDPR laws

Gender

Possible values:

• M: Male
• F: Female
• O: Other

GPP consent string

For example:
DBABjw~CPXxRfAPXxRfAAfKABENB-CgAAAAAAAAAAYgAAAAAAAA~1YNN

Array of Section ID integers

For example:
[1,2]

Device’s screen height (in px)

For example:
1080

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:

• 0
• 1

Device ID type

For example:
rida

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

User IP address

For example:
11.11.111.111

Encoded user IP address

For example:
1111%3Afcc8%3Aa012%3A1111%3A1111%3Ac896%3Ab7d5%3A6ca6

Iris ID

For example:

iris_18719437

Iris Context

For example:

ic_0755895, ic_4890138

Latitude from -90.0 to +90.0, where negative is south

For example:

40.7128

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 of the Publica endpoint.

Possible values:

• 0: User has NOT opted out targeting advertising
• 1: User has opted out of targeting advertising

Indicator of whether or not content is livestream enabled

Possible values:

• 0
• 1

Longitude from -180.0 to +180.0, where negative is west

For example:

-74.0060

Maximum length of an ad in seconds

This value should be smaller than the pod duration.

For example:
30

Maximum allowed average kilobits per second

For example:
8000

Minimum length of an ad in seconds

For example:
6

Minimum allowed average kilobits per second

For example:
10000

Encoded page URL

For example:
https%3A%2F%2Fwww.samsung.com

Length of the ad pod in seconds

For example:
60

Position

For example:
preroll or midroll or postroll

Descriptor identifying whether the media console is in a fixed or moving environment

Possible values:

• 0: Screen in a fixed environment, such as a billboard, elevator, or mall
• 1: Screen in a moving environment, such as a ferry or taxi

Preferred language

For example:
fr

SCHAIN string value

For example:
1.0,1!exchange1.com,1234,1,,,

Unique identifier for the session

For example:
123

Unique identifier for the channel

For example:
123

Number of ad slots to fill for a pod

For example:
3

SSAI enabled

For example:
1

SSAI vendor

Targeted device

For example:
Samsung%20TV

Unix timestamp (nanoseconds)

For example:
12634567890

Unix timestamp (milliseconds)

For example:
12634567

Unix timestamp (seconds)

For example:
126345

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 string for CCPA compliance

This macro returns the value passed in the us_privacy parameter of the Publica endpoint.

For example:
1---

ID or name of the venue

For example:
LAX Airport

Type of venue defined by an integer

For example:
10102

Device’s screen width (in px)

For example:
1920

User’s year of birth

For example:
1997

Macro

Description

[ADVERTISER_ID]

Unique identifier of the advertiser for the linked campaign order

[CREATIVE_ID]

Unique identifier of the creative

Name of the creative (media file or vast tag) delivered

Unique identifier of the line item

Name of the line item

[ORDER_ID]

Macro

Description

[INCOMING_{CONTENT_PARAMETER}]

Macro

Description

[AD_DURATION]

Post-auction value to identify demand partner of the won impression

For example:
appnexus

Unique ID generated for impression events

For example:
b16a3b5b-5bb9-45f8-8f58-5027573cd66b