Audio.companionad

Companion display slots offered alongside the audio ad, each described as a Banner object. Absent means no companion slots.

Currentobject arrayOptionalSince 2.4

Field facts

Path
imp.audio.companionad
Object
Audio
Type
object array
Requirement
Optional
Added
OpenRTB 2.4
Spec section
3.2.8

How it is used

In a music or podcast app the companion is often the only visual element an audio campaign gets, shown in the player while the ad plays. Give each companion Banner an Banner.id and declare resource types in Audio.companiontype.

Example

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

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

Common mistakes

  • Setting Banner.vcm on audio companions. The spec defines it only for companions of a Video object.
  • Sending a single Banner object instead of an array.

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.

VersionsType in the specRequiredDeprecated
2.4object arrayNoNo
2.5 to 2.6-202606object arrayNoNo

Related fields

Other Audio fields

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