Knowledge Base
Admin

Criteo

Criteo API - MarketingSolutions. The Criteo Marketing Solutions API provides programmatic access to Criteo's advertising platform, enabling developers to manage campaigns, audiences, creatives, ads, and analytics for performance marketing. The API supports operations across the full campaign lifecycle: creating and configuring campaigns and ad sets, managing audience segments and targeting, uploading and managing creative assets, and retrieving detailed performance analytics and statistics. A...

Active

Capabilities (55)

Delete Ad

Delete an existing ad from an advertiser's account. This removes the ad and its association with the ad set and creative.

delete_ad(id)
Destructive
Required scopes:
MarketingSolutions_Creative_Manage

Get Advertiser Coupons

Get the list of self-services Coupons for a given advertiser

get_advertiser_coupons(advertiser-id, limit?, offset?) -> {data, errors, warnings}
Required scopes:
MarketingSolutions_Creative_Read

Patch Ad Sets

Patch a list of AdSets.

patch_ad_sets(data?) -> {data, errors, warnings}
Required scopes:
MarketingSolutions_Campaign_Manage

Compute Audience Segments Sizes

Gets the size of all segments. An error is returned for those whose size calculation is not supported.

compute_audience_segments_sizes(data?) -> {data, errors, warnings}
Required scopes:
MarketingSolutions_Audience_Manage

Get Adset Report

This Statistics endpoint provides adset related data. It is an upgrade of our previous Statistics endpoint, and includes new metrics and customization capabilities.

get_adset_report(currency, dimensions, endDate, metrics, startDate, adSetIds?, adSetNames?, adSetStatus?, advertiserIds?, format?, timezone?) -> string
Required scopes:
MarketingSolutions_Analytics_Read

Get Display Multipliers

Get the Display Multipliers for all valid Categories associated to an Ad Set

get_display_multipliers(ad-set-id) -> {data, errors, warnings}
Required scopes:
MarketingSolutions_Campaign_Read

Get Ad Set Category Bids

Get the Category Bids for all valid Categories associated to an Ad Set

get_ad_set_category_bids(ad-set-id) -> {data, errors, warnings}
Required scopes:
MarketingSolutions_Campaign_Read

Get Ad Set

Get the data for the specified ad set

get_ad_set(ad-set-id) -> {data, errors, warnings}
Required scopes:
MarketingSolutions_Campaign_Read

Get Campaign

Get the data for the specified campaign

get_campaign(campaign-id) -> {data, errors, warnings}
Required scopes:
MarketingSolutions_Campaign_Read

Delete Contact List By Audience Segment

Delete all identifiers from a contact list audience-segment.

delete_contact_list_by_audience_segment() -> {data, errors, warnings}
Destructive
Required scopes:
MarketingSolutions_Audience_Manage

Get Creative

Get a Creative with its id

get_creative(id) -> {data, errors, warnings}
Required scopes:
MarketingSolutions_Creative_Read

Edit Creative

Edit a specific Creative

edit_creative(id, data?) -> {data, errors, warnings}
Destructive
Required scopes:
MarketingSolutions_Creative_Manage

Start Ad Sets

Start the specified list of ad sets

start_ad_sets(data?) -> {data, errors, warnings}
Required scopes:
MarketingSolutions_Campaign_Manage

Get Current Application

Get information about the currently logged application

get_current_application() -> {data, errors, warnings}

Update Ad Set Audience

Link or unlink an audience with an ad set

update_ad_set_audience(ad-set-id, data?) -> {data, errors, warnings}
Destructive
Required scopes:
MarketingSolutions_Campaign_Manage

Delete Audiences

Deletes the audiences associated to the given audience IDs.

delete_audiences(data?) -> {data, errors, warnings}
Required scopes:
MarketingSolutions_Audience_Manage

Get Transactions Report

This Transactions endpoint provides transactions id related data.

get_transactions_report(data?) -> string
Required scopes:
MarketingSolutions_Analytics_Read

List Advertisers

Fetch the portfolio of Advertisers for this account

list_advertisers() -> {data, errors, warnings}

Create Campaign

Create the specified campaign

create_campaign(data?) -> {data, errors, warnings}
Required scopes:
MarketingSolutions_Campaign_Manage

Patch Campaigns

Patch a list of Campaigns.

patch_campaigns(data?) -> {data, errors, warnings}
Required scopes:
MarketingSolutions_Campaign_Manage

Delete Audience Segments

Delete the segments associated to the given audience IDs.

delete_audience_segments(data?) -> {data, errors, warnings}
Required scopes:
MarketingSolutions_Audience_Manage

Create Audience Segments

Creates all segments with a valid configuration, and returns their IDs. For those that cannot be created, one or multiple errors are returned.

create_audience_segments(data?) -> {data, errors, warnings}
Required scopes:
MarketingSolutions_Audience_Manage

Get Audience Segments In Market Interests

Returns a list with all available in-market interests that can be used to define an in-market segment. These in-market interests correspond to the Google product taxonomy.

get_audience_segments_in_market_interests(advertiser-id, country) -> {data, errors, warnings}
Required scopes:
MarketingSolutions_Audience_Read

Get Advertiser Coupon Supported Sizes

Get the list of Coupon supported sizes

get_advertiser_coupon_supported_sizes(advertiser-id, ad-set-id?) -> {data, errors, warnings}
Required scopes:
MarketingSolutions_Creative_Read

Create Audiences

Creates all audiences with a valid configuration, and returns their IDs. For those that cannot be created, one or multiple errors are returned.

create_audiences(data?) -> {data, errors, warnings}
Required scopes:
MarketingSolutions_Audience_Manage

Delete Advertiser Coupon

Delete an existing coupon from the specified advertiser's account. This permanently removes the coupon and its associated promotional configuration.

delete_advertiser_coupon(advertiser-id, id)
Destructive
Required scopes:
MarketingSolutions_Creative_Manage

Patch Ad Set Category Bids

Patch Category Bids for one or more Categories in a single request. Partial success policy is followed.

patch_ad_set_category_bids(ad-set-id, data?) -> {data, errors, warnings}
Required scopes:
MarketingSolutions_Campaign_Manage

Compute Audiences Sizes

Gets the size of all audiences. An error is returned for those whose size calculation is not supported.

compute_audiences_sizes(data?) -> {data, errors, warnings}
Required scopes:
MarketingSolutions_Audience_Manage

Create Advertiser Coupon

Create a new coupon-supported creative for the specified advertiser. Coupons enable promotional offers to be displayed within advertising creatives.

create_advertiser_coupon(advertiser-id, data?) -> {data, errors, warnings}
Required scopes:
MarketingSolutions_Creative_Manage

Create Advertiser Creative

Create a new creative asset for the specified advertiser. Supports image creatives (static or animated GIF) and HTML ad tag creatives hosted on external ad servers.

create_advertiser_creative(advertiser-id, data?) -> {data, errors, warnings}
Required scopes:
MarketingSolutions_Creative_Manage

Search Ad Sets

Search for ad sets matching specified filter criteria. Returns a list of ad sets with their targeting configurations, bid settings, frequency caps, and scheduling details.

search_ad_sets(filters?) -> {data, errors, warnings}
Required scopes:
MarketingSolutions_Campaign_Read

Estimate Audience Segments Sizes

Gets the size estimation of a non existent segment. An error is returned when size calculation is not supported.

estimate_audience_segments_sizes(data?) -> {data, errors, warnings}
Required scopes:
MarketingSolutions_Audience_Manage

Edit Advertiser Coupon

Edit a specific Coupon

edit_advertiser_coupon(advertiser-id, id, data?) -> {data, errors, warnings}
Destructive
Required scopes:
MarketingSolutions_Creative_Manage

Create Advertiser Ad

Create a new ad for the specified advertiser. An ad connects a creative asset to an ad set, defining what audiences will see across web and mobile advertising platforms.

create_advertiser_ad(advertiser-id, data?) -> {data, errors, warnings}
Required scopes:
MarketingSolutions_Creative_Manage

Get Audience Segment Contact List Statistics

Returns the statistics of a contact list segment.

get_audience_segment_contact_list_statistics(audience-segment-id) -> {data, errors, warnings}
Required scopes:
MarketingSolutions_Audience_Read

Get Advertiser Coupon

Get a Coupon with its id

get_advertiser_coupon(advertiser-id, id) -> {data, errors, warnings}
Required scopes:
MarketingSolutions_Creative_Read

Search Campaigns

Search for campaigns

search_campaigns(filters?) -> {data, errors, warnings}
Required scopes:
MarketingSolutions_Campaign_Read

Patch Display Multipliers

Patch Display Multipliers for one or more Categories in a single request. Partial success policy is followed.

patch_display_multipliers(ad-set-id, data?) -> {data, errors, warnings}
Required scopes:
MarketingSolutions_Campaign_Manage

Update Audience Segments

Updates the properties of all segments with a valid configuration, and returns their IDs. For those that cannot be updated, one or multiple errors are returned.

update_audience_segments(data?) -> {data, errors, warnings}
Required scopes:
MarketingSolutions_Audience_Manage

Generate Creative Preview

Get the preview of a specific Creative

generate_creative_preview(id, height?, width?) -> string
Required scopes:
MarketingSolutions_Creative_Manage

Get Placements Report

Your ads are placed in different domains (publishers) and environments (websites and apps). Thanks to the placements endpoint, you can analyse the performances for each publisher, comparing displays, clicks and sales generated.

get_placements_report(data?) -> string
Required scopes:
MarketingSolutions_Analytics_Read

Get Transparency Report

This Statistics endpoint provides publisher data.

get_transparency_report(advertiser-id, endDate, startDate, shouldDisplayProductIds?) -> {data, errors, warnings}
Required scopes:
MarketingSolutions_Analytics_Read

Get Ad

Get an Ad with its id

get_ad(id) -> {data, errors, warnings}
Required scopes:
MarketingSolutions_Creative_Read

Get Audience Segments In Market Brands

Returns a list with all available in-market brands that can be used to define an in-market segment.

get_audience_segments_in_market_brands(advertiser-id, country) -> {data, errors, warnings}
Required scopes:
MarketingSolutions_Audience_Read

Stop Ad Sets

Stop the specified list of ad sets

stop_ad_sets(data?) -> {data, errors, warnings}
Required scopes:
MarketingSolutions_Campaign_Manage

Estimate Audiences Sizes

Gets the size estimation of a non existent audience. An error is returned when size calculation is not supported.

estimate_audiences_sizes(data?) -> {data, errors, warnings}
Required scopes:
MarketingSolutions_Audience_Manage

Delete Creative

Delete a Creative if there are no ads binded to it

delete_creative(id)
Destructive
Required scopes:
MarketingSolutions_Creative_Manage

Update Contact List By Audience Segment

Add/remove identifiers to or from a contact list audience-segment.

update_contact_list_by_audience_segment(data) -> {data, errors, warnings}
Required scopes:
MarketingSolutions_Audience_Manage

Get Advertiser Ads

Get the list of self-services Ads for a given advertiser

get_advertiser_ads(advertiser-id, limit?, offset?) -> {data, errors, warnings}
Required scopes:
MarketingSolutions_Creative_Read

Get Advertiser Coupon Preview

Get the preview of a specific Coupon

get_advertiser_coupon_preview(advertiser-id, id, height?, width?) -> string
Required scopes:
MarketingSolutions_Creative_Read

Search Audiences

Returns a list of audiences that match the provided filters. If present, the filters are AND'ed together when applied.

search_audiences(data?, limit?, offset?) -> {data, errors, meta, warnings}
Required scopes:
MarketingSolutions_Audience_Read

Search Audience Segments

Returns a list of segments that match the provided filters. If present, the filters are AND'ed together when applied.

search_audience_segments(data?, limit?, offset?) -> {data, errors, meta, warnings}
Required scopes:
MarketingSolutions_Audience_Read

Update Audiences

Updates the properties of all audiences with a valid configuration, and returns their IDs. For those that cannot be updated, one or multiple errors are returned.

update_audiences(data?) -> {data, errors, warnings}
Required scopes:
MarketingSolutions_Audience_Manage

Create Ad Set

Create the specified ad set

create_ad_set(data?) -> {data, errors, warnings}
Required scopes:
MarketingSolutions_Campaign_Manage

Get Advertiser Creatives

Get the list of self-services Creatives for a given advertiser

get_advertiser_creatives(advertiser-id, limit?, offset?) -> {data, errors, warnings}
Required scopes:
MarketingSolutions_Creative_Read

Links

No external links available.

Authentication

  • Oauth2_authorization_code (Primary)