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 smartx.md markdown for docs #2272

Merged
merged 5 commits into from
Aug 26, 2020
Merged
Changes from 4 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
43 changes: 43 additions & 0 deletions dev-docs/bidders/smartx.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
layout: bidder
title: smartx
description: Prebid smartx Bidder Adaptor
Copy link
Contributor

Choose a reason for hiding this comment

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

Typo: Adaptar

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Can it be that both of us are wrong?
https://github.com/prebid/Prebid.js/tree/master/modules
All modules here are named with "e" in Adapter.

Copy link
Contributor

Choose a reason for hiding this comment

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

Indeed 😂 Mixing german and english makes my english so much worst 😬

biddercode: smartx
media_types: no-display, video
gdpr_supported: true
tcf2_supported: true
userIds: id5Id, pubCommonId
prebid_member: true
schain_supported: true
usp_supported: true
safeframes_ok: false
pbjs: true
---

### Bid Params

{: .table .table-bordered .table-striped }
| Name | Scope | Description | Example | Type |
|----------------------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------|
| `tagId` | required | A unique ID. | `'Nu68JuOWAvrbzoyrOR9a7A'` | `string` |
| `publisherId` | required | A unique PublisherID. | `'publisher_Id'` | `string` |
| `siteId` | required | A unique SiteID. | `'site_id'` | `string` |
| `bidfloor` | required | Value of Bidfloor. | `0.3` | `float` |
| `bidfloorcur` | required | Used Currency. (e.g. EUR, USD etc.) | `'EUR'` | `string` |
| `context` | required | Token that describes which context to play: 'instream' or 'outstream' | `'outstream'` | `string` |
Copy link
Contributor

Choose a reason for hiding this comment

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

It's not required as far as I can see in the implementation. Maybe this can be removed completely and only the mediaType.video.context parameter is being used.

Copy link
Contributor

Choose a reason for hiding this comment

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

Changed to optional

| `outstream_function` | optional | Custom function to be used as a renderer. | `function(bid){console.log(bid);}` | `function` |
| `outstream_options` | optional | Object to set options on the smartx renderer. | `{}` | `object` |
Copy link
Contributor

Choose a reason for hiding this comment

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

These are required for context outstream.

Copy link
Contributor

Choose a reason for hiding this comment

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

Changed to required with further description

| `secure` | optional | Boolean identifying whether the requests should be https or not (used to override the protocol if the page isn't secure). | `true` | `boolean` |
| `mimes` | optional | List of MIME types to allow in ad. | `['application/javascript', 'video/mp4', 'video/webm']` | `array` |
| `price_floor` | optional | Set the current channel price floor in real time. | `10` | `integer` |
| `min_duration` | optional | Minimum video ad duration in seconds | | `integer` |
| `max_duration` | optional | Maximum video ad duration in seconds | | `integer` |

<a name="smartx-outstream-options-object" />

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