Segment.value

The segment's value as a string, such as "high" or "25-34". Many segments are plain memberships and carry no value.

CurrentstringOptionalSince 2.0

Field facts

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

How it is used

The 2.0 text gave values like "male" or "30-40" as examples and left the format to be agreed with the provider. Numeric values are still sent as strings.

Example

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

{
  "id": "req-1",
  "user": {
    "data": [
      {
        "segment": [
          {
            "value": "25-34"
          }
        ]
      }
    ]
  }
}

Common mistakes

  • Sending a number or boolean instead of a string.

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.0stringNoNo
2.1string method negoti exampl “30-40NoNo
2.2stringNoNo
2.3 to 2.3.1stringNoNo
2.4stringNoNo
2.5 to 2.6-202606stringNoNo

Related fields

Other Segment fields