GuidesAPI ReferenceChangelog
GuidesAPI ReferenceChangelog
GuidesAPI ReferenceChangelogLog In
Changelog
These docs are for v2022.10. Click to read the latest docs for v2024.10.
Back to All
added

Version 2023.01 Release Notes

almost 2 years ago by [email protected]

Version 2023.01 of the Criteo retail media API is live as of January 17th and will be supported until January 30th, 2024. A new Postman collection will also be available in the upcoming days for 2023.01.

📘

New SDK Release

We are working on new improvements to our SDK library for retail media and marketing solutions, so one will not be immediately available for 2023.01. We will make a new change log announcement as soon as a new SDK version is released.

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

New Base URL"

With the introduction of this new version, the base URL will now change from the

Old base url

https://api.criteo.com/2022-10/retail-media/{endpoint}

to

New base url

https://api.criteo.com/2023-01/retail-media/{endpoint}

 

What's New

In v.2023.01, we introduced new campaign and line-item features and attributes.

Bid Multipliers

We introduced two new endpoints in the latest release to support bid multiples for open auction line items. Bid Multipliers provide campaign managers more control over managing bids at the line item level while also optimizing campaign performance goals at a page-type level. Bid multipliers are available for enabled page types for Open Auction line items.

New Endpoints Includes

VerbEndpointDescription
GET/line-items/{lineItemId}/bid-multipliersReturns all bid multipliers for valid page types of the specified line item.
PUT/line-items/{lineItemId}/bid-multipliersReplaces all existing bid multipliers with the provided bid multipliers or the default value (1.0).

 

New Campaing Attributes

In the Campaigns API, we added five new campaign attributes to support campaign management. These attributes are available starting with API version 2023.01. And while the new attributes will not be available in version 2022.10 and older, the new attributes do not prevent your application from continuing to make regular calls to existing or older campaigns. For your application to begin using these new attributes, you will need to upgrade your campaign's API to v2023.01 to use the latest campaign attributes. Campaings that do not use these attributes before will have a default null value.

The new attributes include the following:

  • monthlyPacing - The maximum monthly spend allowed for the campaign in the currency of the account.

  • daily pacing - The maximum daily spend allowed for the campaign in the currency of the account.

  • isAutoDailyPacing - automatically controls your daily pacing by calculating the days left in the month of the account

  • startDate - set a campaign start date

  • endDate - set a campaign end date