Bid Requests

coppa

integer

Flag indicating if this request is subject to the COPPA regulations established by the USA FTC, where 0 = no, 1 = yes.

ext

object

Object that supports the following extensions:

• “us_privacy” to specify that this request is subject to CCPA US privacy regulations in support of the IAB OpenRTB Extension for US Privacy. Usage of gpp is preferred.
• "gpp" string to specify regulations via Global Privacy Platform String__
• "gpp_sid" array to specify relevant GPP section ID

mimes

array of strings

Specifies the video content MIME types supported; for example, video/mp4 and video/x-ms-wmv. If not specified, any MIME type is allowed.

minduration

integer; recommended

Specifies the minimum video ad duration, in seconds.

maxduration

integer; recommended

Specifies the maximum video ad duration, in seconds.

w

integer

Specifies the width of the video player, in pixels.

h

integer

Specifies the height of the video player, in pixels.

startdelay

integer

Indicates the start delay in seconds for pre-roll, mid-roll, or post-roll ad placements. Refer to OpenRTB 2.5 List 5.12 for values.

battr

array of integers

Specifies the banner creative attributes to block. Refer to section 5.3 of the IAB specification for a list of attributes. This is not supported by all demand sources. This is not supported by all demand sources.

minbitrate

integer

Specifies the minimum bit rate, in kilobytes per second. If specified, only return creatives having at least one media file within the appropriate bit range.

maxbitrate

integer

List of supported API frameworks for this banner. If an API is not explicitly listed, it is assumed not to be supported. Refer to OpenRTB 2.5 list 5.6.

playbackmethod

array of integers

Playback methods that may be in use. If none are specified, any method may be used. Refer to OpenRTB 2.5 List 5.10.

pos

integer

Ad position on screen. Refer to OpenRTB 2.5 List 5.4.

api

array of integers

List of supported API frameworks for this impression. Refer to OpenRTB 2.5 List 5.6. If an API is not explicitly listed, it is assumed not to be supported.

protocols

array of integers

Array of supported video protocols. Refer to OpenRTB 2.5 List 5.8.

placement

integer

Placement type for the impression. Refer to OpenRTB 2.5 List 5.9.

plcmt

integer

Placement type for the impression. Refer to AdCOM Plcmt Subtypes.

boxingallowed

integer; default 1

Indicates if letter-boxing of 4:3 content into a 16:9 window is allowed, where 0 = no, 1 = yes

delivery

array of integers

Supported delivery methods (e.g., streaming, progressive). If none specified, assume all are supported. Refer to List 5.15.

skip

integer

Indicates if the player will allow the video to be skipped, where 0 = no, 1 = yes.

skipafter

integer; default 0

Videos of total duration greater than this number of seconds can be skippable; only applicable if the ad is skippable.

skipmin

integer; default 0

Number of seconds a video must play before skipping is enabled; only applicable if the ad is skippable

podid

string

Unique identifier indicating that an impression opportunity belongs to a video ad pod. If multiple impression opportunities within a bid request share the same podid, this indicates that those impression opportunities belong to the same video ad pod.

sequence

integer; default 0
DEPRECATED

If multiple ad impressions are offered in the same bid request, the sequence number will allow for the coordinated delivery of multiple creatives.

maxseq

integer; recommended

Indicates the maximum number of ads that may be served into a "dynamic" video ad pod (where the precise number of ads is not predetermined by the seller). See Section 7.6 for more details.

poddur

integer; recommended

Indicates the total amount of time in seconds that advertisers may fill for a "dynamic" video ad pod (See Section 7.6 for more details), or the dynamic portion of a "hybrid" ad pod. This field is required only for the dynamic portion(s) of video ad pods. This field refers to the length of the entire ad break, whereas minduration/maxduration/rqddurs are constraints relating to the slots that make up the pod.

podseq

integer; default 0

The sequence (position) of the video ad pod within a content stream. Refer to List: Pod Sequence in AdCOM 1.0 for guidance on the use of this field.

rqddurs

integer array

Precise acceptable durations for video creatives in seconds. This field specifically targets the Live TV use case where non-exact ad durations would result in undesirable "dead air". This field is mutually exclusive with minduration and maxduration; if rqddurs is specified, minduration and maxduration must not be specified and vice versa.

slotinpod

integer; default 0

For video ad pods, this value indicates that the seller can guarantee delivery against the indicated slot position in the pod. Refer to List: Slot Position in Pod in AdCOM 1.0 guidance on the use of this field.

mincpmpersec

float

Minimum CPM per second. This is a price floor for the "dynamic" portion of a video ad pod, relative to the duration of bids an advertiser may submit.

maxextended

integer

Maximum extended ad duration if extension is allowed. If blank or 0, extension is not allowed. If -1, extension is allowed, and there is no time limit imposed. If greater than 0, then the value represents the number of seconds of extended play supported beyond the maxduration value.

gender

string

Gender, where “M” = male, “F” = female, “O” = known to be other (i.e., omitted is unknown).

yob

integer

Year of birth as a 4-digit integer.

eids

object array

Array of objects of third party alternative IDs, per the OpenRTB spec.

consent

string

TField for TCF2 strings for Canadian users. Use of gpp is recommended instead.

ext

object

Supports the "hems" array of objects for passing hashed email(s) for the user, eg.

"user": {  
    "ext": {  
        "hems": [  
            {"hem": "<hashed_email>", "hem_type": "sha256"},
            {"hem": "<hashed_email>", "hem_type": "sha1"},
            {"hem": "<hashed_email>", "hem_type": "md5"},
        ]  
    }  
}