Criteo App & Web Events Destination


Getting Started

The first step is to make sure Criteo App & Web Events supports the source type and connection mode you’ve chosen to implement. You can learn more about what dictates the connection modes we support here.

Web Mobile Server
📱 Device-mode
☁️ Cloud-mode

Currently this destination supports events originating from Mobile or Web sources (not Server). You can read more about how define a source here.

Our web integration with Criteo Events is currently in public beta. Please use carefully and **contact us **if you are having any issues.

To get started with Criteo Events and Segment, you’ll need:

  1. An existing account with Criteo.
  2. A data source integrated with either one of our mobile SDK’s (iOS or Android) or Javascript library (Analytics.js)

Assuming both of these criteria are met, you can add Criteo Events as a destination for your desired source in your Segment account.

If you are using our mobile integration with Criteo Events please ensure your app is properly registered with them.


Track

Criteo Events is built to help you track key purchase funnel events and details. To accomplish that, you’ll want to track your user’s actions using the following spec’d events to ensure you’re following Criteo’s best practices.

We use the context fields that we capture with our SDKs automatically to populate Criteo Events’ tag with the app’s name, user’s language, locale, userId, deviceType and deviceId so you just need to make sure that the event names and properties match up! Please refer to our common fields guide to identify which context fields we collect automatically for each of our client-side libraries (analytics.js, analytics-ios or analytics-android).

Product Viewed

When a user views a particular product or offering inside your application, you should call our Product Viewed event and we’ll map that to Criteo Events’ viewProduct tag. You’ll need to make sure that the products on your Product List Viewed event have a productId property. As with all our integrations, casing does not matter! Your properties can be camelCase or snake_case, both will work.

{
    "action": "track",
    "event": "Product Viewed",
    "userId": "userId",
    "properties": {
        "product_id": "507f1f77bc",
        "sku": "G-32",
        "category": "Games",
        "name": "Monopoly: 3rd Edition",
        "brand": "Hasbro",
        "variant": "200 pieces",
        "price": "18.99",
        "quantity": "1",
        "coupon": "MAYDEALS",
        "currency": "usd",
        "position": "3",
        "value": "18.99"
    }
}

On web, the above Javascript example would result in the firing of the following Criteo Events tag:

window.criteo_q.push({ event: 'viewItem', item: '507f1f77bc' })

Product List Viewed

When a user views a list of products inside your application, you should call our Product List Viewed event and we’ll map that to Criteo Events’ viewListing tag. Same as above, make sure you have your item’s productId or product_id on the event!

{
    "action": "track",
    "event": "Product List Viewed",
    "userId": "userId",
    "properties": {
        "list_id": "First Last",
        "category": "Deals",
        "products": [
            {
              "product_id": "1",
              "sku": "45790-32",
              "name": "Monopoly: 3rd Edition",
              "price": "19",
              "position": "1",
              "category": "Games"
            },
            {
              "product_id": "2",
              "sku": "46493-32",
              "name": "Uno Card Game",
              "price": "3",
              "position": "2",
              "category": "Games"
            }
        ]
    }
}

On web, the above Javascript example would result in the firing of the following Criteo Events tag:

window.criteo_q.push({ event: 'viewList', item: ['1', '2'] })

Cart Viewed

When a user views their Cart or Order details inside your application, you should call our Cart Viewed event and we’ll map that to Criteo Events’ viewBasket tag.

You will need to have a products array of product objects in your Segment Cart Viewed event with at least id, price and quantity properties on each product object in that array.

{
    "action": "track",
    "event": "Product List Viewed",
    "userId": "userId",
    "properties": {
        "cart_id": "a21232d13c",
        "products": [
            {
              "product_id": "1",
              "sku": "45790-32",
              "name": "Monopoly: 3rd Edition",
              "quantity": "6",
              "price": "19",
              "position": "1",
              "category": "Games"
            },
            {
              "product_id": "2",
              "sku": "46493-32",
              "name": "Uno Card Game",
              "quantity": "2",
              "price": "3",
              "position": "2",
              "category": "Games"
            }
        ]
    }
}

On web, the above Javascript example would result in the firing of the following Criteo Events tag:

window.criteo_q.push({ event: 'viewBasket', item: [
    {
        productId: 1,
        price: '19',
        quantity: 6
    },
    {
        productId:2,
        price: '3',
        quantity: 2
    }
]})

Order Completed

When a user completes an order or purchase inside your application, you should call our Order Completed event and we’ll map that to Criteo Events’ trackTransaction tag.

You will need to have a products array of product objects in your Segment Order Completed event with at least id, price and quantity properties on each product object in that array. You also must pass an orderId.

{
    "action": "track",
    "event": "Product List Viewed",
    "userId": "userId",
    "properties": {
        "checkout_id": "908asdfdfs9",
        "order_id": "098dsf098f",
        "affiliation": "Google Store",
        "total": 30,
        "revenue": 25,
        "shipping": 3,
        "tax": 2,
        "discount": 2.5,
        "coupon": "hasbros",
        "currency": "USD",
        "products": [
          {
            "product_id": "507f1f77bcf86cd799439011",
            "sku": "45790-32",
            "name": "Monopoly: 3rd Edition",
            "price": 19,
            "quantity": 1,
            "category": "Games"
          },
          {
            "product_id": "505bd76785ebb509fc183733",
            "sku": "46493-32",
            "name": "Uno Card Game",
            "price": 3,
            "quantity": 2,
            "category": "Games"
          }
        ]
    }
}

On web, the above Javascript example would result in the firing of the following Criteo Events tag:

window.criteo_q.push({ event: 'trackTransaction', id: '098dsf098f', item: [
    {
        productId: '507f1f77bcf86cd799439011',
        price: '19',
        quantity: 1
    },
    {
        productId: '505bd76785ebb509fc183733',
        price: '3',
        quantity: 2
    }
]})

Application Opened

This is only relevant if you are using this integration for mobile. For the equivalent on web, see below.

Our Application Opened event will map to Criteo Events’ viewHome tag. This event is automatically collected by the latest versions of our SDKs so update if you haven’t already!

Page

Criteo Events’ viewHome tag tracks top of funnel visits to your site’s home page. We integrate with this functionality on web via the use of our .page method.

There are two ways of letting Segment know which .page event should trigger this tag:

  1. You can define the name argument in the .page method as ‘Home’:
analytics.page('Home')
  1. You can give us the URL of your home page as an integration setting. Please reference the settings section for more info.

Other Features

Extra Data

This functionality is currently only available via our web integration with Criteo. We are working on adding it for mobile.

Criteo Events supports the ability to send extra data with events about a page or user to supply your events with more context (This is a feature that is set up with the assistance of your Crtieo Account Manager).

To enable this functionality, you will need to provide us with the names of the Criteo Events data parameters you would like us to pass along as well as the name of the properties or traits of the Segment .page or .identify events that you would like us to map them from.

This is setup via the Supporting User Data and Supporting Page Data settings in your Criteo Events integration settings. In each of these, you can provide us with a list of key/value mappings designating the name of the Segment property/trait on the left and the corresponding Criteo Events parameter it should map to on the right.

Here is an example of Supporting Page Data:

supporting page data screenshot

Here is an example of Supporting User Data:

supporting user data screenshot

Once this is complete, we will do the following:

We will compare the properties of any .page events you invoke with the Supporting Page Data mappings. If a match is found, we will set the values of those properties as the values of Criteo Events data parameters you defined and pass them along with any future events that occur on the page. If you are using this functionality, please ensure the .page event is being invoked on the page before any subsequent .track events.

For example, if you set the page event mappings defined above and triggered a page event like this:

analytics.page('Team Page', { team: 'New York Giants' })

And then on that same page triggered one of the .track events documented above (Product Viewed for example) the subsequent Criteo tag would look like this:

window.criteo_q.push({ event: 'viewItem', item: 'PRODUCT-ID', team_page: 'New York Giants' })

Because identify events cache any user traits you’ve specified in localstorage, we can do a similar lookup as above with the Supporting User Data mappings. If there are any matches, we will pass that data along as their corresponding Criteo data parameters.

For example, if you set the trait mappings defined above and had, at some point, previously triggered an identify event like this:

analytics.identify('userId', { subscriptionStatus: 'trial' })

Any future .track events documented above would have sub_status as an extra data parameter (assuming the user had not cleared their localstorage). Here’s the same viewItem event as an example:

window.criteo_q.push({ event: 'viewItem', item: 'PRODUCT-ID', sub_status: 'trial' })

Note: Of course if you later change the user’s subscriptionStatus to be a different value via the use of another identify call, the sub_status value will also be updated.

Setting Emails

It’s easy to associate emails with a user, if there’s an email property in a track call, we’ll include the setHashedEmail event to Criteo along with your event. We’ll take care of hashing it for you

Criteo Data Centers

Criteo has multiple data centers to better serve global companies and we will automatically infer from your users’ devices which data center to send the data to for you so you don’t need to worry about it!

Troubleshooting

Sending Dates

Criteo Events can receive dates in a specific format, in order for us to pass along dates to Criteo, make sure you follow the spec laid out in our Spec

FAQ

Is the mobile integration bundled?

Even though we don’t support integrating with Criteo Events via Segment from a server source, it’s still not necessary for you to bundle the Criteo Events SDK into the Segment SDK! This is because while our mobile integration with them is powered from our servers, the integration requires metadata that can only be supplied by the user’s mobile device (which is collected and passed along automatically by the Segment mobile SDK).

Personas

You can send computed traits and audiences generated through Segment Personas to this destination as a user property. To learn more about Personas, reach out for a demo.

For user-property destinations, an identify call will be sent to the destination for each user being added and removed. The property name will be the snake_cased version of the audience name you provide with a true/false value. For example, when a user first completes an order in the last 30 days, we will send an identify call with the property order_completed_last_30days: true, and when this user no longer satisfies we will set that value to false.

When the audience is first created an identify call is sent for every user in the audience. Subsequent syncs will only send updates for those users which were added or removed since the last sync.

Settings

Segment lets you change these destination settings from your Segment dashboard without having to touch any code.

Home Page URL

The full URL of your website’s Home page. This settings is only necessary if the path of your home url is not the standard root path (ie. ‘/’). Navigation to this page will trigger Criteo’s viewHome tag.

Supporting Page Data

Specify the property names of your Segment page event on the left and the corresponding Criteo data parameter you would like us to map it to on the right. Please reference our documentation for more info on this feature. Please note, this setting is only applicable if you are using our web integration with Criteo which is currently in beta.

Supporting User Data

Specify the Segment trait names on the left and the corresponding Criteo data parameter you would like us to map it to on the right. Please reference our documentation for more info on this feature. Please note, this setting is only applicable if you are using our web integration with Criteo which is currently in beta.

Account ID

Criteo Account ID

Event Mappings

Specify the events you would like to map to Criteo’s OneTag event types. Input your event name (case sensitive) on the left and choose the event type from the dropdown. If you do not define these mappings we will fall back on the default mappings defined in our documentation.

Adding Criteo App & Web Events to the integrations object

To add Criteo App & Web Events to the integrations JSON object (for example, to filter data from a specific source), use one of the following valid names for this integration:

  • Criteo

  • Criteo App & Web Events

Get started with Segment

Segment is the easiest way to integrate your websites & mobile apps data to over 300 analytics and growth tools.
or
Create free account