Skip to content

Commit 5bb816a

Browse files
GodefroiRousselGodefroi Roussel
andauthored
Adagio Prebid Server Adapter: Add section Bid Params for Prebid Server and update adagio's metadata (prebid#5993)
Co-authored-by: Godefroi Roussel <groussel@adagio.io>
1 parent 602b7fb commit 5bb816a

File tree

1 file changed

+35
-13
lines changed

1 file changed

+35
-13
lines changed

dev-docs/bidders/adagio.md

Lines changed: 35 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,13 @@
22
layout: bidder
33
title: Adagio
44
description: Prebid Adagio Bidder Adaptor
5+
pbs: true
6+
pbs_app_supported: true
57
pbjs: true
68
biddercode: adagio
79
media_types: banner, native, video
810
userIds: all
11+
multiformat_supported: will-bid-on-any
912
floors_supported: true
1013
tcfeu_supported: true
1114
dsa_supported: true
@@ -16,14 +19,18 @@ schain_supported: true
1619
gvl_id: 617
1720
prebid_member: true
1821
fpd_supported: false
22+
safeframes_ok: true
23+
dchain_supported: false
24+
deals_supported: false
25+
ortb_blocking_supported: false
1926
sidebarType: 1
2027
---
2128

2229
### Note
2330

2431
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.
2532

26-
### Configuration
33+
### Configuration for Prebid.js
2734

2835
#### User Sync
2936

@@ -58,11 +65,12 @@ pbjs.bidderSettings = {
5865
}
5966
```
6067

61-
### Bid Params
68+
#### Bid Params for Prebid.js
6269

6370
**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.
6471

6572
{: .table .table-bordered .table-striped }
73+
6674
| Name | Scope | Description | Example | Type |
6775
| ----------------- | ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------ | -------- |
6876
| `organizationId` | required | Id of the Organization. Handed out by Adagio. | `'1010'` | `string` |
@@ -73,18 +81,12 @@ pbjs.bidderSettings = {
7381
| `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` |
7482
| `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` |
7583
| `native` | optional | Partial OpenRTB Native 1.2 request object. Supported fields are:<br>- context<br>- plcmttype | `{context: 1, plcmttype: 2}` | `object` |
76-
| `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` |
77-
| `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` |
78-
79-
<i>*These parameters will have its accentuated characters converted to their non-accentuated version:&nbsp;`é`&nbsp;=>&nbsp;`e`</i>
84+
| `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` |
85+
| `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` |
8086

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

83-
| Name | description |
84-
| ------------ | ---------------------------- |
85-
| `adagio_bvw` | Url to handle Measure beacon |
86-
87-
### First Party Data
89+
#### First Party Data
8890

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

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

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

96-
### Video outstream
98+
#### Video outstream
9799

98100
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.
101+
102+
### Configuration for Prebid Server
103+
104+
{: .alert.alert-warning :}
105+
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.
106+
107+
Adagio supports different regions for the Prebid Server. Please deploy the prebid config in each of your datacenters with the appropriate regional subdomain.
108+
109+
#### Bid Params for Prebid Server
110+
111+
{: .table .table-bordered .table-striped }
112+
113+
| Name | Scope | Description | Example | Type |
114+
|-------------------|--------------------|-------------|---------|------|
115+
| `organizationId` | required | Id of the Organization. Handed out by Adagio. | `'1010'` | `string` |
116+
| `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` |
117+
| `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` |
118+
| `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` |
119+
120+
<i>*These parameters will have their accentuated characters converted to their non-accentuated version:&nbsp;`é`&nbsp;=>&nbsp;`e`</i>

0 commit comments

Comments
 (0)