Banner.topframe

Whether the slot is in the page's top frame (1) or inside an iframe (0). OpenRTB 2.0 to 2.2 gave it a default of 0; later versions state no default.

CurrentintegerOptionalSince 2.0

Field facts

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

How it is used

Creative that expands, reads the page, or runs measurement behaves differently inside a cross-domain iframe, so rich media buyers use the flag to choose a compatible creative.

Allowed values

0, 1.

Example

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

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

Common mistakes

Sending true or false; in spec JSON it is an integer flag.

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	integer, default 0 t m a	No	No
2.1 to 2.2	integer, default 0	No	No
2.3 to 2.3.1	integer	No	No
2.4	integer iframe, where 0 = no, 1 = yes.	No	No
2.5 to 2.6-202606	integer	No	No