Companion types
Companion Types lists the resource formats a player accepts for companion ads, the display units shown next to a video or audio ad: a static image, an inline HTML snippet, or an iframe URL. Requests carry it in Video.companiontype and Audio.companiontype, alongside the companion slots described in Video.companionad or Audio.companionad.
Values
| Value | Name | What it means |
|---|---|---|
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. |
Fields that use this list
How to use it
The three values match the three resource types a VAST companion can use. The list has not changed since OpenRTB 2.1 added Video.companiontype; Audio.companiontype followed in 2.4. The spec recommends sending the field whenever companion slots are offered, and a companion that will render as an end card can be marked with Banner.vcm on that slot.
Common mistakes
- Offering companion slots in
Video.companionadwithoutVideo.companiontype. Buyers cannot tell which resource formats the slot can render. - Listing 2 or 3 on a device that can only draw images. The companion then fails to render even when the video plays.
Validation
On OpenRTB 2.6 snapshots, RTBlint reports a value outside this list as openrtb.value.invalid. Paste a request into the tester to check the values you send.
Related lists
- Plcmt subtypes (video)
- Creative subtypes (audio and video)
- Playback methods
- Playback cessation modes
- Start delay modes
- Linearity modes
- Delivery methods
- Feed types
- Volume normalization modes
- Pod deduplication
- Pod sequence
- Slot position in pod
- Production qualities
All lists are on the enumerated lists index.