Documentation Index

Fetch the complete documentation index at: https://help.branch.io/llms.txt

Use this file to discover all available pages before exploring further.

Enable Criteo (New)

Prev Next
                 Enable Criteo (New)                                    
     
     
               
         

Enable Criteo (New)

         
         

Overview

Criteo is a global DSP that enables brands and retailers to run acquisition and retargeting campaigns across web and app. Connect Criteo to Branch to attribute clicks and installs, forward conversion events via postbacks, track deep links from product catalogs, and import cost data.

For more information about integrating ad partners in general, visit our Ad Partner Integration Guide.

Note: this guide is for new Branch

Please note that this guide is about integrating Criteo in the new Branch experience. For information on Criteo in legacy Branch, visit our legacy guide.

Partner capabilities

Capability

Details

Company type

DSP

Deep linking

Supported (catalog deep links, URI scheme deep links, static campaign links)

Attribution

Click-through attribution, View-through attribution

Ad campaign types

Acquisition campaigns, Retargeting campaigns

Ad formats

Contact Criteo for details

Click types

Client-side click, Server-side click

Supported platforms

iOS, Android

Link wrapping

Supported

Cost ingestion support

Supported

Cost ingestion types

API

Pricing models

CPC, CPM

Before you begin

To set up the Criteo integration, you need:

  • Branch's Performance product enabled for your Branch account. Contact your Branch account manager or visit https://branch.io/pricing.

  • A Branch account with access to Configuration > Ad Partners and admin permissions to enable and configure integrations.

  • The Branch SDK implemented in your app (iOS | Android) with event tracking configured.

  • A Criteo account with admin access.

Enable Criteo

To begin, navigate to Configuration > Ad Partners > Criteo.

Criteo requires account authentication before postbacks and cost data features become fully available. Select Connect with Criteo on the Status tab (or select the Partner settings gear icon) to open the Manage account dialog, then select Sign in with Criteo and complete the sign-in flow.

Once authenticated, the Status tab will show the postback status for each Criteo ad account. The Clicks and Impressions and Cost Data cards will show Needs Setup until those features are configured (see Create a Branch Ad Link and Import cost data).

(Recommended) To configure the optional PAM for Publishers privacy setting, select Partner settings to open the Manage account dialog and enable the toggle. When enabled, PAM for Publishers removes advertiser-specific user identifiers from postbacks for users who haven't opted in via Apple's App Tracking Transparency (ATT) framework, prioritizing identifiers provided directly by Criteo.

Configure attribution

By default, Criteo uses your global app attribution settings. To set attribution windows specific to Criteo, enable the Override global app settings toggle on the Attribution windows tab.

For more information, follow Configure attribution in the general Ad Partner Integration Guide.

Configure postbacks

Enabling Criteo automatically activates postbacks for INSTALL, OPEN, and PURCHASE. The default postback URL template is:

https://widget.criteo.com/s2sapp/event?mappingId=<@loop data=app.app_bundles val="bundle"><#if user_data.os == bundle.os><#if bundle.os=="ANDROID">${(bundle.android.package_name)!}<#elseif bundle.os == "IOS">${(bundle.ios.bundle_id)!}<@break/>.${ (name)! }

To add postbacks for additional events or to customize postback behavior, follow Configure postbacks in the general Ad Partner Integration Guide. For event names and any required custom metadata keys, see Data mappings below.

Note: custom event naming

For Branch Custom Events that map to Criteo events, you must use the exact event name shown in the Event names table (for example, UI_STATUS or SUBSCRIPTION). Events named differently will not match the postback template.

Import cost data

To enable cost data ingestion, select the Cost Data card on the Status tab to open the Enable Cost Data dialog. Select Sign in with Criteo to authenticate, then follow the remaining steps to complete setup. Contact your Criteo account manager if you need help locating the required credentials.

Create a Branch Ad Link to use in your Criteo campaigns. Branch uses the link to attribute clicks and impressions and deep link users into your app. Placing the Branch Ad Link in your Criteo campaign will resolve the Clicks and Impressions: Needs Setup status on the Status tab.

Criteo accepts a product catalog with links for each item. For catalog-based campaigns, replace your web product URLs with Branch Links to enable deep linking and attribution on every product. Follow Create a Branch Ad Link in the general Ad Partner Integration Guide.

Verify your data

After your integration is connected and events are flowing, you can verify data is reaching Branch and Criteo:

  • In Branch Liveview: confirm that events from your app appear in real time. This is the fastest way to confirm SDK events are firing.

  • In Branch Analysis dashboards: review attributed installs and events where Ad Partner Name = Criteo. Cost data will appear in cost-reporting views once ingestion is active.

  • In Criteo: confirm that forwarded events are appearing in your Criteo attribution reporting.

Data mappings

Campaign data

Branch populates the following fields from Criteo campaign data.

Branch field

Partner data

~advertising_partner_name

"Criteo" (static)

~feature

"paid advertising" (static)

Event names

Branch supports the full Criteo event suite. For Branch Custom Events, you must use the exact Branch event name in the table below. For events that require additional metadata, set the listed key in the event's custom data.

Branch Event name

Criteo Event name

Branch Event type

Additional metadata keys

OPEN

View Home & appDeeplink

Branch Standard Event

$criteo_deep_link_url

INSTALL

Install

Branch Standard Event

None

VIEW_ITEMS

View Listing

Branch Standard Event

None

VIEW_ITEM

View Product

Branch Standard Event

None

VIEW_CART

View Basket

Branch Standard Event

None

PURCHASE

Track Transaction

Branch Standard Event

None

ACHIEVE_LEVEL

UI Level

Branch Standard Event

ui_level

UNLOCK_ACHIEVEMENT

UI Achievement

Branch Standard Event

ui_achievement

COMPLETE_REGISTRATION

Registration

Branch Standard Event

None

COMPLETE_TUTORIAL

Tutorial Finished

Branch Standard Event

None

UI_STATUS

UI Status

Branch Custom Event

ui_status

UI_LOGIN

UI Login

Branch Custom Event

None

SUBSCRIPTION

Subscription

Branch Custom Event

None

LOW_PRIORITY

Low Priority

Branch Custom Event

None

HIGH_PRIORITY

High Priority

Branch Custom Event

None

ABANDONED_BASKET

Abandoned Basket

Branch Custom Event

None

Talk to your Criteo Solutions Engineer to confirm which events are appropriate for your app.