UserAgent.source

Where the object's data came from, as an integer from the AdCOM User-Agent Source list: 0 unspecified, 1 client hints with low-entropy values only, 2 client hints including high-entropy values, 3 parsed from the User-Agent string. Defaults to 0.

CurrentintegerOptionalSince 2.6-202204

Field facts

Path: device.sua.source
Object: UserAgent
Type: integer
Default: 0
Requirement: Optional
Added: OpenRTB 2.6-202204
Values: AdCOM list User-Agent Source
Spec section: 3.2.29

How it is used

Buyers use it to decide how much to trust the other fields. A value of 3 means the object was rebuilt from the same string as device.ua, so it adds structure but no new information.

Allowed values

Value	Meaning
`0`	Unspecified or unknown: The source of the structured user agent data is not known or not reported; this is the default.
`1`	Client Hints, low entropy only: Built from the Client Hints a browser sends by default: brands, major versions, mobile flag and platform.
`2`	Client Hints, with high entropy: Built from Client Hints including the high-entropy values, such as full versions, platform version and device model.
`3`	Parsed from the User-Agent header: Derived by parsing the same User-Agent string carried in `Device.ua`, with its frozen and reduced values.

Example

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

{
  "id": "req-1",
  "device": {
    "sua": {
      "source": 2
    }
  }
}

Common mistakes

Leaving it at the default 0 when the seller knows the source. Buyers then cannot tell real client hints from a parse.

Version history

Added in OpenRTB 2.6-202204, 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-202204	Added in the first 2.6 release, published without a structured text archive; the 2.6-202210 republication is the first tagged text.
2.6-202210 to 2.6-202606	integer, default 0	No	No

Related fields

Other UserAgent fields

For a walkthrough of the whole object, read User-agent client hints and sua.