Video.battr

Creative attributes the seller blocks for this video slot, as integers from AdCOM List: Creative Attributes. A creative whose Bid.attr includes a blocked value is not eligible.

Currentinteger arrayOptionalSince 2.0

Field facts

Path
imp.video.battr
Object
Video
Type
integer array
Requirement
Optional
Added
OpenRTB 2.0
Values
AdCOM list Creative Attributes
Spec section
3.2.7

How it is used

A seller with non-skippable inventory can block 16, the creative providing its own skip button. Values 21 to 23 describe motion: static visual, limited motion, and full-motion video, which lets a CTV seller refuse static or lightly animated creatives in a video slot. Values 500 and above are vendor-specific. Before 2.6 the values came from OpenRTB's own creative attributes table.

Allowed values

ValueMeaning
1Audio Ad (Autoplay): The ad plays sound without any user action.
2Audio Ad (User Initiated): The ad plays sound only after the user acts, for example by clicking or tapping.
3Expandable (Automatic): The ad expands beyond its initial size on its own, without user interaction.
4Expandable (User Initiated - Click): The ad expands when the user clicks or taps it.
5Expandable (User Initiated - Rollover): The ad expands when the user moves the pointer over it.
6In-Banner Video Ad (Autoplay): A display unit that contains video which starts playing by itself.
7In-Banner Video Ad (User Initiated): A display unit that contains video which plays only after the user starts it.
8Pop (e.g., Over, Under, or Upon Exit): The ad opens a new window or layer over or under the page, or when the user leaves.
9Provocative or Suggestive Imagery: The ad contains provocative or suggestive imagery that a publisher may consider inappropriate.
10Shaky, Flashing, Flickering, Extreme Animation, Smileys: The ad uses shaking, flashing, flickering or other extreme animation.
11Surveys: The ad asks the user to answer a survey or questionnaire.
12Text Only: The ad is text only, with no images or video.
13User Interactive (e.g., Embedded Games): The ad is interactive, for example an embedded game or a configurator.
14Windows Dialog or Alert Style: The ad imitates an operating system dialog or alert box, a pattern often used to mislead users.
15Has Audio On/Off Button: The ad has its own control for turning sound on and off.
16Ad Provides Skip Button: The creative renders its own skip button, as VPAID pre-roll units sometimes do, separate from any skip control in the player.
17Adobe Flash: The ad uses Adobe Flash, which current browsers no longer run; blocklists still carry it.
18Responsive, sizeless or fluid: The creative resizes itself to fit the space it is given instead of using fixed dimensions.
19Contains advertiser QR code: The creative shows a QR code from the advertiser, useful on CTV and DOOH screens, where viewers cannot click.
20Supports alpha channel transparency: The creative has transparent regions meant to be composited over content, which overlay formats often require.
21Static visual: The creative has no visible motion, even when it is delivered as a video file.
22Limited motion (cinemagraph): The creative is mostly still, with small looping movement in part of the frame.
23Full-motion video: The creative has continuous, scene-level motion like ordinary video.
500+Vendor-specific codes: Vendor-specific attributes defined by an exchange and agreed with its buyers.

Example

Where the field sits in a payload, with everything else left out:

{
  "id": "req-1",
  "imp": [
    {
      "video": {
        "battr": [
          13,
          14,
          16
        ]
      }
    }
  ]
}

Common mistakes

  • Expecting an absent list to block anything. With no list, every attribute is allowed.
  • Sending attribute names or strings instead of integers.

Version history

Added in OpenRTB 2.0, and present in the latest snapshot. The table shows how each version's spec text types the field.

VersionsType in the specRequiredDeprecated
2.0array of teger all a alloNoNo
2.1array of integerNoNo
2.2array of integersNoNo
2.3 to 2.4integer arrayNoNo
2.5integer arrayNoNo
2.6-202210 to 2.6-202606integer arrayNoNo

Related fields

Other Video fields

For a walkthrough of the whole object, read Video object guide.