diff --git a/dev-docs/bidders/sortable.md b/dev-docs/bidders/sortable.md new file mode 100644 index 0000000000..5e7c3f918a --- /dev/null +++ b/dev-docs/bidders/sortable.md @@ -0,0 +1,68 @@ +--- +layout: bidder +title: Sortable +description: Prebid Sortable Bidder Adaptor +top_nav_section: dev_docs +nav_section: reference +biddercode: sortable +biddercode_longer_than_12: false +hide: true +prebid_1_0_supported : true +media_types: banner +gdpr_supported: true +--- + +**Table of Contents** + +- [Bid params](#sortable-bid-params) +- [Banner Ads](#sortable-banner) +- [Configuration](#sortable-configuration) + + + +### Bid params + +{: .table .table-bordered .table-striped } +| Name | Scope | Description | Example | +|------+-------+-------------+---------| +| `tagId` | required | The tag ID from Sortable. | `"test-pb-leaderboard"` | +| `siteId` | optional | Override the global Sortable site ID, [see here](#sortable-configuration). Please reach out to your Sortable Account Manager for more details. | `"example.com"` | +| `floor` | optional | The minumum CPM (in USD) requred to participate | `0.25` | +| `keywords` | optional | Publisher-defined key-value string pairs | `{ "key1": "val1", "key2": "val2" }` | + + + +### Banner Ads + +Sortable supports the banner features described in: + +- [The `adUnit` banner documentation]({{site.baseurl}}/dev-docs/adunit-reference.html#adUnit-banner-example) +- [Getting Started for Developers]({{site.baseurl}}/dev-docs/getting-started.html) + + + + +### Configuration + +The Sortable site ID should be set globally in order to improve user sync. How to do so: + +```javascript +pbjs.setConfig({ + sortable: { + siteId: "example.com" + } +}); + ``` + +The Sortable adapter has the ability to initiate user-sync requests that will improve DSP user ID match rate, +with the aim of generating higher bid prices. By default, Sortable sync requests are off. Setting the Sortable site ID globally as described above is required for user-sync requests. + +```javascript +pbjs.setConfig({ + userSync: { + enabledBidders: ['sortable'], + iframeEnabled: true + }}); +``` + +Note: these configs should be combined with any other UserSync config calls, as subsequent calls to setConfig for the same attribute overwrite each other.