BidSwitch Supplier Protocol 1.1navigate_next Supplier Bid Requestnavigate_next Banner Object
Quick search
description Buyer Release Notes description Deals Center group_work Targeting Groups API link Customer Documentation
BidSwitch Docs

OpenRTB 2.5 Support

  • BidSwitch Buyer Protocol v5.3
    • Protocol Release Notes
    • Compatibility and Deprecation
    • Protocol Version Differences
    • 5.x Updating Overview
    • burl Field Overview
    • BidSwitch OpenRTB Differences
    • Data Compression (gzip)
    • Macros
    • Sensitive Categories and Rich Media
    • Supplier Custom Categories
    • Server-to-Server (s2s) Calls
    • Bid Request v5.3
      • Impression Object
      • Banner Object
      • Format Object
      • Video Object
      • Audio Object
      • Native Object
      • Native Request Object
      • Device Object
      • Geo Object
      • User Object
      • Site Object
      • App Object
      • Content Object
      • TV Object
      • DOOH Object
      • Metric Object
      • Private Marketplace Object
      • Source Object
      • Deal Object
      • Publisher Object
      • Ext Object
      • Regs Object
      • Data Object
      • Bid Request JSON Examples
    • Bid Response v5.3
      • Bid Response Ext Object
      • Seat Bid Object
      • Bid Object
      • Native Response Object
      • Supplier Specific Fields
      • Data Response Object
      • Bid Response JSON Examples
  • BidSwitch Supplier Protocol v1.0
    • Protocol Release Notes
    • Sensitive Categories and Rich Media
    • Backward Compatibility
    • Data Compression (gzip)
    • Macros
    • Supplier Bid Request
      • Impression Object
      • Banner Object
      • Format Object
      • Video Object
      • Audio Object
      • Native Object
      • Native Request Object
      • Private Marketplace Object
      • Deals Object
      • Device Object Properties
      • Geo Object Properties
      • Metric Object
      • User Object
      • Ext Object
      • ads.txt Object
      • Data Object
      • Source Object
      • Site Object
      • App Object
      • Ext Object
      • Content Object
      • DOOH Object
      • Publisher Object
      • Regulation Object
      • Required Fields per Buyer
      • Bid Request JSON Examples
    • Supplier Bid Response
      • Seat Bid Object
      • Response Bid Object
      • Native Response Object
      • Data Response Object
      • Response Ext Object
      • Bid Response JSON Examples

OpenRTB 2.6 Support

  • BidSwitch Buyer Protocol 5.7
    • Protocol Release Notes
    • Compatibility and Deprecation
    • 5.7 Upgrade Guide
    • burl Field Overview
    • Data Compression (gzip)
    • Sensitive Categories and Rich Media
    • Server-to-Server (s2s) Calls
    • Bid Request 5.7
      • Impression Object
      • Banner Object
      • Format Object
      • Video Object
      • Audio Object
      • Native Object
      • Native Request Object
      • Device Object
      • Geo Object
      • User Object
      • Site Object
      • App Object
      • Content Object
        • Network Object
        • Channel Object
        • Producer Object
      • DOOH Object
      • Metric Object
      • Private Marketplace Object
      • Source Object
      • Deal Object
      • Publisher Object
      • Ext Object
      • Regs Object
      • Data Object
      • Bid Request JSON Examples
    • Bid Response 5.7
      • Bid Response Ext Object
      • Seat Bid Object
      • Bid Object
      • Native Response Object
      • Data Response Object
      • Bid Response JSON Examples
  • BidSwitch Supplier Protocol 1.1
    • Protocol Release Notes
    • Sensitive Categories and Rich Media
    • Backward Compatibility
    • Data Compression (gzip)
    • Macros
    • Supplier Bid Request
      • Impression Object
      • Banner Object
      • Format Object
      • Video Object
      • Audio Object
      • Native Object
      • Native Request Object
      • Private Marketplace Object
      • Deals Object
      • Device Object Properties
      • Geo Object Properties
      • Metric Object
      • User Object
      • Ext Object
      • ads.txt Object
      • Data Object
      • Source Object
      • Site Object
      • App Object
      • Content Object
        • Network Object
        • Channel Object
        • Content Producer Object
      • DOOH Object
      • Publisher Object
      • Regulation Object
      • Required Fields per Buyer
      • Bid Request JSON Examples
    • Supplier Bid Response
      • Seat Bid Object
      • Response Bid Object
      • Native Response Object
      • Data Response Object
      • Response Ext Object
      • Bid Response JSON Examples

Industry Standards

  • BidSwitch and Ads.txt
  • BidSwitch and app-ads.txt
  • BidSwitch and CCPA
  • BidSwitch and GDPR
  • BidSwitch and sellers.json
  • Topics API

Deals Center

  • Deals Center Overview
  • Deals Management
  • Deals Discovery
  • Deals Sync API for Buyers
  • Deals Sync API for Suppliers
    • Deals API Targeting
  • Deals Troubleshooting Insights

General Information

  • BidSwitch Custom Auto-Reports
  • BidSwitch Data Centres
  • Trading Modes and Fees
  • Separate Supplier Fees
  • Flexible Fee Assignment on BidSwitch
  • Glossary
  • Impression Delivery and Tracking
  • Impression Count Deduplication
  • Private Marketplaces & Deal IDs
  • Investigating a Discrepancy or Invoice
  • Logging into BidSwitch Services
  • SmartSwitch Overview
  • Exploration QPS
  • SmartSwitch Bid Request Weight
  • TV Best Practices

BidSwitch APIs

  • API Authorization
  • Ads.txt API
  • Creative Blocking API
  • Creative Approval Reporting API
  • Creative Approval Pre-submitting API
  • Discrepancy API for Buyer
  • Discrepancy API for Suppliers
  • Targeting Groups History API

Buyer Guides

  • Big Lists Targeting
  • Buyer Best Practices
  • BidSwitch True Price
  • Buyer User Matching
  • Buyer No-bid Response / Reason
  • Creative Approval Overview
  • In-App User Optimization
  • Supplier Information
    • Xandr (Appnexus)
    • Google Partner Inventory
    • BroadSign
    • Sorenson Media
  • SmartSwitch User Optimization
  • BidSwitch Targeting Groups

Supplier Guides

  • Discrepancy API for Suppliers
  • Supplier No Bid Reason
  • Supplier User Matching
  • Seat ID and Agency Mapping
  • Protected Audience API
BidSwitch Docs

OpenRTB 2.5 Support

  • BidSwitch Buyer Protocol v5.3
    • Protocol Release Notes
    • Compatibility and Deprecation
    • Protocol Version Differences
    • 5.x Updating Overview
    • burl Field Overview
    • BidSwitch OpenRTB Differences
    • Data Compression (gzip)
    • Macros
    • Sensitive Categories and Rich Media
    • Supplier Custom Categories
    • Server-to-Server (s2s) Calls
    • Bid Request v5.3
      • Impression Object
      • Banner Object
      • Format Object
      • Video Object
      • Audio Object
      • Native Object
      • Native Request Object
      • Device Object
      • Geo Object
      • User Object
      • Site Object
      • App Object
      • Content Object
      • TV Object
      • DOOH Object
      • Metric Object
      • Private Marketplace Object
      • Source Object
      • Deal Object
      • Publisher Object
      • Ext Object
      • Regs Object
      • Data Object
      • Bid Request JSON Examples
    • Bid Response v5.3
      • Bid Response Ext Object
      • Seat Bid Object
      • Bid Object
      • Native Response Object
      • Supplier Specific Fields
      • Data Response Object
      • Bid Response JSON Examples
  • BidSwitch Supplier Protocol v1.0
    • Protocol Release Notes
    • Sensitive Categories and Rich Media
    • Backward Compatibility
    • Data Compression (gzip)
    • Macros
    • Supplier Bid Request
      • Impression Object
      • Banner Object
      • Format Object
      • Video Object
      • Audio Object
      • Native Object
      • Native Request Object
      • Private Marketplace Object
      • Deals Object
      • Device Object Properties
      • Geo Object Properties
      • Metric Object
      • User Object
      • Ext Object
      • ads.txt Object
      • Data Object
      • Source Object
      • Site Object
      • App Object
      • Ext Object
      • Content Object
      • DOOH Object
      • Publisher Object
      • Regulation Object
      • Required Fields per Buyer
      • Bid Request JSON Examples
    • Supplier Bid Response
      • Seat Bid Object
      • Response Bid Object
      • Native Response Object
      • Data Response Object
      • Response Ext Object
      • Bid Response JSON Examples

OpenRTB 2.6 Support

  • BidSwitch Buyer Protocol 5.7
    • Protocol Release Notes
    • Compatibility and Deprecation
    • 5.7 Upgrade Guide
    • burl Field Overview
    • Data Compression (gzip)
    • Sensitive Categories and Rich Media
    • Server-to-Server (s2s) Calls
    • Bid Request 5.7
      • Impression Object
      • Banner Object
      • Format Object
      • Video Object
      • Audio Object
      • Native Object
      • Native Request Object
      • Device Object
      • Geo Object
      • User Object
      • Site Object
      • App Object
      • Content Object
        • Network Object
        • Channel Object
        • Producer Object
      • DOOH Object
      • Metric Object
      • Private Marketplace Object
      • Source Object
      • Deal Object
      • Publisher Object
      • Ext Object
      • Regs Object
      • Data Object
      • Bid Request JSON Examples
    • Bid Response 5.7
      • Bid Response Ext Object
      • Seat Bid Object
      • Bid Object
      • Native Response Object
      • Data Response Object
      • Bid Response JSON Examples
  • BidSwitch Supplier Protocol 1.1
    • Protocol Release Notes
    • Sensitive Categories and Rich Media
    • Backward Compatibility
    • Data Compression (gzip)
    • Macros
    • Supplier Bid Request
      • Impression Object
      • Banner Object
      • Format Object
      • Video Object
      • Audio Object
      • Native Object
      • Native Request Object
      • Private Marketplace Object
      • Deals Object
      • Device Object Properties
      • Geo Object Properties
      • Metric Object
      • User Object
      • Ext Object
      • ads.txt Object
      • Data Object
      • Source Object
      • Site Object
      • App Object
      • Content Object
        • Network Object
        • Channel Object
        • Content Producer Object
      • DOOH Object
      • Publisher Object
      • Regulation Object
      • Required Fields per Buyer
      • Bid Request JSON Examples
    • Supplier Bid Response
      • Seat Bid Object
      • Response Bid Object
      • Native Response Object
      • Data Response Object
      • Response Ext Object
      • Bid Response JSON Examples

Industry Standards

  • BidSwitch and Ads.txt
  • BidSwitch and app-ads.txt
  • BidSwitch and CCPA
  • BidSwitch and GDPR
  • BidSwitch and sellers.json
  • Topics API

Deals Center

  • Deals Center Overview
  • Deals Management
  • Deals Discovery
  • Deals Sync API for Buyers
  • Deals Sync API for Suppliers
    • Deals API Targeting
  • Deals Troubleshooting Insights

General Information

  • BidSwitch Custom Auto-Reports
  • BidSwitch Data Centres
  • Trading Modes and Fees
  • Separate Supplier Fees
  • Flexible Fee Assignment on BidSwitch
  • Glossary
  • Impression Delivery and Tracking
  • Impression Count Deduplication
  • Private Marketplaces & Deal IDs
  • Investigating a Discrepancy or Invoice
  • Logging into BidSwitch Services
  • SmartSwitch Overview
  • Exploration QPS
  • SmartSwitch Bid Request Weight
  • TV Best Practices

BidSwitch APIs

  • API Authorization
  • Ads.txt API
  • Creative Blocking API
  • Creative Approval Reporting API
  • Creative Approval Pre-submitting API
  • Discrepancy API for Buyer
  • Discrepancy API for Suppliers
  • Targeting Groups History API

Buyer Guides

  • Big Lists Targeting
  • Buyer Best Practices
  • BidSwitch True Price
  • Buyer User Matching
  • Buyer No-bid Response / Reason
  • Creative Approval Overview
  • In-App User Optimization
  • Supplier Information
    • Xandr (Appnexus)
    • Google Partner Inventory
    • BroadSign
    • Sorenson Media
  • SmartSwitch User Optimization
  • BidSwitch Targeting Groups

Supplier Guides

  • Discrepancy API for Suppliers
  • Supplier No Bid Reason
  • Supplier User Matching
  • Seat ID and Agency Mapping
  • Protected Audience API

Banner Object¶

Note

Fields marked with an asterisk (*) are optional.

Banner Object Properties¶

Value

Type

Description

id*

string

Unique identifier for this banner object. Recommended when Banner objects are used with a Video object to represent an array of companion ads. Values usually start at 1 and increase with each object; should be unique within an impression.

vcm*

integer

Relevant only for Banner objects used with a Video object in an array of companion ads. Indicates the companion banner rendering mode relative to the associated video, where 0 = concurrent, 1 = end-card.

w

integer

Width of the impression in pixels, for example, 300

h

integer

Height of the impression in pixels, for example 250

battr*

array of integers

Blocked creative attributes as defined in the OpenRTB protocol, for example, [1, 23]

btype*

array of integers

Blocked banner ad types as defined in the OpenRTB protocol, for example, [4, 2]

pos*

integer

Ad Position as defined in the OpenRTB protocol, for example, 1

topframe*

integer

Indicates if the banner is in the top frame as opposed to an iframe.

  • 0 = no

  • 1 = yes.

mimes*

array of strings

Specifies the content MIME types supported, common MIME types include "text/html", "application/x-shockwave-flash", and "image/gif". For example:

[ "video/mp4", "image/jpg"]

expdir*

array of integers

Possible expansion directions for an expandable ad, for example, [2,5]. This can take the following values:

  • 1: Left

  • 2: Right

  • 3: Up

  • 4: Down

  • 5: Full screen

If the field is not present, expandable creatives are not allowed.

format*

array or objects

An array of format objects, see Format Object, denoting the alternative sizes that may be used for bidding. If one of the alternative ad sizes is used in the bid response, then the seatbid.bid.h and seatbid.bid.w fields are required in the bid response.

api*

array of integers

List of supported API frameworks for this impression as defined in the OpenRTB, for example [3, 5]. If an API is not explicitly listed, it is assumed not to be supported.

ext*

object

Banner extension object

Banner Ext Object¶

Banner Ext Object Properties¶

Value

Type

Description

rewarded*

integer

Indicates whether the ad is being rendered as part of a rewarded / incentivised user experience, where:

  • 0 = non-rewarded

  • 1 = rewarded

  • If omitted, non-rewarded can be assumed

Banner JSON Example¶

{
   "banner":{
      "id":"abc123",
      "w":300,
      "h":250,
      "pos":1,
      "topframe":0,
      "btype":[
         2,
         3
      ],
      "mimes":[
         "text/html",
         "application/x-shockwave-flash"
      ],
      "format":[
         {
            "h":50,
            "w":300
         }
      ],
      "ext":{
         "rewarded": 1
      }
   }
}

  • Banner Object
    • Banner Ext Object
    • Banner JSON Example
arrow_back
Previous
Impression Object
arrow_forward
Next
Format Object
© 2014-2025 BidSwitch GmbH.

All rights reserved. This document contains BidSwitch GmbH proprietary information.

About Us
BidSwitch Policy
Privacy Policy
News & Insights


Last updated May 08, 2025