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.
pchain	string	Payment ID chain string containing embedded syntax described in the TAG Payment ID Protocol v1.0.
tid	string	(Required) Transaction ID
ext*	object	The source external object.

Source Ext Object

Source Ext Object Properties

Value	Type	Description
wrapper	str	Specifies the header bidding wrapper, e.g. "Prebid_js"
wrapper_version	str	Specifies the header bidding wrapper version, e.g. "4.0"
schain	object	Contains the supplychain 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

Supply Chain Object

Supply Chain Object Properties

Value	Type	Description
ver	string	Version of the supply chain specification in use.
complete	integer	Flag indicating whether the chain contains all nodes leading back to the source of the inventory, 1 for Yes and 0 for No.
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.

Supply Chain nodes

Supply Chain Nodes

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.
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. When set to 1, the advertising system in the asi field pays the seller in the sid field, who is responsible for paying the previous node in the chain. When set to 0, this node is not involved in the flow of payment for the inventory. For version 1.0 of SupplyChain, this property should always be 1. It is explicitly required to be included as it is expected that future versions of the specification will introduce non-payment handling nodes. Implementers should ensure that they support this field and propagate it onwards when constructing SupplyChain objects in bid requests sent to a downstream advertising system.
rid	string	The OpenRTB RequestId of the request as issued by this seller.