Skip to content

Commit

Permalink
Adagio: Add documentation for splitKeyword and dataLayer params (preb…
Browse files Browse the repository at this point in the history
…id#4430)

* Add documentation for the splitKeyword and dl params

* Update param from `dl` to `dataLayer`

- Improve description, fix example..

* Adagio: Update description for dataLayer param
  • Loading branch information
Clement3 authored and ecdrsvc committed Sep 6, 2023
1 parent 2f3d667 commit 75e6e98
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions dev-docs/bidders/adagio.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,6 @@ pbjs.bidderSettings = {
**Important**: Adagio needs to collect attention data about the ads displayed on a page and must listen to some specifics ad-server events. Please refer to the [Adagio user guide](https://adagioio.notion.site/Adagio-Account-Setup-Guide-fbcd940649224cdfa10393d2f008792e) for details.

{: .table .table-bordered .table-striped }

| Name | Scope | Description | Example | Type |
| ----------------- | ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------ | -------- |
| `organizationId` | required | Id of the Organization. Handed out by Adagio. | `'1010'` | `string` |
Expand All @@ -70,7 +69,8 @@ pbjs.bidderSettings = {
| `category`* | recommended | Category of the content displayed in the page.<br><i>- max length: 30</i><br><i>- max distinctives values: 50</i> | `'sport'` | `string` |
| `video` | optional | OpenRTB video options object. All options will override ones defined in mediaTypes video.<br>Mandatory: <br>- api <small><i>(your video player must at least support the value 2 and/or 7)</i></small><br> Highly recommended: <br> - playbackmethod | `{api: [2, 7], playbackmethod: [6], skip: 1, startdelay: 0}` |
| `native` | optional | Partial OpenRTB Native 1.2 request object. Supported fields are:<br>- context<br>- plcmttype | `{context: 1, plcmttype: 2}` | `object` |

| `splitKeyword` | optional | Keyword that can later be used in a split rule targeting to trigger the rule (especially for Direct Seats AB testing) | `'splitrule-one'` | `string` |
| `dataLayer` | optional | A set of arbitrary key-value pairs. This can be used to configure mappings. The keys and values must be strings. | `{placement: 'my-placement', siteid: 'my-siteid'}` | `object` |

<i>*These parameters will have its accentuated characters converted to their non-accentuated version:&nbsp;`é`&nbsp;=>&nbsp;`e`</i>

Expand Down

0 comments on commit 75e6e98

Please sign in to comment.