Link Search Menu Expand Document

PDF

Source Object

Demand Partners

BidRequest Object


BidRequest.source

This object describes the nature and behavior of the entity that is the source of the bid request upstream from the OpenX Ad Exchange. The primary purpose of this object is to define post-auction or upstream decisioning when the OpenX Ad Exchange itself does not control the final decision. A common example of this is header bidding.

To enable this object or receive more information, please contact your Business Development Manager.

Field nameData typeDescriptionSent?
fdintegerEntity responsible for the final impression sale decision.
   • 0 = OpenX Ad Exchange.
   • 1 = Upstream source. For example: header bidding.
Always
tidstringTransaction ID that is common across all participants in this bid request (for example, potentially multiple exchanges).Sometimes
pchainstringPayment ID chain string containing embedded syntax described in the TAG Payment ID Protocol v1.0.Always
extextensions objectAn object containing properties that describe custom fields for the bid request source.Always

Extensions object

BidRequest.source.ext

The optional Extensions object can provide additional details about the source of the bid request.

Field nameData typeDescriptionSent?
schainstringRepresents both the links in the supply chain as well as an indicator whether or not the supply chain is complete.Sometimes

SupplyChain object

BidRequest.source.ext.schain

The SupplyChain object enables buyers to see all parties who are selling or reselling a given bid request. If you would like to receive schain in your bid requests from OpenX, please contact your Platform Development Manager. For more information please see the official IAB spec.

To interpret the OpenX node of the schain object, you can reference OpenX’s sellers.json file that contains a list of all our supply partners at openx.com/sellers.json. To interpret the node of any other advertising system in the schain, simply append “/sellers.json” to the provided asi.

Field nameData typeDescriptionSent?
completeintegerFlag indicating whether the chain contains all nodes leading back to the source of the inventory, where 0 = no, 1 = yes.Always
nodesobject arrayArray of SupplyChainNode objects in the order of the chain. In a complete supply chain, the first node represents the initial advertising system and seller ID involved in the transaction (for example, the owner of the site, app, or other medium). In an incomplete supply chain, it represents the first known node. The last node represents the entity sending this bid request.Always

SupplyChainNode object

BidRequest.source.ext.schain.node

Field nameData typeDescriptionSent?
asistringThe 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.Always
sidstringThe identifier associated with the seller or reseller account within the advertising system. This must contain the same value used in transactions (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.Always
ridstringThe OpenRTB RequestId of the request as issued by this seller.Sometimes
hpintegerIndicates whether this node is 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 introduces 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.
Always