Data.segment
The provider's data values, as an array of Segment objects. Present since OpenRTB 2.0.
Field facts
- Path
user.data.segment,app.content.data.segment,dooh.content.data.segment,site.content.data.segment- Object
- Data
- Type
- object array
- Requirement
- Optional
- Added
- OpenRTB 2.0
- Spec section
- 3.2.21
How it is used
Most providers send only segment IDs and publish what each ID means; name and value are optional.
Example
Where the field sits in a payload, with everything else left out:
{
"id": "req-1",
"user": {
"data": [
{
"segment": [
{
"id": "aud-1042"
},
{
"id": "aud-2210",
"value": "high"
}
]
}
]
}
}Common mistakes
- Sending segment IDs as a bare array of strings instead of Segment objects.
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 | array of objects | No | No |
| 2.3 to 2.3.1 | object array | No | No |
| 2.4 | object array | No | No |
| 2.5 to 2.6-202606 | object array | No | No |