Imp.instl

Interstitial flag: 1 when the ad is shown full screen or as an interstitial, 0 when it is not. Defaults to 0.

CurrentintegerOptionalSince 2.0

Field facts

Path
imp.instl
Object
Imp
Type
integer
Default
0
Requirement
Optional
Added
OpenRTB 2.0
Spec section
3.2.4

How it is used

Interstitial slots normally list full-screen sizes in Banner.format or a video player sized to the screen. Buyers use the flag to choose creative built for full-screen display.

Allowed values

0, 1.

Example

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

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

Common mistakes

  • Sending true or false instead of 1 or 0. In spec JSON it is an integer, and the validator reports openrtb.dialect.bool_for_integer, which usually means a protobuf JSON serializer built the payload.

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.

VersionsType in the specRequiredDeprecated
2.0 to 2.1integer, default 0 screenNoNo
2.2integer, default 0 screenNoNo
2.3 to 2.4integer, default 0NoNo
2.5 to 2.6-202606integer, default 0NoNo

Related fields

Other Imp fields

For a walkthrough of the whole object, read Bid request anatomy.