Contact support
    • Monetization
    • Monetize
    • Set up and manage inventory
    • Manage creative templates
    • Official creative template specifications
    • Audio template specifications

    VAST audio (RTB)

    Table of Contents

    Overview Parameters Release notes

    Overview

    Formerly named "[RTB+ AUDIO] VAST 4.x". The "VAST audio" creative template plays an audio ad, rendering a VAST 4.x wrapper. It sends dedicated audio criteria to demand partners (see chapter "3.2.8 Object: Audio" on page 22 in the IAB OpenRTB specifications for a list of audio criteria in bid requests).

    Parameters

    Name Description Default value
    Custom click-tracking for main creative (linear) This applies to the main creative from the final <Inline> VAST document. You can supply a single custom click tracking URL or a list of custom click tracking URLs. Use "||" as a separator.  
    Custom VAST Tracking for VAST [tracking_event] A custom reporting URL for the VAST [tracking_event]. Several urls can be supplied using the "||" separator. You can find a list of the <TrackingEvent>s available in the VAST specifications.  
    ExecutableResource's apiFramework, type and URL

    Values of the apiFramework and type attributes together with the URL of the ExecutableResource element.

    The values should be provided following this pattern: apiFramework, type, URL.

    		  
    Follow additional wrappers

    Indicates if subsequent wrappers after a requested VAST response are allowed.

    If false, any wrappers received (i.e. not an inline VAST response) will be ignored.

    If true, retrieved VAST wrappers will be accepted.

    		 true
    JavaScriptResource's apiFramework and URL Values of the apiFramework attribute and the URL of the JavaScriptResource element. The values should be provided in the following pattern: apiFramework, URL.  
    Maximum bitrate Maximum expected bitrate for the audio creative, in Kbps  
    Maximum duration Maximum duration, in seconds. 60
    Minimum bitrate Minimum expected bitrate for the audio creative, in Kbps  
    Minimum duration Minimum duration, in seconds. 1
    Multiple ads allowed in requested VAST response

    A Boolean value that indicates if multiple ads are allowed in the requested VAST response.

    If true, both ad pods and standalone ads are allowed.

    If false, only the first standalone ad (without any sequence values) in the requested VAST response is allowed.

    		 false
    Playback method

    Qualifies the bid request with the ad break type, for linear ads. Possible values are:

    • AutoPlaySoundOn
    • AutoPlaySoundOff
    • ClickToPlay
    • MouseOver

    The empty entry is the default option; you can select it, but note that some programmatic buyers use this criterion to target their campaigns

    		  
    Progress offset Available formats: "HH:MM:SS" / "HH:MM:SS.mmm" / "n%”.  
    Show pricing If checked, pass in the VAST <Pricing> node the net bid price in publisher's currency false
    Skip offset

    The duration before the user can skip this ad. This setting will override the skip policy defined in the final VAST; leave empty if you want the ad to be non-skippable; Available formats: "HH:MM:SS" / "HH:MM:SS.mmm" / "n%". When using Equativ's Video plugin or SDKs, this setup can be overwritten by the publisher configuration depending on the value of the “Use publisher’s skipoffset” parameter.

    Note: This parameter is used to generate a custom VAST extension that will only be parsed if one of Equativ's proprietary video solutions is used (Equativ Video Plugin / Embedded Ad Manager / Instream SDKs). The feature is not available in case of standalone VAST requests.

    		  
    Skippable

    Indicates if the player will allow the audio ad to be skipped in order to pass this information in the bid request.

    If yes, skippability is supported.

    If no, skippability is not supported. If the ad call contains an explicit skip value (true or false), then the value from the ad call will override the value defined in the creative template.

    Note: the Skippable parameter is only taken into account if the Use publisher’s skipoffset parameter is disabled.

    		 empty
    URLs for custom errors A custom error URL that will be placed in the <Error> node of the VAST response. Several URLs can be supplied using the "||" separator.  
    URLs for custom impressions You can supply a single custom impression URL or a list of custom impression URLs. Use "||" as a separator.  
    Use custom VAST metrics If true, enables supplying custom URLs to track VAST metrics. If false, the custom VAST metric URLs will be ignored. false
    Use fallback if wrapper returns no ad

    Specifies if a passback ad should be used (if any exists) in case the wrapper does not return any ad.

    If true, the content player will select from any standalone ads available to try to replace the wrapper ad.

    If false and the wrapper represents an ad in an ad pod, the content player will move on to the next ad in the ad pod. If not specified, the content player can follow through at its own discretion in case the wrapper does not return any ad.

    		 not specified
    Use publisher's skipoffset

    If true, the skip policy defined in the plugin configuration will be used. Publishers can make all the ads non-skippable or skippable after the same delay.

    If false, the skip policy defined by the publisher (plugin configuration) will be ignored. The skip-offset defined in the VAST will be used.

    Note: this parameter is taken into account only if you are using one of Equativ's proprietary video solutions (Equativ Video Plugin / Embedded Ad Manager / Instream SDKs)

    		 true
    Verification parameters A string for the purpose of bootstrapping the verification code and providing metadata about the current impression.  
    Verification Tracking URLs One or multiple reporting URL(s) for the verificationNotExecuted event. Several URLs can be provided by using the "||" separator (no white spaces).  
    Verification vendor

    An identifier for the verification vendor.

    Note: add the vendor name if you want the AdVerifications node to be included in the VAST response file.

    		  
    VPAID version

    Possible values are:

    • 0: Disable VPAID creatives (no retrieval of VAST documents with VPAID creatives) 
    • 1,2: The bid request can return VPAID 1.0 or VPAID 2.0 creatives
    • 1: Only VPAID 1.0 creatives can be delivered
    • 2: Only VPAID 2.0 creatives can be delivered
    		 1,2

    Release notes

    • 2025-01-dd - Use [sas_rtb_netPaidPricePublisherCurrency] instead of [sas_rtb_clearedPricePublisherCurrency] to deliver net price instead of clearing price
    • 2025-01-08 - Handle client side BUR
    • 2023-10-16 - Rectification of Template tags
    • 2023-08-02 - Replace Smart by Equativ in AdSystem node
    • 2023-06-29 - Replace [sas_smartBaseUrl] with [sas_pixelDomain]
    • 2023-03-02 - Add vastResponseType meta parameter
    • 2021-05-17 - removed "Type of ad break" parameter

    RELATED ARTICLES