Video.boxingallowed

Whether a 4:3 video may be letterboxed, shown with bars, to fit a 16:9 player: 1 yes, 0 no. Defaults to 1, so only publishers that forbid letterboxing need to send it.

CurrentintegerOptionalSince 2.0

Field facts

Path: imp.video.boxingallowed
Object: Video
Type: integer
Default: 1
Requirement: Optional
Added: OpenRTB 2.0
Spec section: 3.2.7

How it is used

When it is 0, bidders should use creatives whose aspect ratio matches the player, working it out from Video.w and Video.h.

Allowed values

0, 1.

Example

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

{
  "id": "req-1",
  "imp": [
    {
      "video": {
        "boxingallowed": 1
      }
    }
  ]
}

Common mistakes

Sending true or false. It is an integer flag, and booleans trigger openrtb.dialect.bool_for_integer.
Sending 0 from a template by default, which tells buyers 4:3 creatives are unwelcome when the publisher has no such rule.

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.

Versions	Type in the spec	Required	Deprecated
2.0	integer	No	No
2.1	integer, default 1 p c w t w c a a a	No	No
2.2	integer, default 1	No	No
2.3 to 2.4	integer, default 1	No	No
2.5 to 2.6-202606	integer, default 1	No	No