Video.companionad

Companion display slots offered alongside the video, each described as a Banner object with its own size and settings. Absent means no companion slots are available.

Currentobject arrayOptionalSince 2.0

Field facts

Path: imp.video.companionad
Object: Video
Type: object array
Requirement: Optional
Added: OpenRTB 2.0
Spec section: 3.2.7

How it is used

Give each companion Banner an Banner.id, which the spec recommends for companions, counting up from 1, and declare accepted resource types in Video.companiontype. Banner.vcm set to 1 marks a companion that renders as an end card after the video; 0 shows it alongside. The creative supplies its companions in the VAST document, sized to these slots.

Example

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

{
  "id": "req-1",
  "imp": [
    {
      "video": {
        "companionad": [
          {
            "id": "1",
            "w": 300,
            "h": 250,
            "vcm": 0
          }
        ]
      }
    }
  ]
}

Common mistakes

Sending a single Banner object instead of an array.
Offering companion slots the player cannot render, which leads buyers to build companion creative that never shows.

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	array of jects avai	No	No
2.1	array of objects, default Not available t b O	No	No
2.2	array of objects, default Not availa	No	No
2.3 to 2.4	object array	No	No
2.5 to 2.6-202606	object array	No	No