Source Object

Note

Fields marked with asterisk (*) are optional.

Parameter	Type	Description
fd*	integer	Indicates the entity responsible for the final impression sale decision.
tid	string	Transaction ID that must be common across all participants in this bid request.
pchain*	string	Payment ID chain string containing embedded syntax described in the TAG.
schain	object	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.
ext*	object	Contains additional fields, see Source Extension.

Source Ext

Parameter	Type	Description
omidpn	string	Identifier of the OM SDK integration, the IAB Open Measurement specification on Github.
omidpv	string	Version of the OM SDK integration.

SupplyChain Object

Parameter	Type	Description
complete	integer	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 objects in the order of placing in the chain. The original source of the request is first and the final seller of the request last, see Supply Chain Nodes.
ver	string	Version of the supply chain specification in use. Currently “1.0” is the only option.

Supply Chain Nodes

Parameter	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.
sid	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.
hp	integer	Indicates whether this node will be involved in the flow of payment for the inventory.
rid*	string	The OpenRTB RequestId of the request as issued by this seller.
name*	string	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*	string	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.json file.

Source Object Example

{
    "source":{
        "fd":1,
        "tid":"FEDCBA9876543210",
        "schain":{
            "complete":0,
            "ver":"1.0",
            "nodes":[
                {
                    "asi":"reseller.com",
                    "sid":"aaaaa",
                    "rid":"BidRequest4",
                    "hp":1
                }
            ]
        }
    }
}