❗️

Sunset of MAPI

All MAPI endpoints were migrated to Criteo API on July 18, 2022. To learn more about using the Criteo APIs please see our Onboarding checklist.

Criteo Offsite Ads (former CRP) account owners and application owners need to migrate a connector from the legacy MAPI connector to Criteo API as per the instructions below.

Introduction

This article is intended to serve as a guide for the account owners and application owners in the process of migrating from the legacy endpoints to Criteo API versioned endpoints. As a rule, the deprecation date of a legacy endpoint is 6 months from the release date of the versioned endpoint.
Please check the latest changelog to be aware of the new features in the latest stable release.

If you have received a link to this article on or after 21.01.2022 it means you could be an owner of the Criteo Offsite Ads (COA) account or an owner of the COA application.

Target audience

• Account owners: Anyone with administrative ownership rights over a Criteo account. Typically this is a team member with "Administrator" role in the Commerce Growth.

• Application owners: The team or an organization which develops, owns and maintains the connector code.

If the account owner and application owner are the same entity, then the organization name in the developer portal should be set the same as the advertiser name.
Please note only the account Administrator role can approve consent requests for the scope of their accounts, i.e it is not possible for the Business Manager to approve the application consent request. Hence the application owners should generate and send the consent link to the account administrators.

Pre-requisites

• Application owners should complete the onboarding in our new Developer Portal as indicated in the onboarding checklist.

• As per the checklist an application owner should generate the consent URL and share the URL by email, Slack, or any other means with the account owner.

• Application owners and account owners should get familiar with Versioning Policy. API versioning provides predictability and insight into scheduled changes. This helps you control how you choose to handle feature upgrades and deprecations.

• Basic understanding of the new Criteo campaigns structure: Campaigns, Ad Sets, and Ads. Bid Strategy and budget became a property of an Ad Set. Targeting controls and bid targets are set at the Ad Set level. Several Ad Sets can be linked to the same Campaign. Ads are the actual media that is used to address the audience of a given Ad Set. There can be many Ads associated with a given Ad Set.

Authorization

Once the account owner (e.g Account Administrator) receives and clicks on the consent link, they will be redirected to the Criteo Consent Portal where they can grant you the requested authorization levels for the accounts in their portfolio.

Criteo OffSite Ads require "Campaign" domain permission. (see step 3)

Endpoints parity - Criteo Offsite Ads - COA (former CRP)

The table below describes the new endpoint paths for the COA API. The endpoints’ functionality remains the same – only the paths have changed. Account owners and application developers are expected to complete completion - by the end of Q2 2022.

❗️

v2020.07 note

Version 2020.07 is a special version of Criteo API that aggregates the legacy endpoints under the new API framework. Once an endpoint is released under the standard stable version (e.g “2022-10“) you will have 6 months to migrate from v2020.07 to the new version. Please keep an eye on the changelog to be aware of all upcoming changes.

Endpoints parity - Criteo Marketing Solutions (CMS)

The migration has been completed. The table below is provided as historical records only. No action is needed.

Budgets - Criteo Marketing Solutions (CMS)

The migration has been completed. The table below is provided as historical records only. No action is needed.

In parallel with the API migration, we have migrated the budgets to a new spend management system. On the UI side, these features replaced the budget module within Commerce Growth, and on the API side /v1/budgets endpoint has been replaced by Ad Set and Campaign endpoints.

More specifically, it's now possible to update campaign-level spend limits while updating budgets became a direct component of ad sets. The new system also introduces real-time budget editing.

Your preexisting budget behavior has been replicated through a combination of campaign spend limit and ad set budget settings.

Information about updating and retrieving campaign-level spend limits is available here: Update Campaigns

Information about updating and retrieving Ad Set-level spend strategy is available here: Update Ad Sets

Summary

The document provided you with guidance on completing the steps of legacy migration. The guides section will help to navigate through various usage scenarios of the endpoints and contain more detailed migration instructions for each of the endpoints:

Feel free to reach out to us through your account representative or the Discussion section of the portal if you have any questions.