Video.companiontype

Companion resource types the slot accepts, from AdCOM List: Companion Types: 1 Static Resource, 2 HTML Resource, 3 iframe Resource. Recommended whenever Video.companionad is sent. Added in OpenRTB 2.1.

Currentinteger arrayOptionalSince 2.1

Field facts

Path: imp.video.companiontype
Object: Video
Type: integer array
Requirement: Optional
Added: OpenRTB 2.1
Values: AdCOM list Companion Types
Spec section: 3.2.7

How it is used

The values correspond to the StaticResource, HTMLResource, and IFrameResource elements of a VAST companion. If one companion renders as an end card, mark it with Banner.vcm on that Banner.

Allowed values

Value	Meaning
`1`	Static Resource: Static resource: an image the player displays directly, with a click-through.
`2`	HTML Resource: HTML resource: an HTML fragment supplied in the VAST document and inserted by the player.
`3`	iframe Resource: Iframe resource: a URL the player loads into an iframe to render the companion.

Example

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

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

Common mistakes

Sending Video.companionad without this field, which leaves buyers guessing which companion resources will render.

Version history

Added in OpenRTB 2.1, 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.1	Array of integer	No	No
2.2	array of integers	No	No
2.3 to 2.4	integer array	No	No
2.5	integer array	No	No
2.6-202210 to 2.6-202606	integer array	No	No