Contents x
      Configuring Advertising Demand Sources
      • 01 Nov 2024
      • 1 Minute to read
      • Contributors
      • Print
      • Dark
        Light
      Contents

      Configuring Advertising Demand Sources

      • Updated on 01 Nov 2024
      • 1 Minute to read
      • Contributors
      • Print
      • Dark
        Light
      Article summary

       

      Configure ADS request URLs and Query Parameters

      1. Set your VAST3 ad server tags up as Ad Formats in the Transmit Creative Studio
      2. Provide master playlist request with full set of parameters expected to be passed in a live environment
      3. Convert required custom macros in VAST tag using wildcard macro format
        1. Any custom parameter passed in the MPR that is expected to be passed to the ADS should be accounted for
      4. Consult with your Transmit Integrations contact to ensure all macros/parameters are covered
      5. Once complete, session-specific dynamic ad targeting can be expected wherever the converted VAST tag and matching MPR parameters are present


      Pass Custom Parameters in Your Master Playlist Request

      Playlist Request Format: [TransmitPrefix]/[PathToAsset]?[Token]&[PlaylistParams]

      Example Playlist with Custom Params

      https://live-edge.transmit.live/v2/master/content-origin/6358121ab8e992fdaa0e8752/dg6750_main/playlist.m3u8?token=st%3D1669836056%7E&stream_id=16200&event_id=6750&appName=sampleapp&rdid=00000000-0000-0000-0000-000000000000&is_lat=1&height=1620&width=2160

      Common Query Parameters

      Transmit has designed our system to be ad server agnostic and flexible.  Below is a list of common query params and sample values used to decorate ad requests. Please reference your ad server's documentation for required an recommended values to be added to your ad requests.  Insert any query parameter into the playlist request when it's constructed and use the wildcard ad tag Macro to inject it into the ad request to your server. 

      Query ParamAd Tag MacroDefinitionExample
      *wildcard__DYNAMIC~{VALUE}Add any query parameter to the playlist requestPattern match macro that allows any value passed in a stream playlist to be inserted into an ad request.Parameter
      league=mlb

      AdTag Macro
      __DYNAMIC~league__
      appname__APP_NAME__App nameMy App
      bundleid__APP_BUNDLE__App bundle IDcom.example.tv
      appid__APP_ID__Unique ID of the app within the exchangesamsung.tv.plus.123
      appstoreurl__APP_STORE_URL__App store URLhttps://www.samsung.com/us/appstore/app/G15147002586
      domain__DOMAIN__Domainsamsung.com
      referer__REFERRER__Referrer URLhttps://www.samsung.com/phones
      ua__USER_AGENT_ESC__User Agent
      ip__IP_ADDRESS_ESC__IP Address108.6.194.170
      aaid__IOS_ID__IOS Device ID68753A44-4D6F-1226-9C60-0050E4C00067
      gaid__ANDROID_ID__Android Device ID014AEC092FA74D78
      uid__USER_ID__Resettable Device ID for mobile, cookie for desktop.014AEC092FA74D78
      ifatype__IFA_TYPE__Device ID typeaaid
      dt__DEVICE_TYPE__Device typeMOBILE
      os__PLATFORM_OS__Device OSiOS
      make__DEVICE_MAKE__Device MakeApple
      model__DEVICE_MODEL__Device ModeliPhone 6S Plus
      carrier__PLATFORM_CARRIER__CarrierVerizon
      metro_code__METRO_CODE__Metro code (aka Nielsen DMA code)501
      zip__ZIP_CODE__Zip code10001
      auction_id__AUCTION_ID__Unique ID for request
      w__WIDTH__Player width1920
      h__HEIGHT__Player height1080
      contstrid__CONTENT_STREAM_ID__Content stream ID60dcc8565adfe664cd0d3ebb
      extid__EXTERNAL_ID__External ID (supplied by content owner) for content7097576
      duration__DURATION__Ad duration30
      pr__US_PRIVACY_STRING__The US Privacy String on the bid request used for CCPA compliance1---
      isgdpr__IS_GDPR__Whether the auction is subject to GDPR0 or 1
      gdpr__GDPR_CONSENT_STRING__The consent string on the bid request used for GDPR complianceBOQ7WlgOQ7WlgABABwAAABJOACgACAAQABA
      dnt__DNT__Whether the user has Do Not Track or Limit Ad Tracking set0 or 1
      cb__CACHEBUSTER__Cachebuster1.23842E+12
      custom6__CUSTOM_6__Custom meta data for content stream60dcc8565adfe664cd0d3ebb
      custom7__CUSTOM_7__Custom meta data for content stream60dcc8565adfe664cd0d3ebb
      custom8__CUSTOM_8__Custom meta data for content stream60dcc8565adfe664cd0d3ebb
      rdid__RDID__Resettable device identifier (GAM)123e4567-e89b-12d3-a456-426655440000
      ppid__PPID__Publisher provided identifier12JD92JD8078S8J29SDOAKC0EF230337
      synthid__SYNTHID__Synthetic ID123e4567-e89b-12d3-a456-426655440000
      admode__AD_MODE__YES-specific: ad modepreview
      pos__POS__YES-specific: resolved value using ad modeif admode === 'preview' then 'pre' else ''
      srsport__SR_SPORT__Sport radar sport associated with contentnba
      srinvevent__SR_INV_EVENT__Sport radar event associated with inventoryshooting_foul
      session__SESSION_ID__Session ID60dcc8565adfe664cd0d3ebb
      bdur__BREAK_DUR__Break duration in seconds60
      bdurms__BREAK_DUR_MS__Break duration in milliseconds60000


      Configure Ad Tag to Dynamically Insert Custom Parameters

      Use Transmit's Dynamic Wildard Macro to pattern match any custom parameter in your playlist query and pass it into an ad request.

      Wildcard Macro Format

      &customparam1=__DYNAMIC~{any.custom.parameter.value}__

      Sample Ad Request

      https://myadserver.com.com/v1/1234?stream_id=__DYNAMIC~stream_id__&event_id=__DYNAMIC~event_id__&appName=__DYNAMIC~appName__&rdid=__DYNAMIC~rdid__&is_lat=1&height=__DYNAMIC~height__&width=__DYNAMIC~width__




      What's Next