Skip to content

Commit c8772c4

Browse files
osazososazos
committed
Adagio: update bid adapter doc
1 parent 0e8f0c2 commit c8772c4

File tree

1 file changed

+124
-65
lines changed

1 file changed

+124
-65
lines changed

‎dev-docs/bidders/adagio.md‎

Lines changed: 124 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,9 @@ floors_supported: true
1313
tcfeu_supported: true
1414
dsa_supported: true
1515
usp_supported: true
16-
gpp_supported: true
1716
coppa_supported: true
17+
gpp_supported: true
18+
gpp_sids: all
1819
schain_supported: true
1920
gvl_id: 617
2021
prebid_member: true
@@ -24,98 +25,156 @@ dchain_supported: false
2425
deals_supported: false
2526
ortb_blocking_supported: false
2627
endpoint_compression: true
28+
privacy_sandbox: 'no'
2729
sidebarType: 1
2830
---
2931

30-
### Note
32+
### Table of contents
33+
34+
* [Table of contents](#table-of-contents)
35+
* [Introduction](#introduction)
36+
* [Bid params](#bid-params)
37+
* [Setting params: AdUnit Level vs First Party Data](#setting-params-adunit-level-vs-first-party-data)
38+
* [Prebid Server](#prebid-server-adapter)
39+
* [Additional informations](#additional-informations)
40+
* [User Sync](#user-sync)
41+
* [Recommended placement param values](#recommended-placement-param-values)
42+
* [Video outstream](#video-outstream)
43+
44+
### Introduction
3145

3246
The Adagio bidder adapter requires setup and approval from the Adagio team. Please reach out to [[email protected]](mailto:[email protected]) for more information.
3347

34-
### Configuration for Prebid.js
48+
We strongly recommend using it alongside the [Adagio RTD Provider](/dev-docs/modules/adagioRtdProvider.md), which leverages viewability and attention predictions to enhance inventory quality and maximize performance.
3549

36-
#### User Sync
50+
We also strongly suggest enabling the gptPreAuction module, which automatically populates the GPID (Global Placement ID) values. The GPID helps improve monetization by providing more accurate identification of each ad placement. For setup details, see the [gptPreAuction module documentation](/dev-docs/modules/gpt-pre-auction.md).
51+
52+
### Bid params
53+
54+
{: .table .table-bordered .table-striped .table-responsive }
3755

38-
Adagio strongly recommends enabling user syncing through iFrames. This functionality improves DSP user match rates and increases the bid rate and bid price. Make sure to call `pbjs.setConfig()` only once. This configuration is optional in Prebid, but required by Adagio.
56+
| Name | Scope | Description | Example | Type |
57+
| ----------------- | ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------ | -------- |
58+
| `organizationId` | required | Id of the Organization. Handed out by Adagio. | `'1010'` | `string` |
59+
| `site` | required / optional (in-app) | Name of the site. Handed out by Adagio.<br><span style="display:inline-block; margin-top: 0.6em; line-height:1.5; font-size:14px; font-style:italic;">- max length: 50</span> | `'mysite-com'` | `string` |
60+
| `placement` | required | Refers to the placement of an adunit in a page. See [recommended values](#recommended-placement-param-values).<br><span style="display:inline-block; margin-top: 0.6em; line-height:1.5; font-size:14px; font-style:italic;">- max length: 50<br>- max distinctives values: 10</span> | `'banner_top'` | `string` |
61+
| `pagetype` | highly recommended | Describes what kind of content will be present in the page.<br><span style="display:inline-block; margin-top: 0.6em; line-height:1.5; font-size:14px; font-style:italic;">- max length: 30<br>- max distinctives values: 50</span><br><span style="display:inline-block; line-height:1.5; font-size:14px;">Can be set at adUnit level or via FPD ([see below](#setting-params-adunit-level-vs-first-party-data))</span> | `'article'` | `string` |
62+
| `category` | recommended | Category of the content displayed in the page.<br><span style="display:inline-block; margin-top: 0.6em; line-height:1.5; font-size:14px; font-style:italic;">- max length: 30<br>- max distinctives values: 50</span><br><span style="display:inline-block; line-height:1.5; font-size:14px;">Can be set at adUnit level or via FPD ([see below](#setting-params-adunit-level-vs-first-party-data))</span> | `'sport'` | `string` |
63+
64+
#### Setting params: AdUnit Level vs First Party Data
65+
66+
You can set `pagetype` and `category` parameters in two ways:
67+
68+
**1. At the adUnit level** (individual ad slots):
69+
70+
```js
71+
{
72+
code: 'div-gpt-ad-1234567890',
73+
mediaTypes: {
74+
banner: {
75+
sizes: [[300, 250]]
76+
}
77+
},
78+
bids: [{
79+
bidder: 'adagio',
80+
params: {
81+
organizationId: '1010',
82+
site: 'mysite-com',
83+
placement: 'banner_top',
84+
pagetype: 'article',
85+
category: 'sport'
86+
}
87+
}]
88+
}
89+
```
90+
91+
**2. Globally via First Party Data** (applies to all adUnits on the page):
3992

4093
```js
41-
// https://docs.prebid.org/dev-docs/publisher-api-reference/setConfig.html#setConfig-Configure-User-Syncing
4294
pbjs.setConfig({
43-
userSync: {
44-
filterSettings: {
45-
iframe: {
46-
bidders: ['adagio'],
47-
filter: 'include'
95+
ortb2: {
96+
site: {
97+
ext: {
98+
data: {
99+
pagetype: 'article',
100+
category: 'sport'
101+
}
48102
}
49103
}
50104
}
51105
});
52106
```
53107

54-
#### Bidder Settings
108+
* First Party Data takes precedence over AdUnit-level parameters.
109+
* If the FPD value is an array, the first value will be used.
110+
111+
<a id="prebid-server-adapter"></a>
112+
### Prebid Server
113+
114+
If you are hosting a Prebid Server, you must configure the Adagio Prebid Server adapter by changing the [`static/bidder-info/adagio.yaml` file](https://github.com/prebid/prebid-server/blob/master/static/bidder-info/adagio.yaml) in order to:
115+
116+
1. enable the adapter by deleting the `disabled: true` entry _(or set it to `false`)_
117+
2. replace the endpoints containing the `REGION` by one of the value below:
118+
* **AMER:**
119+
* Auction: `https://mp-las.4dex.io/pbserver`
120+
* Usersync: `https://u-las.4dex.io/pbserver/usync.html`
121+
* **EMEA:**
122+
* Auction: `https://mp-ams.4dex.io/pbserver`
123+
* Usersync: `https://u-ams.4dex.io/pbserver/usync.html`
124+
* **APAC:**
125+
* Auction: `https://mp-tyo.4dex.io/pbserver`
126+
* Usersync: `https://u-tyo.4dex.io/pbserver/usync.html`
127+
128+
**Example for EMEA**
129+
130+
{% raw %}
131+
"```yaml"
132+
endpoint: "https://mp-ams.4dex.io/pbserver"
133+
userSync:
134+
iframe:
135+
url: "https://u-ams.4dex.io/pbserver/usync.html?gdpr={{.GDPR}}&gdpr_consent={{.GDPRConsent}}&us_privacy={{.USPrivacy}}&gpp={{.GPP}}&&gpp_sid={{.GPPSID}}&r={{.RedirectURL}}"
136+
userMacro: "{UID}"
137+
disabled: false
138+
# …
139+
"```"
140+
{% endraw %}
141+
142+
### Additional informations
55143

56-
The Adagio bid adapter uses browser local storage. Since Prebid.js 7.x, the access to it must be explicitly set.
144+
#### User Sync
57145

58-
{% include dev-docs/storageAllowed.md %}
146+
Enable user sync via iframe to improve DSP user match rates, leading to higher bid rates and bid prices. While this configuration is optional in Prebid, it is required by Adagio. Ensure that `pbjs.setConfig()` is called only once.
59147

60148
```js
61-
// https://docs.prebid.org/dev-docs/publisher-api-reference/bidderSettings.html
62-
pbjs.bidderSettings = {
63-
adagio: {
64-
storageAllowed: true
149+
// https://docs.prebid.org/dev-docs/publisher-api-reference/setConfig.html#setConfig-Configure-User-Syncing
150+
pbjs.setConfig({
151+
userSync: {
152+
filterSettings: {
153+
iframe: {
154+
bidders: ['adagio'],
155+
filter: 'include'
156+
}
157+
}
65158
}
66-
}
159+
});
67160
```
68161

69-
#### Bid Params for Prebid.js
162+
#### Recommended placement param values
70163

71-
**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.
164+
Setting a meaningful value for the `placement` parameter is essential for our adapter to optimize ad delivery and performance, as it defines the specific location and context of your ad unit within the page. To streamline your implementation and ensure consistent naming conventions across your inventory, we provide these standardized values that eliminate guesswork and ensure your ad units are properly categorized for maximum yield.
72165

73-
{: .table .table-bordered .table-striped }
166+
{: .table .table-bordered :}
74167

75-
| Name | Scope | Description | Example | Type |
76-
| ----------------- | ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------ | -------- |
77-
| `organizationId` | required | Id of the Organization. Handed out by Adagio. | `'1010'` | `string` |
78-
| `site` | required | Name of the site. Handed out by Adagio.<br><i>- max length: 50</i> | `'mysite-com'` | `string` |
79-
| `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: 50</i><br><i>- max distinctives values: 10</i> | `'ban_atf'` | `string` |
80-
| `adUnitElementId` | required | Refers to the adunit html attribute id in a page. | `'gpt-ban-atf'` | `string` |
81-
| `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` |
82-
| `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` |
83-
| `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` |
84-
| `native` | optional | Partial OpenRTB Native 1.2 request object. Supported fields are:<br>- context<br>- plcmttype | `{context: 1, plcmttype: 2}` | `object` |
85-
| `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` |
86-
| `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` |
87-
88-
<i>*These parameters will have their accentuated characters converted to their non-accentuated version:&nbsp;`é`&nbsp;=>&nbsp;`e`</i>
89-
90-
#### First Party Data
91-
92-
Adagio will use FPD data as fallback for the params below:
93-
94-
- pagetype
95-
- category
96-
97-
If the FPD value is an array, the 1st value of this array will be used.
168+
| Format | recommended values |
169+
| --------------------| --------------------- |
170+
| Banner | `banner_top`,<br>`banner_middle`,<br>`banner_bottom`,<br>`banner_left`,<br>`banner_right`,<br>`banner_sticky_top`,<br>`banner_sticky_bottom` |
171+
| Interstitial | `interstitial_page_load`,<br>`interstitial_exit`,<br>`interstitial_pause` |
172+
| Video | `video_instream`,<br>`video_outstream`,<br>`video_rewarded`,<br>`video_midroll` |
173+
| Native | `native_feed`,<br>`native_article`,<br>`native_recommendation` |
174+
| Special | `sticky_footer`,<br>`sticky_header`,<br>`companion_banner`,<br>`overlay_ad` |
98175

99176
#### Video outstream
100177

101-
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.
102-
103-
### Configuration for Prebid Server
104-
105-
{: .alert.alert-warning :}
106-
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 <[email protected]> for more details.
178+
The Adagio bidder adapter (Prebid.js only) 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.
107179

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

0 commit comments

Comments
 (0)