Skip to content

Latest commit

 

History

History
96 lines (75 loc) · 6.43 KB

adagio.md

File metadata and controls

96 lines (75 loc) · 6.43 KB
layout title description pbjs biddercode media_types userIds floors_supported tcfeu_supported dsa_supported usp_supported gpp_supported coppa_supported schain_supported gvl_id prebid_member fpd_supported sidebarType
bidder
Adagio
Prebid Adagio Bidder Adaptor
true
adagio
banner, native, video
all
true
true
true
true
true
true
true
617
true
false
1

Note

The Adagio bidder adapter requires setup and approval from the Adagio team. Please reach out to [email protected] for more information.

Configuration

User Sync

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.

// https://docs.prebid.org/dev-docs/publisher-api-reference/setConfig.html#setConfig-Configure-User-Syncing
pbjs.setConfig({
  userSync: {
    filterSettings: {
      iframe: {
        bidders: ['adagio'],
        filter: 'include'
      }
    }
  }
});

Bidder Settings

The Adagio bid adapter uses browser local storage. Since Prebid.js 7.x, the access to it must be explicitly set.

// https://docs.prebid.org/dev-docs/publisher-api-reference/bidderSettings.html
pbjs.bidderSettings = {
  adagio: {
    storageAllowed: true
  }
}

Bid Params

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 for details.

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

Name Scope Description Example Type
organizationId required Id of the Organization. Handed out by Adagio. '1010' string
site required Name of the site. Handed out by Adagio.
- max length: 50
'mysite-com' string
placement* required Refers to the placement of an adunit in a page.
Must not contain any information about the type of device.
- max length: 30
- max distinctives values: 10
'ban_atf' string
adUnitElementId required Refers to the adunit html attribute id in a page. 'gpt-ban-atf' string
pagetype* highly recommended Describes what kind of content will be present in the page.
- max length: 30
- max distinctives values: 50
'article' string
category* recommended Category of the content displayed in the page.
- max length: 30
- max distinctives values: 50
'sport' string
video optional OpenRTB 2.5 video options object. All options will override ones defined in mediaTypes video.
Mandatory:
- api (your video player must at least support the value 2)
Highly recommended:
- playbackmethod
Not supported:
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:
- context
- 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

*These parameters will have its accentuated characters converted to their non-accentuated version: é => e

Native Custom assets

Name description
adagio_bvw Url to handle Measure beacon

First Party Data

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

  • pagetype
  • category

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

Video outstream

The AdagioBidAdapter includes a default video player powered by Blue Billywig. This default player is used when no renderer is configured for the adUnit.