Skip to content
Merged
Changes from all 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
48 changes: 35 additions & 13 deletions dev-docs/bidders/adagio.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,13 @@
layout: bidder
title: Adagio
description: Prebid Adagio Bidder Adaptor
pbs: true
pbs_app_supported: true
pbjs: true
biddercode: adagio
media_types: banner, native, video
userIds: all
multiformat_supported: will-bid-on-any
floors_supported: true
tcfeu_supported: true
dsa_supported: true
Expand All @@ -16,14 +19,18 @@ schain_supported: true
gvl_id: 617
prebid_member: true
fpd_supported: false
safeframes_ok: true
dchain_supported: false
deals_supported: false
ortb_blocking_supported: false
sidebarType: 1
---

### Note

The Adagio bidder adapter requires setup and approval from the Adagio team. Please reach out to [contact@adagio.io](mailto:contact@adagio.io) for more information.

### Configuration
### Configuration for Prebid.js

#### User Sync

Expand Down Expand Up @@ -58,11 +65,12 @@ pbjs.bidderSettings = {
}
```

### Bid Params
#### Bid Params for Prebid.js

**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 @@ -73,18 +81,12 @@ 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 2.5 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)</i></small><br> Highly recommended: <br> - playbackmethod <br> Not supported: <br>`protocol`, `companionad`, `companiontype`, `ext` options| `{api: [2], playbackmethod: [6], skip: 1, startdelay: 0}` | `object` |
| `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>
| `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` |

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

| Name | description |
| ------------ | ---------------------------- |
| `adagio_bvw` | Url to handle Measure beacon |

### First Party Data
#### First Party Data

Adagio will use FPD data as fallback for the params below:

Expand All @@ -93,6 +95,26 @@ Adagio will use FPD data as fallback for the params below:

If the FPD value is an array, the 1st value of this array will be used.

### Video outstream
#### Video outstream

The AdagioBidAdapter includes a default video player powered by [Blue Billywig](https://www.bluebillywig.com). This default player is used when no renderer is configured for the adUnit.

### Configuration for Prebid Server

{: .alert.alert-warning :}
Adagio Prebid Server adapter is currently **available for apps**. Website support is coming soon. Activation requires setup and approval before beginning. Please reach out to your account manager or <contact@adagio.io> for more details.

Adagio supports different regions for the Prebid Server. Please deploy the prebid config in each of your datacenters with the appropriate regional subdomain.

#### Bid Params for Prebid Server

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

| Name | Scope | Description | Example | Type |
|-------------------|--------------------|-------------|---------|------|
| `organizationId` | required | Id of the Organization. Handed out by Adagio. | `'1010'` | `string` |
| `placement`* | required | Refers to the placement of an adunit in a page.<br>Must not contain any information about the type of device.<br><i>- max length: 30</i><br><i>- max distinctives values: 10</i> | `'ban_atf'` | `string` |
| `pagetype`* | highly recommended | Describes what kind of content will be present in the page.<br><i>- max length: 30</i><br><i>- max distinctives values: 50</i> | `'article'` | `string` |
| `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` |

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