Criteo has announced a new version of their API, which will be replacing the current "MAPI" version as of April 1st, 2021. We have been working with the Criteo API team to plan our migration to the newest version, and wanted to give notice of possible breaking changes to prepare you for the changes.
We have deployed the main API upgrade on March 9th, 2021 and have outlined the specific field changes that are taking place below. And have deployed some authentication updates on March 24th.
Known Breaking Changes March 9th
These changes are now live Google Sheets, Data Studio, and Excel products as of March 9th.
For Data Studio users - you will need to refresh your data source per How do I Refresh Fields/Update a Connector? to get the updated field list.
For Google Sheets - the sidebar may cache the old fields for some time after deployment. If you do not see the changes immediately, please wait and try again, making sure to close and reopen the sidebar. If you still do not see the updates after 24 hours, please reach out to customer support.
Please note that API, BigQuery, Snowflake, and other data warehouse products will have delayed implementations (usually 1-2 weeks). Our team that covers these products will have separate notifications for that implementation and changes that go along with it, such as adjustments to the standard schema.
The following fields will be renamed:
|Current Display Name||New Display Name|
|Cost per order||CPO (cost per order)|
|Effective cost||COS (cost of sale)|
The following fields will be replaced by new fields. The original field will be deprecated, so you will need to update queries that use the current fields to use the replacements instead.
|Deprecated Field||Use instead...|
|Budget type||Budget strategy|
|Post-view conversion rate||Conversion rate, with appropriate conversion window setting|
|Cost per post-view order||CPO (cost per order), with appropriate conversion window setting|
|Cost per order post-click + post-view||CPO (cost per order), with appropriate conversion window setting|
|Post-click sales||Sales, with appropriate conversion window setting|
|Post-view sales||Sales, with appropriate conversion window setting|
|Post-view sales (sales_pc_pv version)||Sales, with appropriate conversion window setting|
|All post-click sales||Sales, with appropriate conversion window setting|
|Effective cost of post-view sales||COS (cost of sale), with appropriate conversion window setting|
|Effective cost of post-click + post-view sales||COS (cost of sale), with appropriate conversion window setting|
|Post-click revenue generated||Revenue, with appropriate conversion window setting|
|Post-view revenue generated||Revenue, with appropriate conversion window setting|
|Revenue generated post-click + post-view||Revenue, with appropriate conversion window setting|
|Campaign||Ad set name|
|Campaign ID||Ad set ID|
|Campaign status||Ad set status|
|Campaign bid type||Ad set bid type|
|Bid value||Ad set bid value|
The following fields will be deprecated and have no replacement in the new API. You will need to update your queries to remove these:
- Budget ID
- Budget remaining updated
- Total budget
- Maximum impressions
- Same device post-click sales
- Non-deduplicated post-click sales
- Non-deduplicated post-view sales
- Non-deduplicated post-click revenue generated
- Non-deduplicated post-view revenue generated
- Effective cost per click (eCPC)
- Category product amount
- Category average price
Conversion Window Setting
We will be adding a "Conversion window" advanced option to be used with the conversion-based fields to control if they are looking at post-click and/or post-view. These used to be separate fields, but instead you can use the base conversion field and adjust this setting to make it show as post-click or post-view.
It will support the following values:
- Post click 30 days (default)
- Post click 1 day
- Post click 7 days
- Post view 24 hours
- All post click 1 day
- All post click 7 days
- All post click 30 days
- All post view 24 hours
- Post click 30 days + post view 24 hours
- All post click 30 days + post view 24 hours
- Client attribution
- All client attribution
Example in Google Sheets:
The following new fields will be added:
- Advertiser name
- Advertiser ID
- Budget renewal
- Budget delivery smoothing
- Budget delivery week
- Targeted environments
- Targeted devices
- Targeted operating systems
- Targeted countries
- Targeted subdivisions
- Targeted zip codes
- Viewed displays
- Unviewed displays
- Untracked displays
- Qualified visits
- Cost per visit
- Bounce rate
- Potential displays
- Post-install sales
- App installs
- Post-install conversion rate
- Post-install cost of sale
- Post-install order value
- Cost per install
- Install rate
- Post-install cost per order
- Post-install ROAS
- Store ROAS
- Store sales
- Store revenue
Authentication Changes March 24th
We have deployed changes to the authentication system for Criteo on March 24th, though not the oAuth system as originally communicated. It was found with Criteo this system is not ready yet, so we will be updated the connector to use the new API's API key system for authentication.
Existing API keys should continue to work, but they will now fetch ALL ACCOUNTS by default to allow them to continue to work in the new system. You may edit the query to select the advertiser(s) you wish to use instead, if ALL ACCOUNT is not appropriate.
However, if you run into authentication or permissions errors after March 24th, please follow these instructions to set up a new API key under the new Criteo system: https://support.supermetrics.com/support/solutions/articles/19000098159-accessing-criteo
The new API keys also have different scopes, so it could be necessary to create a new key to get information from the new budget and tracking fields.
Please note that API, Snowflake, and other data warehouse products will have delayed implementations of the authentication changes (usually 1-2 weeks later). These changes will be communicated separately for those users affected.