BidRequest.source

A Source object describing the upstream origin of the request and who makes the final sale decision, including the transaction ID and, since 2.6, the supply chain. Added in 2.5.

CurrentobjectOptionalSince 2.5

Field facts

Path
source
Object
BidRequest
Type
object
Requirement
Optional
Added
OpenRTB 2.5
Spec section
3.2.1

How it is used

Buyers use Source.tid to spot duplicate opportunities and Source.schain to verify the selling path. On 2.5 traffic the chain usually travels in source.ext.schain.

Example

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

{
  "id": "req-1",
  "source": {
    "fd": 0,
    "tid": "0b6a3c8e-4f1d-4c2b-9e7a-5d8f1a2b3c4d",
    "schain": {
      "ver": "1.0",
      "complete": 1,
      "nodes": [
        {
          "asi": "ssp.example",
          "sid": "pub-4791",
          "hp": 1
        }
      ]
    }
  }
}

Version history

Added in OpenRTB 2.5, and present in the latest snapshot. The table shows how each version's spec text types the field.

VersionsType in the specRequiredDeprecated
2.5objectNoNo
2.6-202210 to 2.6-202606objectNoNo

Related fields

Other BidRequest fields

For a walkthrough of the whole object, read Bid request anatomy.