This page will guide you through our list of available MACROs to proceed with our instream VAST integration.
Once you receive your VAST tag from your Teads representative, you will need to replace the placeholders with actual data at the time the ad request is made. This is usually accomplished by adding your own MACROs into these ad (vast) tags where available. Be sure to encode values where possible.
Below are all available MACROs and their definitions. The Required Macros will need to be replaced for the VAST fill. Please Note: The Teads Macro taxonomy is just a placeholder – these values will need to be replaced (hardcoded) or utilize a MACRO that will be filled by your ad server or instream player.
Available Macros and definition:
Required macros need to be replaced
| Teads Macro | Supported Environment | Optional | Description |
| [BUNDLE] | App, CTV | Required | Bundle ID of the app. For example: samsung.tv.plus.123 |
| [APPSTOREURL] | App, CTV | Required | App store URL For example: https://www.samsung.com/us/appstore/app/G15147002586 |
| [PAGE_REFERER] | Web | Required | The page url that caused the navigation to the current page Example: http://mypublisher.com/mypreviouspage |
| [REFERER] | Web | Required | The page url where the impression will be shown Example: http://mypublisher.com/mypage |
| [DEVICEID] | App, Web, CTV | Required | Unique Identifier for Advertisers such as Google Ad ID, Apple IDFA, or Roku's RIDA. Example: 236A005B-700F-4889-B9CE-999EAB2B605D |
| [IP_ADDRESS] | App, Web, CTV | Required | Defines the device IP address in IPv4 or IPv6 |
| [USERAGENT] | App, Web, CTV | Required | Defines the device user agent string. Example: Roku%2FDVP-7.10%2520(047.10E04062A) |
| [PLAYER_HEIGHT] | App, Web, CTV | Required | Defines the height of the player in pixels. Make sure to send a landscape aspect ratio |
| [PLAYER_WIDTH] | App, Web, CTV | Required | Defines the width of the player in pixels. Make sure to send a landscape aspect ratio |
| [API] | App, Web, CTV | Required | List of supported API frameworks for this impression. Refer to List 5.6. If an API is not explicitly listed, it is assumed not to be supported. |
| [PLAYBACK_METHOD] | App, Web, CTV | Required | Playback methods that may be in use. If none are specified, any method may be used. Refer to List 5.10. Only one method is typically used in practice. |
| [PLACEMENT_TYPE] | App, Web, CTV | Required | Placement type for the impression. Refer to List |
| Teads Macro | Supported Environment | Optional | Description |
| [SCHAIN] | App, Web, CTV | Recommended | This object represents both the links in the supply chain as well as an indicator whether or not the supply chain is complete |
| [APPNAME] | App, CTV | Recommended | Name of the app based on the value passed in the app_name parameter For example: My App |
| [APPDOMAIN] | App, Web, CTV | Recommended | The business domain name or the app domain of the entity For example: publishername.com |
| [APPCATEGORY] | App, CTV | Recommended | Array of IAB content categories that describe the content producer See: OpenRTB, Section 5.1 For example: IAB8,IAB12-3 |
| [APPVERSION] | App, CTV | Recommended | Defines the application version. For example: 2.3 |
| [DEVICE_MAKE] | App, Web, CTV | Recommended | Defines the make or manufacturer of the device. Examples: Apple, Microsoft, Sony |
| [DEVICE_MODEL] | App, Web, CTV | Recommended | Defines the model of the device. Examples: Apple TV, Xbox One, PlayStation 4 |
| [DEVICE_OS] | App, Web, CTV | Recommended | Device operating system For example: Android |
| [UA_CH_PLATFORM_BRAND] | App, Web, CTV | Recommended | The user agent's operating system’s commercial name. (e.g., "Windows", "iOS", or "AmazingOS") |
| [UA_CH_PLATFORM_VERSION] | App, Web, CTV | Recommended | The user agent's operating system’s version. (e.g., "NT 6.0", "15", or "17G") |
| [UA_CH_MOBILE] | App, Web, CTV | Recommended | A boolean indicating if the user agent's device is a mobile device. (e.g. 0 if not mobile or 1 if mobile) |
| [UA_CH_ARCH] | App, Web, CTV | Recommended | The user agent's underlying CPU architecture (e.g., "ARM", or "x86") |
| [UA_CH_BITNESS] | App, Web, CTV | Recommended | The user agent's underlying CPU architecture bitness (e.g., "32" or "64") |
| [UA_CH_MODEL] | App, Web, CTV | Recommended | The user agent's device model (e.g. "Pixel 2 XL") |
| [UA_CH_SOURCE] | App, Web, CTV | Recommended | Defines how the user client hint has been created: - header http = 3 - low entropy = 1 - high entropy = 2 - Unknown = 0 |
| [MIN_DURATION] | App, Web, CTV | Recommended | Minimum length of an ad in seconds |
| [MAX_DURATION] | App, Web, CTV | Recommended | Maximum length of an ad in seconds |
| [MIN_BITRATE] | App, Web, CTV | Recommended | Minimum allowed average kilobits per second |
| [MAX_BITRATE] | App, Web, CTV | Recommended | Maximum allowed average kilobits per second |
| [SKIP] | App, Web, CTV | Recommended | Indicates if the player will allow the video to be skipped, where 0 = no, 1 = yes. |
| [SEQUENCE] | App, Web, CTV | Recommended | If multiple ad impressions are offered in the same bid request, the sequence number will allow for the coordinated delivery of multiple creatives. |
| [MIMES] | App, Web, CTV | Recommended | Content MIME types supported (e.g., “video/x-ms-wmv”, “video/mp4”). |
| [START_DELAY] | App, Web, CTV | Recommended | Indicates the start delay in seconds for pre-roll, mid-roll, or post-roll ad placements. Refer to List 5.12 for additional generic values. |
| [GDPR] | App, Web, CTV | Recommended | Indicates GDPR acceptance Possible values: 0: GDPR does not apply 1: Impression is regulated by GDPR laws |
| [GDPR_CONSENT] | App, Web, CTV | Recommended | Base64-encoded Transparency & Consent string. Only meaningful if gdpr=1 |
| [US_PRIVACY] | App, Web, CTV | Recommended | US Privacy string for CCPA compliance |
| [CONTENT_GENRE] | App, Web, CTV | Recommended | Genre that best describes the content |
| [CONTENT_LANGUAGE] | App, Web, CTV | Recommended | Playback language of the video, using ISO-639-1-alpha-2 |
| [CONTENT_LIVESTREAM] | App, Web, CTV | Recommended | Indicator of whether or not content is livestream enabled Possible values: 0 = not live, 1 = content is live |
| [CONTENT_PRODUCER_NAME] | App, Web, CTV | Recommended | Details about the content Producer. For example: Warner Bros |
| [CONTENT_PRODUCER_ID] | App, Web, CTV | Recommended | Unique identifier of the content producer or originator |
| [CONTENT_SERIES] | App, Web, CTV | Recommended | Content series. Video Examples: “The Office” (television), “Star Wars” (movie) |
| [CONTENT_TITLE] | App, Web, CTV | Recommended | Content Title Video Examples: “Search Committee” (television), “A New Hope” (movie) |
| [CONTENT_CATEGORY] | App, Web, CTV | Recommended | Array of IAB content categories that describe the content producer |
| [CONTENT_LENGTH] | App, Web, CTV | Recommended | Length of content in seconds |
| [CONTENT_SEASON] | App, Web, CTV | Recommended | Name of content season Example: "Season 3" |
| [CONTENT_CONTEXT] | App, Web, CTV | Recommended | Type of content Example:game, video, text, etc. Possible values: 1: Video 2: Game 3: Music 4: Application 5: Text 6: Other 7: Unknown |
| [CONTENT_RATING] | App, Web, CTV | Recommended | Content rating Example: PG, R, MPAA |
| [CONTENT_USER_RATING] | App, Web, CTV | Recommended | User rating of the content Example: Number of stars or likes |
| [CONTENT_NETWORK] | App, Web, CTV | Recommended | Describes overarching network that contains several channels |
| [CONTENT_CHANNEL] | App, Web, CTV | Recommended | Specific network that the content is playing on |
| [CONTENT_ID] | App, Web, CTV | Recommended | Unique identifier of the content |
| [CONTENT_KEYWORDS] | App, Web, CTV | Recommended | Comma separated list of keywords describing the content For example: tvshow,comedy |