Skip to content

Latest commit

 

History

History
129 lines (107 loc) · 11 KB

criteo.md

File metadata and controls

129 lines (107 loc) · 11 KB
layout title description pbjs pbs biddercode media_types tcfeu_supported dsa_supported usp_supported userIds prebid_member floors_supported fpd_supported schain_supported gvl_id coppa_supported multiformat_supported sidebarType gpp_supported
bidder
Criteo
Prebid Criteo Bidder Adaptor
true
true
criteo
display, video, native (pbjs only)
true
true
true
britepoolId, criteo, id5Id, identityLink, liveIntentId, netId, parrableId, pubCommonId, pubProvidedId, sharedId, unifiedId
true
true
true
true
91
true
will-bid-on-any
1
true

Notes

{: .alert.alert-warning :} This bidder adapter automatically includes the Criteo User ID module and performs iFrame syncs.

{: .alert.alert-warning :} Prebid-Server support is on alpha test and is currently a non-finished product. Activation requires setup and approval before beginning. Please reach out to your account manager or publishers@criteo.com for more details.

Bid Params

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

Name Scope Description Example Type
zoneId optional, deprecated (deprecated) The zone ID from Criteo. Should be replaced by networkId when using zone matching. 234234 integer
networkId required The network ID from Criteo. Please reach out your Criteo representative for more details. 456456 integer
pubid optional Publisher id of your inventory group provided by your Technical account manager if using inventory groups to map your inventory in Commerce Grid 'ABC123' string
uid optional Ad Unit ID 8888 integer
nativeCallback optional (deprecated) (Prebid.js only) Callback to perform render in native integrations. Please reach out your Criteo representative for more details. function(payload) { console.log(payload); } function
integrationMode optional (Prebid.js only) Integration mode to use for ad render (none or 'AMP'). Please reach out your Criteo representative for more details. 'AMP' string
publisherSubId optional Custom identifier for reporting. Please reach out your Criteo representative for more details. 'adunit-1' string

First Party Data

Criteo supports both ortb2 and ortb2Imp methods to set First Party Data.

The standard Open RTB properties supported from ortb2 / ortb2Imp are described in the following table.

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

Name Scope Description Example Type
ortb2.user optional Details via a Open RTB User object about the human user of the device; the advertising audience. N/A object
ortb2.site optional Details via a Open RTB Site object about the publisher’s website. N/A object
ortb2Imp.rwdd optional Indicates whether the user receives a reward for viewing the ad, where 0 = no, 1 = yes. 1 integer

Besides these standard properties, ext field can be used to send any publisher specific data which may have been discussed with a Criteo representative.

Video Object

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

Name Scope Description Example Type
minduration optional Minimum ad duration in seconds 5 integer
startdelay optional Duration offset (in second) from the start of the content for showing the video ad before the start of the Video. Pre-roll: 0 (default); Mid-roll: >0; Default mid-roll: -1; Post-roll: -2; 5 integer
playbackmethod required Defines how the video inventory is initiated. Page Load with Sound On: 1; Page Load with Sound Off: 2; Click with Sound On: 3; Mouse-Over with Sound On: 4; Entering Viewport with Sound On: 5; Entering Viewport with Sound Off by Default: 6; [4, 5] Array<integer>
placement required Video placement type. In-Stream: 1; In-Banner: 2; In-Article: 3: In-Feed: 4; Interstitial: 5; 1 integer
skip required Ability from the video player for the user to skip the video. Not skippable: 0; Skippable: 1; 1 integer

In addition, Criteo adapter relies on parameters specified in the mediaTypes.video definition of the video ad-units, namely:

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

Name Scope Description Example Type
context required outstream, instream or long-form instream string
mimes required List of the content MIME types supported by the player ["video/mp4"] Array<string>
playerSize required Width and height of the player [640, 480] Array<integer>
protocols required Supported video bid response protocols. VAST 1.0: 1; VAST 2.0: 2; VAST 3.0: 3; VAST 1.0 Wrapper: 4; VAST 2.0 Wrapper: 5; VAST 3.0 Wrapper: 6; [5, 6] Array<integer>
maxduration required Maximum ad duration in seconds 20 integer
api required API frameworks supported. VPAID 1.0: 1; VPAID 2.0: 2; MRAID 1.0: 3; ORMMA: 4; MRAID 2.0: 5; MRAID 3.0: 6; OMID 1.0: 7; [1, 2] Array<integer>
plcmt optional 1=in-stream, 2=accompanying content, 3=interstitial, 4=no content/standalone. Highly recommended to comply with new IAB video specifications. 1 integer

Example of Video Ad-unit

var adUnits = [
{
    code: 'video1',
    mediaTypes: {
        video: {
            playerSize: [640, 480],
            context: 'instream',
            mimes: ["video/mp4"],
            maxduration: 30,
            api: [1, 2],
            playerSize: [640,480],
            protocols: [2, 3],
            skip: 0,
            playbackmethod: [1],
            placement: 1
        }
    },
    bids: [{
        bidder: 'criteo',
        params: {
            zoneId: 1455580
        }
    }]
}];

Additional Config (Optional)

If you don't want to use the FastBid adapter feature, you can disable it via this configuration:

pbjs.setConfig({
  'criteo': {
    fastBidVersion: 'none',
  }
});

Criteo teams are planning to completely remove this feature with Prebid 9.0

Criteo Bid Adapter supports the collection of the user's hashed email, if available.

Please consider passing it to the adapter, following these guidelines.