Source Object

Note

Fields marked with an asterisk (*) are optional.

Source Object Properties
Value Type Description
fd integer

Indicates the entity responsible for the final impression sale decision, using the following values:

  • 0 = The exchange behind BidSwitch
  • 1 = An upstream source (usually header bidder)

For example a bid request containing ext.ssp='rubicon' and source.fd=0 implies that the auction is run at Rubicon SSP. If the same request has source.fd=1 then the auction is run at a header bidder upstream from Rubicon SSP.

Note: The BidSwitch platform never acts as the decision maker.

pchain* string Payment ID chain string containing embedded syntax described in the TAG Payment ID Protocol v1.0.
ext* object Contains additional fields, see Source Extension

Source Extension

Source Extension Object Properties
Value Type Description
schain object

Contains the supplychain object, as fully described here on the IAB Github Page:

The SupplyChain object is composed primarily of a set of nodes where each node represents a specific entity that participates in the selling of a bid request. The entire chain of nodes from beginning to end would represent all sellers who were paid for an individual bid request.

SupplyChain Object

Important

Currently, this field is a new addition to the OpenRTB Specification, and as part of verifying the information passed in it requires Suppliers to provides a valid sellers.json file. The details of which can be found here: IAB sellers.json Spec

It is expected that adoption of this process will take a few months, similar to the ads.txt adoption process.

schain
Value Type Description
complete int Flag indicating whether the chain contains all nodes leading back to the source of the inventory, where 0 = no, 1 = yes.
nodes array of objects Array of SupplyChainNode objects in the order of the chain. The original source of the request is first and the final seller of the request last, see Supply Chain Nodes

Supply Chain Nodes

supply chain node
Value Type Description
asi string The canonical domain name of the SSP, Exchange, Header Wrapper, etc system that bidders connect to. This may be the operational domain of the system, if that is different than the parent corporate domain, to facilitate WHOIS and reverse IP lookups to establish clear ownership of the delegate system. This should be the same value as used to identify sellers in an ads.txt file if one exists.
pid string The identifier associated with the seller or reseller account within the advertising system. This must contain the same value used in transactions (i.e. OpenRTB bid requests) in the field specified by the SSP/exchange. Typically, in OpenRTB, this is publisher.id. For OpenDirect it is typically the publisher’s organization ID.Should be limited to 64 characters in length.
rid* int The OpenRTB RequestId of the request as issued by this seller.
name* int The business name of the entity represented by this node. This value is optional and should NOT be included if it exists in the advertising system’s sellers.txt file.
domain* int The business domain name of the entity represented by this node. This value is optional and should NOT be included if it exists in the advertising system’s sellers.txt file.

Example Source JSON

{
    "source":{
        "fd":1,
        "ext":{
            "schain":{
                "complete":0,
                "nodes":[
                    {
                        "asi":"reseller.com",
                        "pid":"aaaaa",
                        "rid":"BidRequest4"
                    }
                ]
            }
        }
    }
}