dotstudioPRO can pass back advertising parameters required by ad servers through VMAP , SSAI , and through an API request to the play route. To get more information on VMAP and other API requests please visit our API docs at api.myspotlight.tv
Below is a list of supported macros:
| aidmd5hex | SpotNetwork-specific device IFA md5-encrypted ad id as a hex value |
| aidsha1hex | SpotNetwork-specific device IFA sha1-encrypted ad id as a hex value |
| app_bundle | The ID of the app bundle, i.e. roku.dotstudiopro.someproject |
| app_id | See `device_ifa` |
| app_name | The name of the app. |
| app_url | The url of the app in its platform-specific app store |
| app_version | The version of the app bundle |
| cb | Cachebuster value. Note: this is automatically appended as `cb=thecbvalue` onto every tag. You do not need to add this value in unless you need multiple random integer values. |
| ccpa_us_privacy | The CCPA US Privacy consent string (1YNN, etc) |
| channel_id | The ID of the channel this video is in, if present |
| channel_title | The title of the channel, if one is present |
| company_id | The ID of the company the video belongs to. |
| content_episode | The episode number of the video. |
| content_genre | The genre of the video. Note: if multiple genres are selected, only the first is used. |
| content_language | Video's language data. Converts to ISO-639-1 standard codes. |
| content_provider | The provider of the video content requested |
| content_rating | The rating of the video, ex: PG-13 |
| content_season | The season number. |
| device_devicetype | The type of the device that called the ad (ios, roku, android, etc). NOTE: you will need to pass this value with the param as `device_type`, ex `&device_type=roku`. |
| device_geo_lat | The calculated latitude of the device that requested the ad based on its IP address. |
| device_geo_lon | The calculated longitude of the device that requested the ad based on its IP address. |
| device_id_type | The type of device id we have, i.e. IDFA, RFID, etc |
| device_ifa | The AppleTV/iOS Identifier for Advertisers |
| device_make | Device Make, i.e. Apple, Roku |
| device_model | The device model, i.e. iPhone 11. |
| device_os_version | Device OS version, like iOS 12.1.3. |
| dnt | The 'do not track' setting of the device requesting the ad. |
| gdpr | General Data Protection Regulation value for European markets. |
| ic | The category as specified by the TAG IQC. |
| ip_addr | The ip address of the device requesting the ad. |
| is_livestream | The video is/not a live stream. |
| keywords | A comma-separated list of tags for a video. |
| media_description | The description of the video. |
| media_description_dashes | The description of a video with spaces replaced with dashes instead of URL-encoded. |
| media_title | The title of the video. |
| media_title_dashes | The title of the video with spaces replaced with dashes instead of URL-encoded. |
| media_url | The url to the file for the video. |
| mt_avail_index | A number that represents the position of an ad avail in an index. At the start of a playback session, MediaTailor creates an index of all the ad avails in a manifest and stores the index for the remainder of the session. When MediaTailor makes a request to the ADS to fill the avail, it includes the ad avail index number. This parameter enables the ADS to improve ad selection by using features like competitive exclusion and frequency capping. (From AWS) |
| mt_avail_random | A random number between 0 and 10,000,000,000 that MediaTailor generates for each request to the ADS. Some ad servers use this parameter to enable features such as separating ads from competing companies. (From AWS) |
| mt_scte_avail_num | The value parsed by MediaTailor from the SCTE-35 field `avail_num`. MediaTailor can use this value to designate linear ad avail numbers. (From AWS) |
| mt_scte_event_id | The value parsed by MediaTailor from the SCTE-35 field `splice_event_id`, as a long number. MediaTailor uses this value to designate linear ad avail numbers or to populate ad server query strings, like ad pod positions. (From AWS) |
| mt_scte_unique_program_id | The value parsed by MediaTailor from the SCTE-35 `splice_insert` field `unique_program_id`. The ADS uses the unique program ID (UPID) to provide program-level ad targeting for live linear streams. If the SCTE-35 command is not splice insert, MediaTailor sets this to an empty value. (From AWS) |
| mt_session_avail_duration_ms | The duration in milliseconds of the ad availability slot. The default value is 300,000 ms. AWS Elemental MediaTailor obtains the duration value from the input manifest as follows: <ul><li>For HLS, MediaTailor obtains the duration from the #EXT-X-CUE-OUT: DURATION or from values in the #EXT-X-DATERANGE tag. If the input manifest has a null, invalid, or 0 duration for the ad avail in those tags, MediaTailor uses the default.</li><li>For DASH, MediaTailor obtains the duration value from the event duration, if one is specified. Otherwise, it uses the default value.</li></ul> (From AWS) |
| mt_session_avail_duration_secs | The duration in seconds of the ad availability slot, or ad avail. MediaTailor determines this value the same way it determines [`session.avail_duration_ms`]. (From AWS) |
| mt_session_client_ip | The remote IP address that the MediaTailor request came from. If the `X-forwarded-for` header is set, then that value is what MediaTailor uses for the `client_ip`. (From AWS) |
| mt_session_id | A unique numeric identifier for the current playback session. All requests that a player makes for a session have the same id, so it can be used for ADS fields that are intended to correlate requests for a single viewing. (From AWS) |
| mt_session_referer | Usually, the URL of the page that is hosting the video player. MediaTailor sets this variable to the value of the Referer header that the player used in its request to MediaTailor. If the player doesn't provide this header, MediaTailor leaves the [session.referer] empty. If you use a CDN or proxy in front of the manifest endpoint and you want this variable to appear, proxy the correct header from the player here. (From AWS) |
| mt_session_user_agent | The `User-Agent` header that MediaTailor received from the player's session initialization request. If you're using a CDN or proxy in front of the manifest endpoint, you must proxy the correct header from the player here. (From AWS) |
| mt_session_uuid | Alternative to [session.id]. This is a unique identifier for the current playback session, such as the following: `e039fd39-09f0-46b2-aca9-9871cc116cde` (From AWS) |
| nielsen_dar_cat | Nielsen DAR Category |
| page_url | The url of the page the video is playing on, if present. |
| player_height | The height of the video player. |
| player_width | The width of the player. |
| rtb_device | The RTB v2.5 IAB Device designation |
| series_title | The title of the series this video is in. |
| series_title_dashes | The title of the series this video is in with spaces replaced with dashes instead of URL-encoded. |
| ua | The User Agent of the device requesting the ad. |
| user_cookieid | Springserve User Cookie Id |
| user_gender | The gender of the user. |
| user_yob | The year of birth of the user. |
| vid_duration | The duration of a video. |
| video_id | The unique id of the video within dotstudioPRO. |
| VPI | Can contain a value of “MP4” OR “FLV” if your player is only capable of displaying one of these creative types. This value is passed by the ad request itself, if it is necessary. |
Updated