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

Docs for new spotx bidder #1110

Merged
merged 3 commits into from
Feb 7, 2019
Merged

Docs for new spotx bidder #1110

merged 3 commits into from
Feb 7, 2019

Conversation

strider820
Copy link
Contributor

No description provided.

Copy link
Contributor

@muuki88 muuki88 left a comment

Choose a reason for hiding this comment

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

Yeeaah! 🎉 fixed documentation

Copy link
Contributor

@muuki88 muuki88 left a comment

Choose a reason for hiding this comment

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

Yeeaah! 🎉 fixed documentation

| `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, ontent_width: 400}` | `object` |
Copy link
Contributor

Choose a reason for hiding this comment

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

Typo content_width missing c

Copy link
Contributor Author

Choose a reason for hiding this comment

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

fixed, thanks!

| `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 ❤️

|----------------------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------|
| `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

@bretg
Copy link
Contributor

bretg commented Feb 7, 2019

released with pbjs 2.1 - merging

@bretg bretg merged commit 6be8d05 into prebid:master Feb 7, 2019
@muuki88
Copy link
Contributor

muuki88 commented Feb 8, 2019

Looks a bit weird. When I remove the {: table. ...} directives it looks a lot better. And the links seems to be broken.

https://prebid.org/dev-docs/bidders/spotx.html

@strider820
Copy link
Contributor Author

Ya, it's weird... I modeled after all the other .md files, that's why I expected the publish to change it. For example, the AppNexus page has all the same elements this one does... I'm not sure what's different.

https://prebid.org/dev-docs/bidders/appnexus.html
https://raw.githubusercontent.com/prebid/prebid.github.io/master/dev-docs/bidders/appnexus.md
https://github.com/prebid/prebid.github.io/blob/master/dev-docs/bidders/appnexus.md

@bretg any suggestions on what's wrong?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants