Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Publica Macros

See table below for supported macros in VAST tags for Direct Campaigns, Brand Safety tracking URLs, and for Bidders using a VAST tag ('Other (Vast tag)' bidder type):

...

Macro

Description

Value example

[AD_DURATION]

Ad duration, in seconds

Note: This macro is currently only supported for Direct Campaigns and Brand Safety Event Trackers.

15

[APP_BUNDLE]

App bundle

samsung.tv.plus.123

[APP_DOMAIN]

App domain

mygame.myapp.io

[APP_NAME]

App name

My Awesome App

[%APP_NAME%]

Encoded app name

My%20Awesome%20App

[APP_STORE_URL]

App store URL

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

[%APP_STORE_URL%]

Encoded app store URL

https%3A%2F%2Fwww.samsung.com%2Fus%2Fappstore%2Fapp%2FG15147002586

[BUYERUID]

Buyer UID

sample-buyeruid

[CACHEBUSTER]

Random number

123

[CONSENT]

GDPR Consent string

Code Block
BOQ7WlgOQ7WlgABABwAAABJOACgACAAQABA

[CONTENT_CAT]

IAB category

IAB8,IAB12-3 (Refer to section 5.1 of the OpenRTB spec)

[CONTENT_CHANNEL]

Content Channel

Publica TV

[CONTENT_CONTEXT]

Content Context

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

[CONTENT_DIST_ID]

Content Distribution ID

[CONTENT_DIST_NAME]

Content Distribution Name

[CONTENT_EPISODE]

Content Episode Number

34

[%CONTENT_GENRE%]

Encoded content genre

Sports (URL encoded)

[CONTENT_ID]

Content ID

123

[CONTENT_KEYWORDS]

Comma separated list of keywords describing the content

tvshow,comedy

[CONTENT_LANGUAGE]

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

fr

[CONTENT_LENGTH]

Length of content in seconds

342

[CONTENT_NETWORK]

Content Network

[CONTENT_PROD]

Production quality

0 Unknown
1 Professionally Produced
2 Prosumer
3 User Generated (UGC)

[CONTENT_PRODUCER_ID]

Content producer or originator ID

[CONTENT_PRODUCER_NAME]

Content producer or originator name

Warner Bros

[CONTENT_RATING]

Content Rating

MPAA

[CONTENT_SEASON]

Content Season

Season 3

[%CONTENT_SERIES%]

Encoded content series

My%20awesome%20show

[%CONTENT_TITLE%]

Encoded content title

Best%20Episode%20Ever

[COPPA]

COPPA compliance

0 or 1

[COUNTRY]

3-letter country code

USA

[CUSTOM_4]

Custom 4 value

User defined

[CUSTOM_5]

Custom 5 value

User defined

[CUSTOM_6]

Custom 6 value

User defined

[CUSTOM_7]

Custom 7 value

User defined

[CUSTOM_8]

Custom 8 value

User defined

[CUSTOM_TARGETING]

Return the value in the custom_targeting param

[DID]

User device ID.

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

ddb9a00f-7806-9973-ba1f-9c4cb0c3c25c

[DEMAND_SOURCE]

Post-auction value to identify demand partner of won impression

appnexus

[DEVICE_LANGUAGE]

Device Language

fr

[DEVICE_MAKE]

Device make

Samsung

[%DEVICE_MAKE%]

Encoded device make

Samsung (URL encoded)

[DEVICE_MODEL]

Device model

Tizen TV 2019

[%DEVICE_MODEL%]

Encoded device model

Tizen%20TV%202019

[DEVICE_OS]

Device Operating System

Android

[DEVICE_OS_VERSION]

Device Operating System version

2.1

[DEVICE_TYPE]

Device type

CONNECTED_TV

[%DEVICE_TYPE%]

Device type (encoded version)

CONNECTED_TV (URL encoded)

[IFA_TYPE]

Device ID type

rida

[DMA_CODE]

Nielsen DMAs

803 (Los Angeles)

[DNT]

Same value as [LIMITED_AD_TRACKING]

0 or 1

[GDPR]

Request subject to GDPR regulation

0 or 1

[GENDER]

Gender

M Male
F Female
O Other

[GENRE_ID]

Genre ID

[HEIGHT]

Device’s screen height (in px)

1080

[HOUSE_ADS]

Return the value in the house_ads params

0 or 1

[IP]

User IP

11.11.111.111

[%IP%]

Encoded user IP

Code Block
1111%3Afcc8%3Aa012%3A1111%3A1111%3Ac896%3Ab7d5%3A6ca6

[LIMITED_AD_TRACKING]

Request subject to limited ad tracking regulation

0 or 1

[LIVESTREAM]

Is livestream enabled

0 or 1

[MAX_AD_DURATION]

Maximum duration of an ad in seconds. Should be smaller than the pod duration.

30

[MAXBITRATE]

Maximum accepted bitrate in kbps

8000

[MIN_AD_DURATION]

Minimum duration of an ad in seconds

6

[MINBITRATE]

Minimum bit rate in Kbps

10000

[%PAGE_URL%]

Encoded Page URL

Code Block
https%3A%2F%2Fwww.samsung.com

[POD_DURATION]

Duration of the ad pod in seconds

60

[POSITION]

Position

Position of the ad break: preroll | midroll | postroll

[PREFERRED_LANGUAGE]

Preferred Language

fr

[RIGHTS_HOLDER]

Rights Holder

[SCHAIN]

SCHAIN string value

1.0,1!exchange1.com,1234,1,,,

[SESSION_ID]

Session ID

123

[SITE_ID]

Channel ID

123

[SITE_NAME]

Return the value in the site_name param

[SITE_PAGE]

Return the page url value in the site page param.

https://example.com

[SLOT_COUNT]

Number of ad slots to fill for a pod

3

[SSAI_ENABLED]

SSAI Enabled

1

[SSAI_VENDOR]

SSAI Vendor

[TARGETED_DEVICE]

Targeted Device

Samsung%20TV

[TIMESTAMP]

Unix Timestamp

126345

[TRACKERUUID]

Post-auction value of impression ID for tracking.

b16a3b5b-5bb9-45f8-8f58-5027573cd66b

[%UA%]

Encoded user agent

Code Block
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 (CCPA Compliance)

1---

[WIDTH]

Device’s screen width (in px)

1920

[YOB]

User’s year of birth

1997

...

Passthrough Macros

Publica supports the pass through of user defined query parameters and their values via our custom pass through macros. These macros are reserved for the query parameter values that Publica does not currently support. A common use case would be if you need to pass many different custom values to Publica in which our existing custom_n macros cannot fully cover.

...