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.

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

Add documentation on Sortable adapter #872

Merged
merged 5 commits into from Aug 2, 2018
Merged
Changes from all commits
Commits
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
68 changes: 68 additions & 0 deletions dev-docs/bidders/sortable.md
Original file line number Diff line number Diff line change
@@ -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)

<a name="sortable-bid-params" />

### 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" }` |

<a name="sortable-banner" />

### 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)


<a name="sortable-configuration" />

### 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.