Audio.companiontype

Companion resource types the audio slot accepts, from AdCOM List: Companion Types: 1 Static Resource, 2 HTML Resource, 3 iframe Resource. Recommended whenever Audio.companionad is present.

Currentinteger arrayOptionalSince 2.4

Field facts

Path: imp.audio.companiontype
Object: Audio
Type: integer array
Requirement: Optional
Added: OpenRTB 2.4
Values: AdCOM list Companion Types
Spec section: 3.2.8

How it is used

The 2.4 and 2.5 specs described these as DAAST companion types; 2.6 points to the shared AdCOM list.

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": [
    {
      "audio": {
        "companiontype": [
          1,
          2
        ]
      }
    }
  ]
}

Version history

Added in OpenRTB 2.4, 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.4	integer array	No	No
2.5	integer array	No	No
2.6-202210 to 2.6-202606	integer array	No	No

Related fields

Other Audio fields

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