Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix misspelling and minor cleanup of schain docs #4150

Merged
merged 1 commit into from
Sep 4, 2019
Merged

Fix misspelling and minor cleanup of schain docs #4150

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 10 additions & 9 deletions modules/schain.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
# schain module

Aggregators who manage Prebid wrappers on behalf of multiple publishers need to declare their intermediary status in the Supply Chain Object.
As the spec prohibits us from adding upstream intermediaries, Prebid requests in this case need to come with the schain information.
In this use case, it's seems cumbersome to have every bidder in the wrapper separately configured the same schain information.
Aggregators who manage Prebid wrappers on behalf of multiple publishers and handle payment on behalf of the publishers
need to declare their intermediary status in the Supply Chain Object. As the Supply Chain Object spec prohibits SSPs from adding
upstream intermediaries, Prebid requests in this case need to come with the schain information. In this use case, it's cumbersome
to have every bidder in the wrapper separately configured the same schain information.

Refer:
- https://iabtechlab.com/sellers-json/
- https://github.com/InteractiveAdvertisingBureau/openrtb/blob/master/supplychainobject.md
- https://github.com/InteractiveAdvertisingBureau/openrtb/blob/master/supplychainobject.md

## Sample code for passing the schain object
```
pbjs.setConfig( {
Expand All @@ -26,16 +27,16 @@ pbjs.setConfig( {
{
"asi":"indirectseller-2.com",
"sid":"00002",
"hp":0
"hp":1
},
]
}
}
}
});
```

## Workflow
The schain module is not enabled by default as it may not be neccessary for all publishers.
The schain module is not enabled by default as it may not be necessary for all publishers.
If required, schain module can be included as following
```
$ gulp build --modules=schain,pubmaticBidAdapter,openxBidAdapter,rubiconBidAdapter,sovrnBidAdapter
Expand All @@ -47,4 +48,4 @@ You may refer pubmaticBidAdapter implementaion for the same.
## Validation modes
- ```strict```: It is the default validation mode. In this mode, schain object will not be passed to adapters if it is invalid. Errors are thrown for invalid schain object.
- ```relaxed```: In this mode, errors are thrown for an invalid schain object but the invalid schain object is still passed to adapters.
- ```off```: In this mode, no validations are performed and schain object is passed as is to adapters.
- ```off```: In this mode, no validations are performed and schain object is passed as is to adapters.