RefSettings.reftype

What triggers the refresh: 0 unknown, 1 a user action such as scrolling, 2 an event such as a live score changing, 3 a fixed time interval. Values come from the AdCOM 1.0 Auto Refresh Triggers list. Defaults to 0 and is recommended.

CurrentintegerRecommendedSince 2.6-202303

Field facts

Path: imp.refresh.refsettings.reftype
Object: RefSettings
Type: integer
Default: 0
Requirement: Recommended
Added: OpenRTB 2.6-202303
Values: AdCOM list Auto Refresh Triggers
Spec section: 3.2.34

How it is used

Time-based refresh (3) draws the most buyer scrutiny, because it keeps serving ads even when nobody interacts with the page. Send the real trigger rather than 0 whenever you know it.

Allowed values

Value	Meaning
`0`	Unknown: The slot refreshes, but the trigger is unknown or not reported; this is the default when `reftype` is absent.
`1`	User Action: The refresh follows something the user did, such as scrolling, swiping or changing a tab.
`2`	Event: The refresh follows a change in the content, such as a live score update, with no user action.
`3`	Time: The slot refreshes on a fixed timer, whether or not the user is active.

Example

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

{
  "id": "req-1",
  "imp": [
    {
      "refresh": {
        "refsettings": [
          {
            "reftype": 3
          }
        ]
      }
    }
  ]
}

Common mistakes

Leaving it at the default 0 for a slot known to refresh on a timer, which hides the case buyers care about most.

Version history

Added in OpenRTB 2.6-202303, 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.6-202303	Listed in this release's notes; IAB's tagged spec file for it does not include the field yet.
2.6-202309 to 2.6-202606	integer, default 0	Recommended	No