Skip to content

Commit dd45221

Browse files
Skylinarsmartclip-adtechjeanstemp
authored
smartx Bid Adapter: refactor descriptions and adding "visibilityThreshold" (#3403)
* initial commit * adjustments * adjustments * adjustments * typo, further adjustments * removed userIds and schain support * Added optionals to outstream and made formatting * Update smartx.md minor edits for clarification and readability. * adjusted outstream_options * remove outstream_function, added pbjs_version_notes * bugfix outstream options for default outstream renderer configuration * refactor descriptions and adding "visibilityThreshold" Co-authored-by: Gino <[email protected]> Co-authored-by: Jean Stemp <[email protected]>
1 parent 340443d commit dd45221

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

dev-docs/bidders/smartx.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -43,10 +43,11 @@ Please reach out to your smartclip business contact for any questions and assist
4343
| Name | Scope | Description | Example | Type |
4444
| --------------- | -------- | -------------------------------------------------------------------------------------------- | ---------------- | ----------- |
4545
| `slot` | required | ID of element that video ad should be rendered into. | `'adSlot1'` | `string` |
46-
| `minAdWidth` | optional | Minimum amount of space the player needs to expand. | `290` | `integer` |
47-
| `maxAdWidth` | optional | Maximum size of the player. | `900` | `integer` |
48-
| `title` | optional | Makes a defined advertising text appear in the below right corner. `[remainingTime]` can be used to display the remaining time of the advertisement. | `'Advertisement [remainingTime]s'` | `string` |
49-
| `skipOffset` | optional | Define whenever the advertisement can be skipped. 0 = never | `0` | `integer` |
50-
| `startOpen` | optional | Define whether the player should be initialized open or open when it is within view. | `'false'` | `string` |
51-
| `endingScreen` | optional | Define whether the player should stay open after advertising or not. | `'true'` | `string` |
52-
| `desiredBitrate`| optional | Define the desired bitrate of the mediafile. | `800` | `integer` |
46+
| `minAdWidth` | optional | If the visible area is narrower than this size, no ad will be requested. The value is given in pixels. Default is `280`. | `290` | `integer` |
47+
| `maxAdWidth` | optional | The player will fill the whole width of the element it gets, to have it narrower a different maximum width can be defined in pixels. Default is `800`. | `900` | `integer` |
48+
| `title` | optional | The player can show a freely definable text, a macro `[remainingTime]` in this string will be replaced with the remaining play time of the ad in seconds. | `'Advertisement [remainingTime]s'` | `string` |
49+
| `skipOffset` | optional | In order to enable skipping from the start set the delay to `0`, to show the skip button after 5 seconds set it to `5`. Setting a general skipOffset is discouraged. Note that linear creatives carrying a skipsoffet attribute will override the general player setting. By default the player does not set a general skipoffset, so a skip button will only be shown, if an ad has a specific skipoffset attached. | `0` | `integer` |
50+
| `startOpen` | optional | Per default the player will start fully expanded, if a valid ad can be played. Setting this option to `false` will trigger an expand animation instead once the player comes into view. Default is `true`. | `'false'` | `string` |
51+
| `endingScreen` | optional | By default the player will not close, but show the ending screen when an advertisement is complete (last frame of the ad and a replay button, if an advertisment comes with an endcard that will be shown). If set to `false` the player will collapse. Some VPAID creatives can cause issues with ending screen or replay behaviour. Default is `true`. | `'true'` | `string` |
52+
| `desiredBitrate`| optional | You can specify a target bitrate for the creative, higher values will increase video quality but will cost bandwidth. Value is given in kpbs. Default is `700`. | `800` | `integer` |
53+
| `visibilityThreshold`| optional | Defines the percentage of the player which has to be in the visible area to play and pause the advertisment. The default is `50`. | `50` | `integer` |

0 commit comments

Comments
 (0)