Supply Chain Object Module

• How to Use the Module
  • Global Supply Chains
  • Bidder-Specific Supply Chains
  • Global and Bidder-Specific Together
• SChain Config Syntax
• Adapter Information
• Adapters Supporting the schain Module
• Further Reading

Service Providers who manage Prebid wrappers on behalf of multiple publishers and handle payments to the publishers need to declare their intermediary status in the Supply Chain (a.k.a SChain) object. The IAB OpenRTB SupplyChain Object Specification prohibits SSPs from adding upstream intermediaries, so publishers or Prebid.js managed service providers need to specify schain information.

Two modes are supported:

• Global Supply Chains
  Use this configuration when the Prebid.js implementation is managed by an entity that needs to add an SChain node to every bid request. i.e. payments flow through this entity for all traffic.

• Bidder-Specific Supply Chains
  Use this configuration when one or more bid adapters is an entity (such as a reseller) that requires an SChain node, but other adapters do not require the node. e.g. payments flow through a bidder that doesn’t add its own schain node.

How to Use the Module

Since Prebid 10, schain is treated as first party data: this module just copies schain.config into ortb2.source.ext.schain. You may provide it (or ortb2.source.schain) directly, removing the need for this module. Note that bidder-specific first party data is merged with global first party data, while up until Prebid 9 bidder-specific schains override the global schain. The simplest way to upgrade to 10 is to avoid using both.

First, build the schain module into your Prebid.js package:

gulp build --modules=schain,...

The module performs validations on the schain data provided and makes it available to bidder adapters on the bidRequest object.

Global Supply Chains

Call setConfig with the schain object to be used:

pbjs.setConfig({
  "schain": {
    "validation": "strict",
    "config": {
      "ver":"1.0",
      "complete": 1,
      "nodes": [
        {
          "asi":"indirectseller.com",
          "sid":"00001",
          "hp":1
        }
      ]
    }
  }
});

Bidder-Specific Supply Chains

This method uses the pbjs.setBidderConfig function, with a syntax similar to the global scenario above.

pbjs.setBidderConfig({
  "bidders": ['bidderA'],   // can list more bidders here if they share the same config
  "config": {
    "schain": {
      "validation": "relaxed",
      "config": {
        "ver":"1.0",
        "complete": 1,
        "nodes": [
          {
            "asi":"bidderA.com",
            "sid":"00001",
            "hp":1
          }
        ]
      }
    }
  }
});

You can find more information about the pbjs.setBidderConfig function in the Publisher API Reference.

Prebid 10 : You can either use above method or ortb2.source.schain property to pass schain. You can read more about passing First Party Data. As far as precedence is concerned, ortb2.source.schain property takes precedence over the schain config setup via pbjs.setConfig using above mentioned method.

Global and Bidder-Specific Together

Yes, you can set both global and bidder-specific SChain configs. When together, the schain config setup via pbjs.setConfig acts as a global config that applies to all your bidders, while pbjs.setBidderConfig overrides the global config for the noted bidder(s).

SChain Config Syntax

Prebid 10 : Validation will be automatically performed by the validationFpdModule if you have included it in your Prebid.js build. If the skipValidation parameter is set to true in the validationFpdModule configuration, validation will be skipped. Please visit the validationFpdModule documentation for more information.

Adapter Information

Prebid 10 : Adapters can read bidderRequest.ortb2.source.ext.schain instead of bidRequest.schain.

Adapters can read the bidRequest.schain object and pass it through to their endpoint. The adapter does not need to be concerned about whether a bidder-specific schain was provided; the system will provide the relevant one.

Adapters Supporting the schain Module

Further Reading

• IAB OpenRTB SupplyChain Object Specification
• Sellers.json Specification