Discard
GuidesAPI ReferenceChangelogDiscussions
GuidesAPI ReferenceChangelogDiscussionsLog In

Changes From v2021.10 to v2022.04

This page lists all endpoint changes related to the v2021.04 release

📘

Version 2022.04 of the Criteo API is live as of April 5th, 2022. This version will be supported until April 4th, 2023

This version introduces several new capabilities to Criteo Retail Media API and introduces changes in previously existing endpoints. This page aims at listing all changes that happened endpoint per endpoint. Only endpoints with changes are listed here.

New Base URL

We are moving from:
https://api.criteo.com/2021-10/retail-media/{endpoint}
to
https://api.criteo.com/2022-04/retail-media/{endpoint}

What's New in v2022.04

:new: New Capability to Pause or Unpause the Serving of an SKU

In this new version, we have introduced two new endpoints that allow to pause or unpause products belonging to a line item. The new endpoints also provide the option to apply a bid override. The new endpoints include

POST - https://api.criteo.com/2022-04/retail-media/line-items/{lineItemId}/products/pause
POST - https://api.criteo.com/2022-04/retail-media/line-items/{lineItemId}/products/unpause

:bar-chart: Updates Made to Report Field Names, and Metric Calculations

Metric Calculation Changes
We changed impression calculation for preferred deals and open auction campaigns. These changes in the API are now reflecting the same reporting logic for impressions used by reports within the Retail Media Platform.

For the following reports, the API will report impressions as follows:

  • For Preferred Deals campaigns - the sum of placement impressions
  • For Open Auction campaigns - the sum of product impressions

Summary Report
Metrics changed by impression calculation change:
- Campaign: CampaignCtr and CampaignFrequency
- Line Item: lineItemCtr and lineItemFrequency

pageType Report
Metrics changed by impression calculation change:
- Campaign: CampaignCtr
- Line Item: lineItemCtr

Keyword Report
Metrics changed by impression calculation change:
- Campaign: CampaignCtr and CampaignFrequency
- Line Item: lineItemCtr and lineItemFrequency

Report Field Names
In this version, we also updated some report field names. For example, in previous versions where the reports fields such as productCPC or productRoas, in the latest version, we renamed to simply CPC or ROAS.

📘

NOTE

Besides metrics that utilize impressions for calculations, no other report metric had its calculation logic modified.

Campaign Reports

Report

Old Field Name

New Field Name in v2022.04

Product

  • productClicks
  • productImpressions
  • productCtr
  • productCpc
  • productCpo
  • productRoas
  • clickSpend
  • clicks
  • impressions
  • ctr
  • cpc
  • cpo
  • roas
  • spend

ProductCategory

  • productClicks
  • productImpressions
  • productCtr
  • productCpc
  • productCpo
  • productRoas
  • clickSpend
  • clicks
  • impressions
  • ctr
  • cpc
  • cpo
  • roas
  • spend

Summary

  • campaignPlacementImpressions
  • campaignCtr
  • impressions
  • ctr

Page Type

  • campaignCtr
  • campaignFrequency
  • campaignPlacementImpressions
  • ctr
  • frequency
  • impressions

keyword

  • CampaignPlacementImpressions
  • campaignCtr
  • impressions
  • ctr

attributedTransactions

No Change

No Change

Line Item Reports

Report

Old Field Name

New Field Name in v2022.04

Product

  • productClicks
  • productImpressions
  • productCtr
  • productCpc
  • productCpo
  • productRoas
  • clickSpend
  • clicks
  • impressions
  • ctr
  • cpc
  • cpo
  • roas
  • spend

ProductCategory

  • productClicks
  • productImpressions
  • productCtr
  • productCpc
  • productCpo
  • productRoas
  • clickSpend
  • clicks
  • impressions
  • ctr
  • cpc
  • cpo
  • roas
  • spend

Summary

  • lineItemPlacementImpressions
  • lineItemFrequency
  • lineItemCtr
  • impression
  • frequency
  • ctr

PageType

  • lineItemPlacementImpressions
  • lineItemCtr
  • impressions

keyword

  • lineItemPlacementImpressions
  • lineItemCtr
  • impressions

attributedTransactions

No Changes

No Changes


Did this page help you?