Ad Server response

The BannersIn2 solution is architected to provide flexibility in terms of how the ad server returns payloads from which to extract non-linear ad information. It can use responses in VAST format or even other formats (such as OpenRTB).

The mechanism by which the solution determines how to parse that payload and extract the relevant information is defined by a Schema. When you configure an Ad Server source of type "Interactive Ad Maker", you define the schema to use by setting the iam_schema query parameter.

Note that the exact content of the payload may also vary based on the type of Creative Template used for the non-linear ad.

This page lists some of the schemas publicly available.

📞

Contact your sales or customer success representative if you have different requirements to those enabled in the list below. This will typically be the case if wanting to work with a specific ad server.

bpkio-vast-v1

This schema expects the source to be a well-formed VAST payload, in which a single non-linear ad is provided in a Creative/NonLinearAds node.

The following is an example for an ad that is compatible with the requirements of the base-static-v1 creative template.

<VAST version="4.3">
  <Ad>
    <InLine>
  
	    <Impression>
        <![CDATA[https://example.com/video-impression]]>
      </Impression>	 
      <!-- ... other impressions ... -->         
                 
      <Creatives>

        <!-- NonLinear Ad Creative for L-Banner -->
        <Creative id="1hjd73" adId="example.org">
					<UniversalAdId idRegistry="example.org">1hjd73</UniversalAdId>
          <NonLinearAds>
            <NonLinear width="1920" height="1080" 
                       minSuggestedDuration="00:30:00"
                       apiFramework="bpk-bannersin2:base-static-v1">
              <!-- URL to the image -->
              <StaticResource creativeType="image/png">
                <![CDATA[https://example.com/l-shape.png]]>
              </StaticResource>
              
							<!-- Ad Parameters (JSON) -->
              <AdParameters>
	              <![CDATA[{
		              "mediaArea": {
			              "x": 200, 
			              "y": 0, 
			              "width": 1720, 
			              "height": 970,
			              "transparent": true
		              }
	              }]]>
              </AdParameters>
            </NonLinear>
            
            <TrackingEvents>
				      <Tracking event="creativeView">
				        <![CDATA[https://example.com/squeeze-back-view]]>
				      </Tracking>
				    </TrackingEvents>
	        </NonLinearAds>
        </Creative>
        
      </Creatives>
    </InLine>
  </Ad>
</VAST>

Version

The version of the VAST payload must be 3.0 or above, with a preference for 4.3

Constraints

• A single <Ad> is supported. Additional ones are ignored.
• A single <Creative> of type <NonLinearAds> is supported. Additional ones are ignored.
• It must contain a single <NonLinear> node. Additional ones are ignored.
• A unique identifier must be present, either with the id and adId attributes on the Creative node, or via a UniversalAdId node.

Options

• The minSuggestedDuration is optional and will only be taken into account in ad insertion mechanisms (see Triggers for details)
• apiFramework is optional. If not set, the creative template selected must be defined with the iam_template query parameter (see Service Configuration for details)

Ad Parameters

The AdParameters node must contain a valid JSON payload, in a CDATA wrapper. The content of that payload depends largely on the requirements of the specific Creative template selected.