Segment.id

The segment's ID within its data provider's namespace, as a string. Two providers can use the same ID for different things.

CurrentstringOptionalSince 2.0

Field facts

Path: user.data.segment.id, app.content.data.segment.id, dooh.content.data.segment.id, site.content.data.segment.id
Object: Segment
Type: string
Requirement: Optional
Added: OpenRTB 2.0
Spec section: 3.2.22

How it is used

When the parent Data object names a taxonomy, such as through segtax in its ext, the ID is a node in that taxonomy.

Example

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

{
  "id": "req-1",
  "user": {
    "data": [
      {
        "segment": [
          {
            "id": "aud-1042"
          }
        ]
      }
    ]
  }
}

Common mistakes

Sending the ID as a number. It is a string even when it looks numeric.

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	string	No	No
2.3 to 2.3.1	string	No	No
2.4	string	No	No
2.5 to 2.6-202606	string	No	No