Standalone / Publisher tag with Passback

This code initializes the Criteo tags. The code will load the publishertag.js library and will also build the events queue that will be used later. The loader request is asynchronous and is cached on the user browser. No code changes are required on this section.

To enrich the bid request data with user IDs (1st Party user IDs, 3rd Party IDs or hashed emails), please use the function Criteo.SetIdentities as described in the sections below.

This function accepts an array of OpenRTB EIDS objects as input:

Use the function Criteo.SetIdentities providing the data below (examples on the right):

• source: your domain

• id: the user identifier

• atype: Must be 1 for cookie/device-based ID, must be 3 for person-based ID (e.g.: authenticated user ID, login ID, CRM/customer ID)

• ext.stype: ppuid

• ext.persistence: js or http

Use the function Criteo.SetIdentities providing the data below (examples on the right):

• source: the third-party solution domain

• id: the user identifier

• (recommended) atype: 1 for cookie/device based ID, 3 for person-based ID (e.g.: authenticated user ID, login ID, CRM/customer ID)

• (optional) ext.persistence: js or http

Use the function Criteo.SetIdentities providing the data below (examples on the right):

• (optional) source: your domain or the domain of the solution operating on your behalf

• id: the user data

• atype: 3

• ext.stype: hashing algorithm used: cleartextemail, hemsha256, hemmd5, hemsha256md5. Please refer to next section for details on hashing formats.

Hashing formats

The hashing should be the users’ email address:

• Encoded in UTF-8

• Trimmed of any white space (eg: “test@criteo.com “ should become “test@criteo.com”)

• Converted to lowercase

• Hashed with MD5/SHA256/SHA256(MD5) & output as ASCII text

Example:

• Type: String

• Original Email: john.doe@gmail.com

• SHA256: 375320dd9ae7ed408002f3768e16cb5f28c861062fd50dff9a3bff62e9dce4ef

• MD5: e13743a7f1db7f4246badd6fd6ff54ff

• SHA256 of MD5: 000e3171a5110c35c69d060112bd0ba55d9631c7c2ec93f1840e4570095b263a

Helpful links: https://www.miraclesalad.com/webtools/md5.php and https://www.miraclesalad.com/webtools/sha256.php

Use the function Criteo.SetIdentities providing the data below (example on the right):

• (optional) source: your domain or the domain of the solution operating on your behalf.

• id: the user data

• atype: 3

• ext.stype: hashing algorithm used. It can be either pnclear if the phone number is hashed, or pnsha256 if the phone number is in clear. Please refer to next section for details on hashing formats.

HASHED PHONE NUMBERS

Criteo uses SHA256 as a hashing method. The expected underlying phone numbers format is trimmed E.164 format, including the country code, without the leading "+" sign (so only 15 digits, at most): sha256(internationalPhoneNumber.replaceAll(/[^0-9]/g, "")).

Example:

• 1 (234) 567-8910 → sha256(12345678910) → 63640264849a87c90356129d99ea165e37aa5fabc1fea46906df1a7ca50db492

• 81-12-3456-7891 → sha256(811234567891) → d9825fb05347d3c910fc5202c0c20d07a87b791cc643c6f2d70402394a849540

• 02 1234 5678 → sha256(0212345678) → 826f54894e28f3f1795f3c5e3335cf98709c5d5b38b3f9c6d72467d491f032df

• +33 1 40 40 22 90 → sha256(33140402290) → fda66831d0cb0eb4bffb21bc795308d69921c211c57be0ae15702071e3b9e988

CLEAR PHONE NUMBERS

Clear phone numbers are accepted to ease integration for some partners.

Any international formats are accepted (including the leading "+" sign). Normalization remove all non numeric characters

Validation checks:

Number starts with a + sign length is at most 15 digits there is no leading 0: many countries use 0 as national dial number Then backend map the clear phone numbers to SHA256 HPN so the two accepted formats are uniform.

Examples:

• +1 (234) 567-8910

• +81-12-3456-7891

• +33 1 40 40 22 90

• 02 1234 5678 is rejected because of a leading 0 indicating that it is a national phone number

This code must be placed after the div element of each placement declared on the header. Please notice that the div/adunit names (ad-unit-0 and ad-unit-1 on this example) must be the exact same as the one declared on the header script.

The function Criteo.Passback.RenderAd(slotId,passback) will retrieve and display a bid for the given adunit otherwise, it will pass back.

If you already have other ad tags on your page, you will need to move them to the passback input. You will find one example later in this document.

You must ensure that your passback code is compatible on asynchronous mode.

You can see this example running on this page.

Explanation

LOADER

The first portion of the script loads the Criteo publisher tag

MAPPING

The second part maps the two ads available on the page (named adunit1 and adunit2) to their respective Criteo zoneid. This mapping is then submitted to Criteo, who will answer with an individual bid for each adunit.

RENDERING

The last portion of the code is implemented on the placement where the ads should be rendered. If Criteo has a bid for the adunit, the Criteo banner will be rendered inside the declared div. Otherwise, the tag will trigger the passback code provided as input.

This passback code in particular, appends one script and one ad tag inside the original div, resulting in the following structure:

<div id="adunitid1">
<script type="text/javascript" async="" src="//www.mydomain.com/mypassbackcode.js"></script>
<ad class="ads" style="display:inline-block;width:300px;height:250px" id="123"></ad>
</div>

You can take this example to adapt your current HTML tags.

Once again, you must ensure that your passback is compatible with an asynchronous environment.

Please ensure that the creatives are not delivered in safe-frames (i.e. cross-domain iframes) as this code needs to retrieve the creatives stored on the main page. This code also relies on the function Criteo.Passback.RenderAd that accept the same inputs:

The rendering code can be injected directly into a GAM creative as per example below. The “Serve into a SafeFrame” checkbox needs to be unchecked.

In order to activate Native demand, first, you need to declare a callback function that will be used to render the Native ad. This provides instructions on how the function Criteo.Passback.RenderAd() should build the native ad.

When a native demand is available, Criteo will respond to the following native object:

NATIVE OBJECT

PRODUCT OBJECT

IMAGE OBJECT

ADVERTISER OBJECT

PRIVACY OBJECT

IMPRESSION PIXEL OBJECT

Criteo Native guidelines:

• Display the Ad Choices icon and implement the link to the opt-out page

• Display at least one advertiser information (domain, name)

• Display at least one product recommendation

• Use Criteo to click URLs

• Every impression pixel must be called once the ad is delivered

You will find to the right one sample code that uses the most relevant assets.

Criteo images for native inventory will be sized to fit within a 400x400 html element. They will not be padded to fit the dimensions or ratio; they should, therefore, be centered in the layout by the partner.

The campaigns are configured as the normal campaign and you can reuse the same Creative codes for the standard ads. The Criteo.Passback.RenderAd() function will automatically identify the native ad context and execute whatever has been defined at the nativeCallback parameter.