From 06af1954803e3961c9086d3078c1c863f7d6f1d4 Mon Sep 17 00:00:00 2001 From: Shannon Broekhoven Date: Fri, 6 Jul 2018 11:20:27 -0400 Subject: [PATCH 1/5] Add documentation on Sortable adapter --- dev-docs/bidders/sortable.md | 65 ++++++++++++++++++++++++++++++++++++ 1 file changed, 65 insertions(+) create mode 100644 dev-docs/bidders/sortable.md diff --git a/dev-docs/bidders/sortable.md b/dev-docs/bidders/sortable.md new file mode 100644 index 0000000000..a905d9258f --- /dev/null +++ b/dev-docs/bidders/sortable.md @@ -0,0 +1,65 @@ +--- +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` | required | The site ID from Sortable. To blanket set the site ID, [see here](#sortable-configuration). Please reach out to your Sortable Account Manager for more details. | `1` or `"example.com"` | +| `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 + +If the Sortable site ID is set globally, `siteId` is not required as a bid param. How to do so: + +```javascript +$$PREBID_GLOBAL$$.setConfig({ + sortableId: "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 +$$PREBID_GLOBAL$$.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. From e3c401dba941fe13610245d1173d2120c9c75607 Mon Sep 17 00:00:00 2001 From: Bryan Gahagan Date: Mon, 9 Jul 2018 19:36:51 -0400 Subject: [PATCH 2/5] move global sortable config into its own object --- dev-docs/bidders/sortable.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/dev-docs/bidders/sortable.md b/dev-docs/bidders/sortable.md index a905d9258f..9625fc7107 100644 --- a/dev-docs/bidders/sortable.md +++ b/dev-docs/bidders/sortable.md @@ -26,7 +26,7 @@ gdpr_supported: true | Name | Scope | Description | Example | |------+-------+-------------+---------| | `tagId` | required | The tag ID from Sortable. | `"test-pb-leaderboard"` | -| `siteId` | required | The site ID from Sortable. To blanket set the site ID, [see here](#sortable-configuration). Please reach out to your Sortable Account Manager for more details. | `1` or `"example.com"` | +| `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"` | | `keywords` | optional | Publisher-defined key-value string pairs | `{ "key1": "val1", "key2": "val2" }` | @@ -43,12 +43,14 @@ Sortable supports the banner features described in: ### Configuration -If the Sortable site ID is set globally, `siteId` is not required as a bid param. How to do so: +The Sortable site ID should be set globally in order to improve user sync. How to do so: ```javascript $$PREBID_GLOBAL$$.setConfig({ - sortableId: "example.com" - }}); + sortable { + siteId: "example.com" + } +}); ``` The Sortable adapter has the ability to initiate user-sync requests that will improve DSP user ID match rate, From 1da9f14c974fce3737062a634d1ce5d34c26c010 Mon Sep 17 00:00:00 2001 From: Bryan Gahagan Date: Tue, 10 Jul 2018 10:11:54 -0400 Subject: [PATCH 3/5] use pbjs instead of $$PREBID_GLOBAL$$ --- dev-docs/bidders/sortable.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/dev-docs/bidders/sortable.md b/dev-docs/bidders/sortable.md index 9625fc7107..74da460ad7 100644 --- a/dev-docs/bidders/sortable.md +++ b/dev-docs/bidders/sortable.md @@ -46,7 +46,7 @@ Sortable supports the banner features described in: The Sortable site ID should be set globally in order to improve user sync. How to do so: ```javascript -$$PREBID_GLOBAL$$.setConfig({ +pbjs.setConfig({ sortable { siteId: "example.com" } @@ -57,7 +57,7 @@ The Sortable adapter has the ability to initiate user-sync requests that will im 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 -$$PREBID_GLOBAL$$.setConfig({ +pbjs.setConfig({ userSync: { enabledBidders: ['sortable'], iframeEnabled: true From f49927c7d3071cf66a1204bb9c2ce70f87447c4c Mon Sep 17 00:00:00 2001 From: Bryan Gahagan Date: Tue, 10 Jul 2018 19:11:21 -0400 Subject: [PATCH 4/5] fix config example --- dev-docs/bidders/sortable.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/dev-docs/bidders/sortable.md b/dev-docs/bidders/sortable.md index 74da460ad7..4db3df5b55 100644 --- a/dev-docs/bidders/sortable.md +++ b/dev-docs/bidders/sortable.md @@ -47,7 +47,7 @@ The Sortable site ID should be set globally in order to improve user sync. How t ```javascript pbjs.setConfig({ - sortable { + sortable: { siteId: "example.com" } }); From 7275ec83fa9e131e07adf0594eedb9a086fb1d95 Mon Sep 17 00:00:00 2001 From: Bryan Gahagan Date: Tue, 10 Jul 2018 21:00:47 -0400 Subject: [PATCH 5/5] document floor param --- dev-docs/bidders/sortable.md | 1 + 1 file changed, 1 insertion(+) diff --git a/dev-docs/bidders/sortable.md b/dev-docs/bidders/sortable.md index 4db3df5b55..5e7c3f918a 100644 --- a/dev-docs/bidders/sortable.md +++ b/dev-docs/bidders/sortable.md @@ -27,6 +27,7 @@ gdpr_supported: true |------+-------+-------------+---------| | `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" }` |