Criteo

The Switchboard Connector for Criteo provides automated revenue, impression, and campaign reports by accessing the Criteo’s reporting and retail media APIs.

Prerequisites
Scheduling
All Data Report
Campaigns Report
Line Items Report

Prerequisites

The pre-requisites for Criteo depend upon whether you are using the All Data Report or the Campaign and Line Items Reports.

For the All Data report you will need to add a Criteo Key in the Switchboard Key Editor with the following information:

Email - The email used to login to the Criteo UI
API Token - To obtain the API Token, contact the Criteo Technical Account manager.

For the Campaign Report and the Line Items Report you will need to add a Criteo Analytics Key in the Switchboard Key Editor with the following information:

Client ID - The email used to login to the Criteo UI
Client Secet - This is obtained from the Criteo Developer Dashboard

Scheduling

The Switchboard Criteo Connector can be scheduled to ingest data once per day at a user-defined hour and timezone.

By default, the connector will run once at 6am PT. See Daily Scheduling for more information.

All Data Report

Note that this report requires a Criteo Key (not a Criteo Analytics Key)

Parameters

currency string: required; A list of requested dimensions.; Three letter currency code for the currency selected by the user on the platform. At least one value is required
data_source string: optional; Restricts data scope. Valid values includeL; AllData, Only3PD, Except3PD
dimensions string list: required; A list of requested dimensions.; For dimensions descriptions, see Criteo Developer Documentation.
metrics string list: required; A list of requested metrics.; For metrics descriptions, see Criteo Developer Documentation.
period string: required; At last one of the following values for a requested time period:; hourly, daily, monthly
report_timezone string: required; At least one of the following values for a requested timezone:; CET, CEST, SGT, JST, GMT, EST, CST, PST

Switchboard Script Syntax

import criteo from {
   type: "criteo_v3";
   key: "criteo_key";
   data_source: "AllData";
   dimensions: ["DisplayType",
                "ZoneName",
                "Device"];
   metrics: ["CriteoDisplays",
                "Participation",
                "Requests",
                "Revenue"];
   currency: "USD";
   period: "daily";
   } using {
                "NetworkId": integer;
                "CriteoDisplays": integer;
                "DisplayType": string;
                "TimeId": datetime;
                "Device": string;
                "Requests": integer;
                "Participation": integer;
                "ZoneName": string;
                "Revenue": float;
                };

Campaigns Report

Note that this report requires a Criteo Analytics Key

Parameters

account_id string: required; Your Account ID
campaign_type string: optional; allowed values are sponsoredProducts, onSiteDisplays
click_attribution_window string: optional; allowed values include 17D, 14D, 30D; See the Criteo API documentation for an explanation on Criteo’s attribution rules
dimensions string: optional; for a full list of dimensions see the Criteo documentation on Metrics and Dimensions
metrics string: optional; for a full list of metrics see the Criteo documentation on Metrics and Dimensions
report_type string: optional; The available Report Types are outlined on in the Criteo API Documentation Report Types page
time_zone string: optional; allowed values include America/New_York, Europe/Paris, Asia/Seoul, UTC
view_attribution_window string: optional; allowed values include 1D, 7D, 14D, 30D; See the Criteo API documentation for an explanation on Criteo’s attribution rules

Switchboard Script Syntax

download t from {
            type: "criteo:campaigns_report";
            key: "criteo_analytics";
            account_id: "21421162939016778";
            metrics: ["impressions"];
            dimensions: ["date"];
            report_type: "pageType";
            time_zone: "UTC";
            click_attribution_window: "7D";
            campaign_type: "sponsoredProducts";
        } using {*};

Line Items Report

Note that this report requires a Criteo Analytics Key

Parameters

See the Campaigns Report above

Switchboard Script Syntax

download t from {
            type: "criteo:line_items_report";
            key: "criteo_analytics";
            account_id: "21421162939016778";
            metrics: ["impressions"];
            dimensions: ["date"];
            report_type: "pageType";
            time_zone: "UTC";
            click_attribution_window: "7D";
            campaign_type: "sponsoredProducts";
        } using {*};