GuidesAPI ReferenceChangelog
GuidesAPI ReferenceChangelog
GuidesAPI ReferenceChangelogLog In
Changelog
Back to All

Version 2023.07 release notes

over 1 year ago by [email protected]

Version 2023.07 of the Criteo API is live as of July 28, 2023. This is a stable API version and will be supported until July 31, 2024. After that, all Endpoints that have not been deprecated will be “out of support” but still accessible.  Please consult our versioning policy for more information. Our corresponding client libraries (Python, Java, and PHP) and Postman have been updated with the new version.

In this update, we introduced a new way to create an app via the Partner Portal.  Also, several endpoints have moved from our preview to a stable API version. These relate to Audience, Ads, and Ad Sets.

What's new

We are excited to share updates regarding the process of creating a new App for API Developers at https://partners.criteo.com. In this release, we have focused on enhancing the user experience, making it more intuitive for those building API Applications.

Streamlined App Creation Stepper:

We have replaced the previous complex, non-linear process with a much more user-friendly App creation stepper. This streamlined approach ensures a quicker and more intuitive~[SM2]~ of the App creation process.

The New Steps:

  1. Name Your App: Start by giving your App a name, making it easier to identify and manage in the future.
  2. Choose an Authentication Method: Select the authentication method that best suits your requirements.
  3. Pick Your Service: Choose the specific service that your App will interact with.
  4. Select Required Authorization: Specify the authorization levels needed for your App, ensuring the right level of access and security.

These updates are designed to simplify the process, reducing unnecessary scrolling and making it more efficient for you to build API connections. We believe that these enhancements will significantly improve the experience for our API consumers, allowing you to focus on what matters most: building innovative solutions.

What's changed

Several endpoints have transitioned from the preview to the stable version of our API. These endpoints are related to Audiences, Ads, and Ad Sets, improving our API offerings' reliability for our end users.

The following endpoints are now available in the stable version:

Audiences

Create Audiences
Creates all Audiences with a valid configuration and returns them. For those that cannot be created, one or multiple errors are returned.
POST /marketing-solutions/audiences/create

Create Audience Segments
Create audience segments in bulk mode. Creates all audience segments with a valid configuration and returns their IDs with their advertiser IDs, names, and creation/update dates. One or multiple errors are returned for those that cannot be created.
POST /marketing-solutions/audience-segments/create



Compute Audience Segment sizes
If you have already created one or more segments and would like to know their size, you can do so by using this endpoint. It returns the size of one or more audience segment IDs (if available and if supported). For those whose size cannot be retrieved, one or multiple errors are returned.
POST /marketing-solutions/audience-segments/compute-sizes

Ads

Creating A New Ad
A new ad can be created for a specific advertiser and from an existing creative by making a POST call to the ads endpoint. The request body should specify the name, description (optional), creative id, adset id, start date and end date (optional) of the new ad.
POST /advertisers/{advertiserId}/ads

Deleting an ad
An ad can be deleted by specifying the ad id in the URL path of a DELETE call to the ads endpoint.
DELETE /ads/{adId}



Creating a new HTML Ad Tags
A new HTML Ad Tag can be created for a specific advertiser by making a POST call to the creatives endpoint. The request body should specify the name, adset id, description (optional), format (HtmlTag), dataset ID and HTML attributes of the new HTML creative.
POST /advertisers/{advertiserId}/creatives

Ad Sets

Create an Ad Set
A new ad set can be created for a specific advertiser by making a POST call to the ad set endpoint. The request body should specify the type (Adset) and the ad set attributes.
POST /marketing-solutions/ad-sets

Create a campaign
A new campaign can be created for a specific advertiser by making a POST call to the campaigns endpoint. The request body should specify the type (Campaign) and the campaign attributes.
POST /marketing-solutions/campaigns