# Criteo

[Criteo](https://www.criteo.com/) is a online display advertising platform. It offers various solutions to increase your website traffic, generate brand awareness, and boost sales.

Find the open source code for this destination in the <a href="https://github.com/rudderlabs/rudder-sdk-js/tree/develop/packages/analytics-js-integrations/src/integrations/Criteo">GitHub repository</a>.

## Connection compatibility

{{< destination-config >}}

{{< info >}}
In the web device mode integration, that is, using [JavaScript SDK]({{< ref "sources/event-streams/sdks/rudderstack-javascript-sdk/_index.md" >}}) as a source, RudderStack loads the Criteo native SDK from the `https://dynamic.criteo.com` domain. 

Based on your website's content security policy, you might need to [allowlist this domain]({{< ref "sources/event-streams/sdks/rudderstack-javascript-sdk/load-js-sdk.md#allowlist-destination-domain" >}}) to load the Criteo SDK successfully.
{{< /info >}}

## Get started

Once you have confirmed that the source platform supports sending events to Criteo, follow these steps:

1. From your [RudderStack dashboard](https://app.rudderstack.com/), add the source. Then, from the list of destinations, select **Criteo**.
2. Assign a name to the destination and click **Continue**.

## Connection settings

To successfully set up Criteo as a destination in RudderStack, you need to configure the following settings:

- **Criteo Account ID**: Enter your Criteo Account/Partner ID. See [FAQ]({{< ref "#faq" >}}) section below for more information on getting your Account/Partner ID.
- **Home Page URL**: Enter the complete URL of your website’s homepage.

{{< info >}}
This field is required when you need to fire the homepage tag to add visitors to your target audience in cases where the event name of the `page` call is anything other than `home`.
{{< /info >}}

- **Email Hashing Method**: Criteo lets you use the email addresses in both hashed and non-hashed formats. If you choose **MD5**, RudderStack will hash-encode the email address before sending it to Criteo.
- **Map Specific Fields to Criteo Fields:** Enter the payload fields and the corresponding mapped fields that RudderStack uses to send the event data to Criteo.

{{< info >}}
Criteo lets you send additional user or page-related data to add more context to the events. You can set this feature in Criteo with the assistance of your Criteo Account Manager. You can then use the **Map Specific Fields to Criteo Fields** field mapping feature to send the additional data through RudderStack.
{{< /info >}}

- **Client-side Events Filtering**: This setting lets you specify which events should be blocked or allowed to flow through to Criteo. For more information on this setting, see [Client-side Events Filtering]({{< ref "sources/event-streams/sdks/event-filtering.md" >}}).
- **Consent management settings**: Configure the consent management settings for the specified source by choosing the **Consent management provider** from the dropdown and entering the relevant consent category IDs. See [Consent Management in RudderStack]({{< ref "data-governance/consent-management/overview.md" >}}) for more information on this feature.
- **Mapping RudderStack events to the Criteo standard events**: This setting triggers the Criteo [Standard Event](https://www.criteo.com/wp-content/uploads/2018/09/CSPOneTag_v1.1.pdf) when you send the mapped RudderStack event. You can specify multiple **Standard Events** for one **Event Name** and vice versa.
- **Use device mode to send events**: As this is a [device mode]({{< ref "destinations/rudderstack-connection-modes.md#device-mode" >}})-only destination, this setting is enabled by default and cannot be disabled .

## Page

The [`page`]({{< ref "event-spec/standard-events/page.md" >}}) call lets you track user's home page along with its associated properties and send this information to Criteo.

{{< warning >}}
Use this call only to track the home page and add the users to your target audience.
{{< /warning >}}

The home page tag is fired **only** in the following scenarios:

- When the name of the `page` call is `home`.
- When the current URL of the web page is same as the **Home Page URL** specified in the RudderStack dashboard.
- When the URL mentioned in the `properties` of the `page` call is same as the **Home Page URL** specified in the RudderStack dashboard.

A sample `page` call is as shown below:

```javascript
rudderanalytics.page("category", "home", {
  path: "path",
  url: "url",
  title: "title",
  search: "search",
  referrer: "referrer",
  testDimension: "true",
})
```

## Track

The [`track`]({{< ref "event-spec/standard-events/track.md" >}}) call lets you capture user events and the properties associated with them.

A sample `track` call is as shown:

```javascript
rudderanalytics.track("Product Viewed", {
  product_id: "Prod12345",
  quantity: 1,
  price: 19.99,
  name: "my product",
  category: "categ 1",
  sku: "p-666",
  list: "Gallery",
  testDimension: true,
  testMetric: true,
})
```

In the above example, RudderStack captures the information related to the `Product Viewed` event and the associated details such as quantity, price, category, etc.

### Supported mappings

The following table details the mapping of the [RudderStack ecommerce events]({{< ref "event-spec/ecommerce-events-spec/_index.md" >}}) and the [Criteo OneTag events](https://help.criteo.com/kb/guide/en/all-criteo-onetag-events-and-parameters-vZbzbEeY86/Steps/775825):

| RudderStack event | Required fields | Criteo OneTag event | OneTag Event Name used by Criteo |
| :----- | :----- | :----| :------- |
| `Cart Viewed` | `properties.products.$.price` <br /> `properties.products.$.product_id` <br /> `properties.products.$.quantity` | `Basket/cart tag` | `viewBasket` |
| `Order Completed` | `properties.products.$.price` <br /> `properties.products.$.product_id` <br /> `properties.products.$.quantity` <br /> `properties.order_id` | `Sales Tag` | `trackTransaction` |
| `Product List Viewed` | `properties.products.$.product_id` |`Category/keyword search/listing tag` | `viewList` |
| `Product Viewed` | `properties.product_id`|`Product tag` | `viewItem` |
| `Product Added` | `properties.product_id`<br /> `properties.price`<br /> `properties.quantity` <br /> `properties.currency`| `Criteo Add to Cart Tag` | `addToCart` |

{{< info >}}
Note that:
- For `Product List Viewed` event, Rudderstack sends the `viewList` tag. However, it can also send the `viewSearchResult` or `viewCategory` tag depending upon the availability of the `keywords`, `category` fields and the configuration settings.
- If you need to fire the `Category/keyword search/listing tag` with the appropriate filters, enter the filter categories within the `filters` field in the `Product List Viewed` event properties. See [Send filter category to Criteo](#send-filter-category-to-criteo) for more information.
{{< /info >}}

#### **Send filter category to Criteo**

The `filters` field is an array of objects that consists of each filter category in every single object. Criteo expects `name`, `operator,` and `value` fields for every filter that needs to be passed to Criteo.

For example, a simple `Product List Viewed` event that fires a `Category/keyword search/listing Tag` is as shown:

```javascript
rudderanalytics.track("Product List Viewed", {
  email: "name@domain.com",
  zipCode: "12345",
  category: "abc",
  keywords: "key",
  page_number: 1,
  filters: [
    {
      name: "processor",
      operator: "eq",
      value: "snapdragon",
    },
  ],
  products: [
    {
      product_id: "223344ffdds3ff3",
    },
    {
      product_id: "343344ff5567ff3",
    },
  ],
})
```

## FAQ 

#### Where can I find the Criteo account/partner ID?

1. Log in to your [Criteo account](https://www.criteo.com/login/).
2. From the left sidebar, go to **Events Tracking** under **Assets**:

{{< image src="images/event-stream-destinations/criteo-event-tracking.webp" alt="Criteo event tracking option" >}}

3. Click **Setup** followed by **Direct Implementation**.
4. In the resulting loader file, find your 5-digit partner ID in the `src` key:

{{< image src="images/event-stream-destinations/criteo-partner-id.webp" alt="Criteo partner ID" >}}