Criteo

Last updated on Feb 20, 2023

Criteo uses the concept of private apps to create API keys containing the Client ID and Client Secret, which are used to authenticate Hevo to read your marketing and advertising data. The app is configured with the requisite permissions to fetch the different types of data from Criteo using REST APIs. The Pipeline in Hevo then integrates with the app to access the data and loads it into the Destination.

The transfer of data from your Criteo account to the Destination location, therefore, comprises the following one-time setups:

Creating an app in Criteo and retrieving the Client ID and Client Secret.
Assigning permissions to the app to read the data using Criteo’s Rest APIs.
Creating a Pipeline in Hevo for transferring data from Criteo to the Destination database or data warehouse.

For creating Pipelines using this Source, Hevo provides you a fully managed BigQuery data warehouse as a possible Destination. This option remains available till the time you set up your first BigQuery Destination irrespective of any other Destinations that you may have. With the managed warehouse, you are only charged the cost that Hevo incurs for your project in Google BigQuery. The invoice is generated at the end of each month and payment is recovered as per the payment instrument you have set up. You can now create your Pipeline and directly start analyzing your Source data. Read Hevo Managed Google BigQuery.

Setup

Data Sync

Prerequisites

An active Criteo account from which data is to be ingested.
The Criteo Client ID and Secret for authorizing Hevo to access the data in Criteo.

Retrieving the Client ID and Client Secret

To provide Hevo access to your Criteo data, you need to create an app in Criteo and log in to Hevo using the app’s credentials.

Log in to your Criteo account.
Go to Criteo’s Developer Portal and create an organization.
In the My Apps page, click Create a new app or the + icon to create an app.
In the App Credentials section, click Create new key to download your app credentials.

Note: The downloaded file contains the Client ID and Client Secret, which are needed to configure Criteo on Hevo.
In the Service section, select the Marketing solutions product and click Save.
In the Authorization section, set the access authorization for all the domains to Read and click Save.
Scroll to the top of the page and click Activate app. The button changes to Generate new URL. Click this button.
Copy the URL that is generated and open it in a new tab or share it with your Criteo Admin user.
In the Portfolio access field, select the portfolios you wish to grant to the application you created above, and click Save.

Configuring Criteo as a Source

Perform the following steps to configure Criteo as the Source in your Pipeline:

Click PIPELINES in the Asset Palette.
Click + CREATE in the Pipelines List View.
In the Select Source Type page, select Criteo.
In the Configure your Criteo Source page, specify the following:
- Pipeline Name: A unique name for your Pipeline.
- Client ID: The client ID provided in the file you downloaded in Step 4 of section, Retrieving the Client ID and Client Secret to enable Hevo to read data from your Criteo account.
- Client Secret: The Client Secret provided in the file you downloaded in Step 4 of section, Retrieving the Client ID and Client Secret.
- Timezone: The timezone as per which the Adset Transaction Report data must be replicated. Default timezone: UTC.
- Currency: The currency in which the transaction values in the Adset Transaction Report must be replicated. Default currency: USD.
- Historical Sync Duration: The duration for which the existing data in the Source must be ingested. Default duration: 1 Year.
Click TEST & CONTINUE.
Proceed to configuring the data ingestion and setting up the Destination.

Data Replication

Default Pipeline Frequency	Minimum Pipeline Frequency	Maximum Pipeline Frequency	Custom Frequency Range (Hrs)
3 Hrs	30 Mins	24 Hrs	1-24

Historical Data: Hevo ingests the historical data for the campaign_report object on the basis of the historical sync duration selected at the time of creating the Pipeline.
Incremental Data: Once the historical data ingestion is complete, every subsequent run of the Pipeline fetches the entire data for the objects. In case of the campaign_report object though, only the new and modified data is ingested.
Refresher Data: All reporting data for the campaign_report object is refreshed on a rolling basis to update any conversions attributed to clicks for the past 30 days.

Note: The time taken to fetch historical data depends on how many days are selected at the time of creating a Pipeline. Hence, Hevo defaults this period to one year before today, and if required you may customize it to any date, with the earliest being January 01, 2010.

Schema and Primary Keys

Hevo uses the following schema to upload the records in the Destination database:

Data Model

The following is the list of tables (objects) that are created at the Destination when you run the Pipeline:

Object	Primary Key	Description
Advertiser	- id	Contains the list of specific advertisers for your user. (Advertiser Portfolio).
Adset	- id	Contains the complete list of adsets (earlier called campaigns) for an advertiser along with activity and bid statuses.
Adset Transaction Report	- transaction_id	Contains report data of transactions within a given time period, transactions associated with select or all advertisers in your portfolio or specific transaction IDs.
Audience	- id	Stores the contact lists which are used for your advertising campaigns.
Statistics Report	- adset_id - advertiser_id - category_id - day	Contains day-level data related to your adsets’ (campaign) performance. The report returns all possible metrics supported by Criteo across the Advertiser, Category, and Adset dimensions for each day.

Additional Information

Read the detailed Hevo documentation for the following related topics:

Limitations

Limitations

None.

Revision History

Refer to the following table for the list of key updates made to this page:

Date	Release	Description of Change
Feb-20-2023	NA	Updated section, Configuring Criteo as a Source to update the information about Historical Sync Duration.
Oct-25-2021	NA	Added the Pipeline frequency information in the Data Replication section.
Jul-22-2021	NA	- Updated the content for all the sections. - Revised the data model and schema to reflect the latest objects supported and deprecated by Criteo as of June 15, 2021. - Added a note in the Overview section about Hevo providing a fully-managed Google BigQuery Destination for Pipelines created with this Source.