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

Docs for new spotx bidder #1110

Merged
merged 3 commits into from
Feb 7, 2019
Merged

Docs for new spotx bidder #1110

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b59b548
Update SpotX Adapter Documentation
strider820 Jan 18, 2019
4f43e82
Update spotx.md
strider820 Jan 22, 2019
bb5f5fb
typo missing c in 'content_width'
strider820 Feb 7, 2019
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
45 changes: 30 additions & 15 deletions dev-docs/bidders/spotx.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,24 +12,39 @@ biddercode: spotx

biddercode_longer_than_12: false
media_types: video
prebid_1_0_supported: true
gdpr_supported: true

---

### bid params

{: .table .table-bordered .table-striped }
| Name | Scope | Description | Example | Type |
|------------------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------|-----------|
| `channel_id` | required | A unique 5 digit ID that is generated by the SpotX publisher platform when a channel is created | `'85394'` | `string` |
| `video_slot` | required | The video slot is the video object that the creative can use to render | `'contentElement'` | `string` |
| `slot` | required | HTML element on the page in which the ad is to be rendered. | `'content'` | `string` |
| `content_width` | optional | The desired width of the video ad placement. Requires content_height to also be set | `'640'` | `string` |
| `content_height` | optional | The desired height of the video ad placement. Requires content_width to also be set | `'480'` | `string` |
| `content_id` | optional | An identifier for the content that can be used for refinement and custom reporting | `'9876543210'` | `string` |
| `contentPageUrl` | optional | Set the url to be used for the content page, uses the current pages url by default | `'http://www.spotx.tv'` | `string` |
| `ados` | optional | See SpotX documentation [here](https://developer.spotxchange.com/content/local/docs/sdkDocs/DirectSdk/README.md#sending-query-parameters-to-spotmarket) | | `object` |
| `ad_volume` | optional | Value between 0 and 1 to denote the volume the ad should start at | | `float` |
| `hide_skin` | optional | Set to true to hide the spotx skin | | `boolean` |
| `autoplay` | optional | Set to true to attempt to play the ad as soon as it is loaded | | `boolean` |
| `ad_mute` | optional | Set to true to start the ad with the volume muted | | `boolean` |
| `custom` | optional | See SpotX documentation [here](https://developer.spotxchange.com/content/local/docs/sdkDocs/DirectSdk/README.md#custom-property-for-key-value-pair-reporting) | | `object` |
| Name | Scope | Description | Example | Type |
|----------------------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------|
| `channel_id` | required | A unique 5 digit ID that is generated by the SpotX publisher platform when a channel is created | `'85394'` | `string` |
| `ad_unit` | required | Token that describes which ad unit to play: instream or outstream | `'outstream'` | `string` |
| `outstream_function` | optional | Custom function to be used as a renderer. | `function(bid){console.log(bid);}` | `function` |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is the bid input parameter?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is the bid parameter that is passed to all renderers: http://prebid.org/dev-docs/show-outstream-video-ads.html#renderers

| `outstream_options` | optional | Object to set options on the renderer. See [outstream_options Object](#spotx-outstream-options-object) | `{}` | `object` |
| `secure` | optional | Boolean identifying whether the reqeusts should be https or not (used to override the protocol if the page isn't secure. | `true` | `boolean` |
| `mimes` | optional | List of mimetypes to allow in ad. | `['application/javascript', 'video/mp4', 'video/webm'] | `array` |
| `ad_volume` | optional | Value between 0 and 1 to denote the volume the ad should start at | | `float` |
| `price_floor` | optional | Set the current channel price floor in real time. | `10` | `integer` |
| `hide_skin` | optional | Set to true to hide the spotx skin | | `boolean` |
| `custom` | optional | See SpotX documentation [here](https://developer.spotxchange.com/content/local/docs/sdkDocs/DirectSdk/README.md#custom-property-for-key-value-pair-reporting) | | `object` |

<a name="spotx-outstream-options-object
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Link object seems to be broken

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When I ran this through a markdown parser, the link worked as expected. This github repo isn't parsing these right, but it should look correct when it's published.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

awesome. Thanks ❤️


#### outstream_options Object

{: .table .table-bordered .table-striped }
| Name | Scope | Description | Example | Type |
|----------------------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------|
| `slot` | required | ID of element that video ad should be rendered into. | `'adSlot1'` | `string` |
| `ad_mute` | optional | Set to true to start the ad with the volume muted. | `true` | `boolean` |
| `playersize_auto_adapt` | optional | Set to true to make video auto-adapt to the ad's dimensions | `true` | `boolean` |
| `in_iframe` | optional | ID of iFrame element to insert EASI script tag. | `'iframe1'` | `string` |
| `custom_override` | optional | Object of script tag attributes to override from the list here: [EASI Attributes](https://developer.spotxchange.com/content/local/docs/sdkDocs/EASI/README.md#common-javascript-attributes)
NOTES:
* exclude 'data-spotx_' from attribute name.
* channel_id, vast_url, content_page_url, and ad_unit overrides are ignored | `{content_height: 300, content_width: 400}` | `object` |