Banner.id

Identifier for this Banner object. Recommended when Banner objects describe companion slots for a Video, where values usually start at 1, increase by one, and should be unique within the impression.

CurrentstringOptionalSince 2.0

Field facts

Path: imp.banner.id, imp.audio.companionad.id, imp.video.companionad.id
Object: Banner
Type: string
Requirement: Optional
Added: OpenRTB 2.0
Spec section: 3.2.6

How it is used

In a companion array the id lets a buyer tell two slots of the same size apart. VAST 3 and later can aim a companion at a specific slot with the adSlotID attribute on the Companion element.

Example

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

{
  "id": "req-1",
  "imp": [
    {
      "banner": {
        "id": "1"
      }
    }
  ]
}

Common mistakes

Sending a number, such as 1, instead of the string "1".

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 to 2.2	string	No	No
2.3 to 2.3.1	string	No	No
2.4	array	No	No
2.5 to 2.6-202606	string	No	No