The identity and technical contract details declared by the specification.
PatchResultCampaignReadResource
object
read model data for resources
2 properties
BudgetAutomation
object
Budget automation, lets users configure budgets once at the campaign level while Criteo dynamically routes spend toward the best-performing ad sets. If "enable…
2 properties
CampaignV23Q1
objectnull
Campaign read model The {id} field is the campaign identifier (string-encoded integer).
7 properties
PatchCampaignScheduledSpendLimitCreation
object
Scheduled spend-limit creation. The startDate is an advertiser-local calendar date, for example 2026-09-01. When spendLimitType is "capped": spendLimitAmount a…
4 properties
2 required
PatchAdSetCategoryBidResultListResponse
object
Data model for a list of response resources
3 properties
ReadModelAdSetIdV26Q1
object
read model data for resources
3 properties
ReadAdSetAttributionConfigurationV26Q1
objectnull
Read model for an ad set's attribution configuration. The lookback window is only set for ad sets with an attribution method that is postClick or lastClick. It…
2 properties
ResponsesAdSetIdV26Q1
object
List of output resources
3 properties
RequestsPatchAdSetV26Q1
object
List of input resources
1 property
PatchCampaignScheduledSpendLimitUpdate
object
Scheduled spend-limit update. Updates are full replacements: id, startDate, spendLimitType, and the capped or uncapped spend-limit values must describe the com…
5 properties
3 required
PatchAdSetV26Q1
object
Model for patching an ad set.
7 properties
WriteModelAdSetId
object
write model data for resources
2 properties
CreateAdSetGeoLocationV26Q1
object
Geolocation configuration of the ad set
3 properties
AdvertiserInfoMessage
object
Data representing an advertiser. An advertiser is the top-level entity that owns campaigns, sellers, and budgets.
4 properties
CreateAdSetAttributionConfigurationV26Q1
object
Create model for an ad set's attribution configuration.
2 properties
CreateAdSetV26Q1Request
object
Data model for an input resources
1 property
CampaignBudgetAutomationV23Q1
objectnull
Budget automation, also known as automated budget or budget pacing, lets users configure KPIs and budgets once at the campaign level while Criteo dynamically r…
2 properties
PatchAdSetCategoryBid
object
Category Bid to update for a given combination of Ad Set and Category.
1 property
UpdateSellerBudgetMessageBase
object
Base data used to update a seller's budget
5 properties
ReadAdSetScheduleV26Q1
objectnull
Ad set schedule read model
4 properties
PatchMarketingCampaignBudgetAutomation
object
Budget automation, lets users configure budgets once at the campaign level while Criteo dynamically routes spend toward the best-performing ad sets. Only provi…
2 properties
AdSetIdV26Q1
objectnull
ad set id model
StatsReportMessage
object
A tabular stats report with column headers and data rows. Each row in 'data' is an array of values matching the order of 'columns'.
4 properties
ReadAdSetBiddingV26Q1
objectnull
Ad set bidding read configuration.
2 properties
AdSetTargetingV26Q1
objectnull
ad set targeting model
3 properties
PatchAdSetCategoryBidResultResource
object
Data model for a Resource
2 properties
AutomatedBudgetConfigurationV23Q1
objectnull
Detailed configuration used when campaign budget automation is enabled.
1 property
PatchAdSetDisplayMultiplierListRequest
object
Data model for a list of input resources
1 property
PatchAdSetScheduledBudgetUpdateV26Q1
object
A patch of an existing scheduled budget of the ad set, identified by its "id". Only provided fields are updated; omitted fields are left unchanged. Switching t…
8 properties
1 required
PatchAdSetCategoryBidListRequest
object
Data model for a list of input resources
1 property
AdSetAudienceLinkInputEntityV1
object
Input to set audience ad set link.
1 property
AdSetDisplayMultiplierResource
object
Data model for a Resource
3 properties
NillableDecimal
objectnull
structure that encapsulates an object that have valid business null values. If the structure is provided (i.e. not null), then the value in it, even null, is p…
1 property
CreateSellerBudgetMapiMessage
object
Data used to create a seller's budget
6 properties
PatchAdSetAttributionConfigurationV26Q1
object
Patch model for an ad set's attribution configuration.
2 properties
AdSetCategoryBidResource
object
Data model for a Resource
3 properties
AdSetAudienceLinkEntityV1
objectnull
Link Audience with an ad set
1 property
PatchCampaignSpendLimit
object
Spend limit configuration for a marketing campaign (patch). Only provided fields are updated; omitted fields are left unchanged. When spendLimitType is "capped…
3 properties
CampaignV23Q1Resource
objectnull
Data model for a Resource
3 properties
PatchCampaignScheduledSpendLimit
object
Scheduled spend-limit operations for a marketing campaign (patch). Create, update, and delete operations are applied together by the backend.
3 properties
ReadAdSetScheduledBudgetV26Q1
object
A budget configuration scheduled to replace the ad set's active budget on the specified "startDate". It contains the same fields as the active budget, plus the…
8 properties
PatchAdSetDisplayMultiplierResultResource
object
Data model for a Resource
2 properties
PatchAdSetScheduledBudgetV26Q1
object
Scheduled budget patch model for an ad set. Groups the operations (Create, Update, Delete) on the ad set's scheduled budget.
3 properties
PatchCampaignListRequest
object
List of input resources
1 property
AdSetAudienceLinkEntityV1Resource
objectnull
A class that represents a domain entity exposed by an API
3 properties
CampaignScheduledSpendLimitV23Q1
object
A campaign spend limit scheduled to become active on the specified "startDate".
5 properties
ReadModelAdSetId
object
read model data for resources
2 properties
ResponseReadAdSetV26Q1
object
output resource
3 properties
PatchResultCampaignListResponse
object
List of output resources
3 properties
ReadAdSetV26Q1
objectnull
Ad set read model. The ad set is the configuration unit that defines ads delivery. Its binds together the objective, budget, scheduling, targeting options and…
14 properties
CreateAdSetBiddingV26Q1
object
ad set bidding create model
2 properties
1 required
PatchAdSetCategoryBidResource
object
Data model for a Resource
3 properties
PatchCampaignWriteResource
object
write model data for resources
3 properties
CreateAdSetTargetingV26Q1
object
Targeting configuration of the ad set
3 properties
1 required
CampaignV23Q1Response
object
Data model for response resource
3 properties
RequestsAdSetId
object
List of input resources
1 property
AdvertiserQuotaMessage
object
Data representing an advertiser's quota
5 properties
CampaignV23Q1ListResponse
object
Data model for a list of response resources
3 properties
WriteModelPatchAdSetV26Q1
object
write model data for resources
3 properties
PatchAdSetDisplayMultiplierResource
object
Data model for a Resource
3 properties
ReadModelReadAdSetV26Q1
objectnull
read model data for resources
3 properties
AdSetDisplayMultiplierListResponse
object
Data model for a list of response resources
3 properties
PatchAdSetDisplayMultiplier
object
Display Multiplier to update for a given combination of Ad Set and Category.
1 property
PatchCampaignScheduledSpendLimitDeletion
object
Scheduled spend-limit deletion.
1 property
1 required
CreateAdSetBudgetV26Q1
object
Budget create model for an ad set. For "capped": budgetAmount (required, non-null), budgetRenewal (required, not "undefined"), and budgetDeliverySmoothing (req…
6 properties
1 required
AdSetDeliveryStatus
string
Status of an ad set's delivery
NillableAdSetTargetingRuleV26Q1
objectnull
structure that encapsulates an object that have valid business null values. If the structure is provided (i.e. not null), then the value in it, even null, is p…
1 property
ResponsesReadAdSetV26Q1
object
List of output resources
3 properties
AdSetSearchRequestMetadataV26Q1
object
Optional metadata for searching ad sets
1 property
CampaignSearchRequestV23Q1
object
Request payload for the campaign search endpoint.
1 property
AdvertiserCampaignMessage
object
Data representing a campaign for an advertiser. A campaign groups seller-campaigns and defines delivery settings.
4 properties
AdSetCategoryBidListResponse
object
Data model for a list of response resources
3 properties
AdSetSearchRequestV26Q1
object
request payload of the search endpoint
2 properties
SellerCampaignProductSet
objectnull
Product set targeting configuration for a seller-campaign
3 properties
SellerCampaignUpdate
object
Data used to update a Seller-Campaign's Bid.
2 properties
PatchAdSetScheduledBudgetCreationV26Q1
object
A budget configuration to schedule on the ad set, becoming active on the specified "startDate". It contains the same fields as an active-budget patch, plus the…
7 properties
1 required
CreateCampaignSpendLimit
object
Spend limit configuration for a marketing campaign. Controls how much can be spent and the renewal cadence. When spendLimitType is "capped": spendLimitAmount a…
3 properties
1 required
SellerBudgetStatusV2
string
Status of a seller budget
CreateAdSetV26Q1Resource
object
Data model for a Resource
2 properties
CommonProblem
object
Common problem object.
9 properties
ResponsesAdSetId
object
List of output resources
3 properties
CreateCampaignRequest
object
Data model for an input resources
1 property
PatchAdSetDisplayMultiplierResultListResponse
object
Data model for a list of response resources
3 properties
AdvertiserAdsetMessage
object
Data representing an advertiser's adset
6 properties
SellerBase
object
The seller represents the merchant selling products on the advertiser's marketplace platform.
2 properties
CreateSellerCampaignMessageMapi
object
Data used to create a seller's campaign
2 properties
CampaignSpendLimitV23Q1
objectnull
Campaign spend-limit configuration. A capped spend limit restricts campaign spending per renewal period. An uncapped spend limit does not impose a spending cei…
3 properties
NillableDateTime
objectnull
structure that encapsulates an object that have valid business null values. If the structure is provided (i.e. not null), then the value in it, even null, is p…
1 property
AdSetDeliveryLimitationsV26Q1
objectnull
Delivery limitations for an ad set.
3 properties
AdSetCategoryBid
objectnull
Category Bid information about a Category for a given Ad Set.
2 properties
CreateAdSetV26Q1
object
ad set create model
11 properties
9 required
BudgetAutomationConfiguration
objectnull
Configuration for budget automation. Only meaningful when "enabled" is true. When "enabled" is false or omitted, this field is ignored.
1 property
PatchAdSetBiddingV26Q1
object
Ad set bidding patch model
1 property
PatchAdSetBudgetV26Q1
object
Budget patch model for an ad set. Only provided fields are updated; omitted fields are left unchanged. Switching to "uncapped": set budgetStrategy to "uncapped…
6 properties
AdSetFrequencyCappingV26Q1
objectnull
Ad set frequency capping. Settings that can limit the number of impression by viewer and by period.
2 properties
CreateCampaign
object
Campaign create model.
5 properties
4 required
CreateAdSetScheduleV26Q1
object
ad set schedule create model
2 properties
1 required
PatchCampaign
object
Campaign patch model. The campaign identifier is provided in the resource {id} field (string-encoded integer) and is required.
3 properties
AdSetTargetingRuleV26Q1
object
ad set targeting rule model
2 properties
CampaignSearchFiltersV23Q1
object
Filters for searching campaigns. Multiple filters are combined with an implicit AND operation. Identifiers are string-encoded integers; invalid values are igno…
2 properties
UpdateSellerBudgetMessage
object
Data used to update a seller's budget
6 properties
PatchAdSetScheduledBudgetDeletionV26Q1
object
Deletion of an existing scheduled budget of the ad set, identified by its "id".
1 property
1 required
AdSetGeoLocationV26Q1
objectnull
Ad set geolocation options.
3 properties
SellerBudgetMessage
object
A budget defines spending constraints for a seller across one or more campaigns. Each seller can have one active budget per time period.
10 properties
PatchAdSetSchedulingV26Q1
object
Model for patching ad set scheduling.
2 properties
SellerCampaignMessage
object
A seller-campaign links a seller to a campaign, defining the CPC bid. A seller can participate in multiple campaigns, and a campaign can have multiple sellers.
7 properties
AdSetAudienceLinkEntityV1Response
object
A top-level object that encapsulates a Criteo API response for a single entity
3 properties
AdSetDisplayMultiplier
objectnull
Display Multiplier information about a Category for a given Ad Set.
2 properties
AdSetSearchFilterV26Q1
object
Filter on ad set ids. Multiple filters are combined with an implicit AND operation. Identifiers are string-encoded integers; invalid values are ignored. If no…
3 properties
CreateCampaignResource
object
Data model for a Resource
2 properties
SellerCampaignSuspensionReason
string
Reason why a seller-campaign is suspended. Values: ManuallyStopped (manually paused by the partner), NoBudgetDefined (no valid budget linked), NoCpcDefined (no…
ReadAdSetBudgetV26Q1
objectnull
Budget configuration for an ad set. Controls how much can be spent and how spending is paced. When budgetStrategy is "capped": budgetAmount, budgetRenewal, and…
6 properties
SetBidsModelResource
object
Resource object containing keywords and their associated bid overrides
3 properties
CommonWarning
object
A JSON:API Base common warning
8 properties
PreferredLineItemV2Response
object
A top-level object that encapsulates a Criteo API response for a single entity
3 properties
ValueResourceInputOfBrandCatalogRequestV2
object
A top-level object that encapsulates a Criteo API request for a single value object.
1 property
ValueResourceInputRecommendedCategoriesRequestV1
object
A top-level object that encapsulates a Criteo API request for a single value objects.
1 property
ResourceOfCategory202204
object
A class that represents a domain entity exposed by an API.
3 properties
AddToBasketTarget202110
object
Identifies add to basket targeting for a line item
3 properties
1 required
Creative202210
objectnull
A creative entity
13 properties
9 required
SellerIdentifierV2
object
Identifies a Unique Seller
2 properties
2 required
ResourceOfCreative2
objectnull
A class that represents a domain entity exposed by an API.
3 properties
TemplateVariableValue
object
A value for a variable in a creative template.
7 properties
1 required
LineItemBidMultipliersV2
objectnull
The Bid Multiplier Entity of a LineItem
12 properties
ValueTypeResourceOfStoreIdsUpdateModel202110
object
Data model for a value type resource
2 properties
VideoVariableValue
objectnull
A value of a template video variable
4 properties
4 required
ValueResourceOfRetailerSearchRequestV2
object
A value resource exposed by the API.
2 properties
EntityResourceCollectionOutcomeCategory202204
object
A top-level object that encapsulates a Criteo API response for several entities.
3 properties
CampaignBudgetOverrides
objectnull
Campaign budget overrides including Monthly and Daily budget overrides.
2 properties
2 required
BrandCatalogRequestV2
object
A request for a catalog under the specified format.
4 properties
ReviewStateModel
string
The state of a keyword in the context of a line item.
RetailMediaKeywordsReviewResult
objectnull
Response object for approval of keyword reviews, containing a list of Phrase-ReviewState pairs
1 property
1 required
AudienceIdsUpdateModel202110Request
object
Data model for a value type input resource
1 property
AudienceTarget202110Request
object
Data model for a value type input resource
1 property
CpcMinBidsResponse
objectnull
Cpc Min Bids response object.
2 properties
2 required
InputResourceOfPreferredLineItemCreateModelV2
object
Data model for a Resource
2 properties
LineItemBudgetOverrides
objectnull
Line item budget overrides including Monthly and Daily budget overrides.
2 properties
2 required
ValueResourceRetailMediaKeywordsReview
object
A value resource exposed by the API.
2 properties
ResourceOfPreferredLineItemUpdateModelV2
object
A class that represents a domain entity exposed by an API
3 properties
JsonApiSingleResponseOfCatalogStatus
object
A JSON:API wrapper class to add one JSON:API within a data property
3 properties
1 required
LineItemBidMultipliersV2Response
objectnull
A top-level object that encapsulates a Criteo API response for a single entity
3 properties
RmcaCommonProblem
object
Common problem object.
9 properties
EntityResourceCollectionOutcomeOfRetailerResultV2AndMetadata
object
A top-level object that encapsulates a Criteo API response for several entities and metadata.
4 properties
Template
objectnull
A template for creating creatives.
12 properties
8 required
ValueResourceRecommendedCategoriesRequestV1
object
A value resource exposed by the API.
2 properties
JsonApiBodyWithoutIdOfCampaignAttributesV202301AndCampaignV202301
object
A JSON:API wrapper class to format a with Type, and Attributes properties
2 properties
1 required
JsonApiBodyWithLineItemBidMultipliersV2
object
A JSON:API wrapper class to format a with Id, Type, and Attributes properties
2 properties
1 required
EntityResourceCategory202204
object
A domain entity exposed by the API, identified by a unique id.
3 properties
ValueResourceInputCategoriesSearchRequestV1
object
A top-level object that encapsulates a Criteo API request for a single value objects.
1 property
Creative2ListResponse
object
A top-level object that encapsulates a Criteo API response for several entities.
3 properties
CampaignAttributesV202301
object
An object that represents the available options to set when creating a Retail Media Campaign
16 properties
2 required
ValueResourceOutcomeRecommendedKeywordsResponseV1
object
A top-level object that encapsulates a Criteo API response for a single value object.
3 properties
CommonLineItemPagedListResponse
object
Data model for a paged list of response resources
4 properties
RetailerPages202110
object
Wraps a list of valid pages for a retailer
1 property
1 required
StoreTarget202110Response
object
Data model for a value type resource outcome
3 properties
CategoriesSearchRequestV1
object
An object that represents the request of CategoriesSearch endpoint.
2 properties
StoreIdsUpdateModel202110
object
Update model for updating store target ids
1 property
1 required
PromotedProduct
objectnull
A promoted product.
3 properties
ExternalCatalogStatus
objectnull
The status of an asynchronous request to generate a catalog
7 properties
7 required
ValueResourceOfRecommendedKeywordsResult
objectnull
A value resource exposed by the API.
2 properties
CreativeUpdateModel202207
object
Update model of a creative
6 properties
4 required
TemplateResponse
object
A top-level object that encapsulates a Criteo API response for a single entity.
3 properties
ValueTypeResourceOfAddToBasketIdsUpdateModel202110
object
Data model for a value type resource
2 properties
CampaignV202301
object
A Retail Media Campaign used to represent an advertiser's marketing objective
23 properties
5 required
ValueResourceOfBrandCatalogRequestV2
object
A value resource exposed by the API.
2 properties
PreferredLineItemUpdateModelV2Request
object
A top-level object that encapsulates a Criteo API request for a single entity
1 property
Category202204ListResponse
object
A top-level object that encapsulates a Criteo API response for several entities.
3 properties
EditableCampaignAttributesV202301
object
An object that represents the available options to set when editing a Retail Media Campaign
13 properties
4 required
PostCampaignV202301
object
An object that represents the available options to set when creating a Retail Media Campaign
1 property
ResourceOfLineItemBidMultipliersV2
objectnull
A class that represents a domain entity exposed by an API
3 properties
ChoiceVariableValue
objectnull
A value of a template choice variable (among different accepted options)
1 property
1 required
BalanceCampaignsV1
objectnull
Balance campaigns mapping object.
1 property
1 required
JsonApiPageResponseOfBrand
object
A wrapper class to return a single page of with metadata
4 properties
2 required
ValueResourceDeleteCampaignsRequestV1
object
A value resource exposed by the API.
2 properties
EntityResourceOfSponsoredProductsLineItem
objectnull
A domain entity exposed by the API, identified by a unique id.
3 properties
JsonApiRequestOfSellerCatalogRequest
object
A JSON:API wrapper class to format a with Type, and Attributes properties
1 property
CreativeCreateModel202207
object
Create model of a creative
6 properties
4 required
ValueTypeResourceOfAudienceIdsUpdateModel202110
object
Data model for a value type resource
2 properties
TemplateVariable
object
A variable in a creative template
6 properties
3 required
ValueResourceInputOfCampaignBudgetOverrides
object
A top-level object that encapsulates a Criteo API request for a single value object.
1 property
CampaignAvailabilityV2
object
Information about the budget model availability for a specific campaign type and buy type combination, and page types and environments supported for that combi…
4 properties
ValueResourceInputOfSponsoredProductsLineItemCreateRequestModel
object
A top-level object that encapsulates a Criteo API request for a single value object.
1 property
JsonApiRequestOfCatalogRequest
object
A JSON:API wrapper class to format a with Type, and Attributes properties
1 property
JsonApiBodyWithoutIdOfCatalogRequestAndCatalogRequest
object
A JSON:API wrapper class to format a with Type, and Attributes properties
2 properties
1 required
PromotedProductResourceCollectionInput
object
Request object containing promoted products to be appended, deleted, paused or unpaused.
1 property
ValueResourceInputRecommendedKeywordsRequestV1
object
A top-level object that encapsulates a Criteo API request for a single value objects.
1 property
EntityResourceCollectionOutcomeCategory202204Metadata
object
A top-level object that encapsulates a Criteo API response for several entities and metadata.
4 properties
CommonLineItemResponse
object
A top-level object that encapsulates a Criteo API response for a single entity
3 properties
ResourceOfCreative202210
objectnull
A class that represents a domain entity exposed by an API.
3 properties
JsonApiBodyWithExternalIdOfEditableCampaignAttributesV202301AndCampaignV202301
object
A JSON:API wrapper class to format a with Id, Type, and Attributes properties
3 properties
2 required
RetailerSearchRequestV2
object
Request model for searching retailers
1 property
ExternalBrand
objectnull
A Retail Media Brand used to represent a collection of products sold under the same umbrella name
1 property
1 required
EntityResourceOutcomeOfSponsoredProductsLineItem
object
A top-level object that encapsulates a Criteo API response for a single entity.
3 properties
SellerCatalogRequestV2
object
Used to request a catalog of seller SKUs
3 properties
ValueResourceCpcMinBidsResponse
objectnull
A value resource exposed by the API.
2 properties
ValueTypeResourceOfStoreTarget202110
object
Data model for a value type resource
2 properties
ValueResourceInputDeleteCampaignsRequestV1
object
A top-level object that encapsulates a Criteo API request for a single value object.
1 property
ProductResourceOutcome
object
Outcome object containing errors and warnings.
2 properties
JsonApiBodyWithoutIdOfSellerCatalogRequestAndSellerCatalogRequest
object
A JSON:API wrapper class to format a with Type, and Attributes properties
2 properties
1 required
ChoiceVariableSpecification
objectnull
Specification of choice variable
3 properties
1 required
CommonLineItem
object
A common line item to hold line item information shared between preferred and auction line items
13 properties
5 required
ValueResourceInputRetailMediaKeywordsReview
object
A top-level object that encapsulates a Criteo API request for a single value object.
1 property
FlightLeg
object
A leg of a flight schedule outlining which days and times the line item will run.
3 properties
3 required
SellerCatalogRequest
object
Used to request a catalog of seller SKUs
1 property
1 required
ReviewSetState
object
A Phrase-ReviewState pair describing an update to a keyword review
2 properties
2 required
SponsoredProductsLineItemCreateRequestModel
object
Model to create a retail media auction line item
14 properties
3 required
AddRemoveKeywordsModel
object
Data model containing keywords to be added or removed from a line item
1 property
SdkApiRestCommonProblem
object
Common problem object.
8 properties
ResourceOutcome
object
Outcome object containing errors and warnings.
2 properties
DeleteCampaignsRequestV1
object
Request object for deleting campaigns from balance campaigns mapping.
1 property
1 required
AudienceTarget202110
object
Identifies audience targeting for a line item
2 properties
2 required
KeywordsModel
objectnull
The keywords associated with a line item.
2 properties
AddToBasketTarget202110Response
object
Data model for a value type resource outcome
3 properties
CpcMinBidsRequest
object
Cpc Min Bids request object.
1 property
1 required
ValueTypeResourceOfAudienceTarget202110
object
Data model for a value type resource
2 properties
KeywordsModelResponse
object
Response object containing keywords associated with a line item.
3 properties
SetBidsModelRequest
object
Request object to set bid overrides for keywords associated with a line item
1 property
PutCampaignV202301
object
An object that represents the available options to set when editing a Retail Media Campaign
1 property
PreferredLineItemCreateModelV2
object
Model used to create a preferred line item
10 properties
7 required
InputKeywordsModel
object
The keywords to be added or removed from a line item.
3 properties
EntityResourceOfRetailerResultV2
object
A domain entity exposed by the API, identified by a unique id.
3 properties
StoreTarget202110
object
Identifies store targeting for a line item
2 properties
2 required
LineItemPageCategoryV2
object
Category information for a preferred line item page
2 properties
1 required
ResourceOfCreative202110
object
A class that represents a domain entity exposed by an API.
3 properties
ValueResourceInputOfLineItemBudgetOverrides
object
A top-level object that encapsulates a Criteo API request for a single value object.
1 property
CatalogStatusV2
objectnull
The status of an asynchronous request to generate a catalog
6 properties
2 required
CampaignDailyBudgetOverride
object
Campaign daily budget override.
4 properties
2 required
ValueResourceInputOfSellerCatalogRequestV2
object
A top-level object that encapsulates a Criteo API request for a single value object.
1 property
LineItemCappingV2
objectnull
Frequency Capping for a Preferred Line Item
2 properties
2 required
PreferredLineItemV2PagedListResponse
object
Data model for a paged list of response resources
4 properties
SponsoredProductsLineItemUpdateRequestModel
object
A request to update a Sponsored Products Line Item.
13 properties
4 required
RetailerResultV2
objectnull
The result of a query for the configuration of a retailer
2 properties
Creative2
objectnull
A creative entity
13 properties
9 required
DailyLineItemBudgetOverride
object
The details for a daily budget override
4 properties
1 required
ValueResourceOutcomeOfRecommendedKeywordsResult
object
A top-level object that encapsulates a Criteo API response for a single value object.
3 properties
ResourceOfPreferredLineItemV2
objectnull
A class that represents a domain entity exposed by an API
3 properties
TextVariableValue
objectnull
A value of a template text variable
1 property
1 required
HyperlinkVariableValue
objectnull
A value of a template hyperlink variable
1 property
1 required
ValueResourceRetailMediaKeywordsReviewResult
objectnull
A value resource exposed by the API.
2 properties
RetailMediaKeywordsReview
object
Request object for approval of keyword reviews, containing a list of Phrase-ReviewState pairs
1 property
1 required
AssetResource
objectnull
A class that represents a domain entity exposed by an API
3 properties
ValueResourceInputCpcMinBidsRequest
object
A top-level object that encapsulates a Criteo API request for a single value objects.
1 property
ResourceOfCommonLineItem
object
A class that represents a domain entity exposed by an API
3 properties
LineItemPageV2
objectnull
Page information for a preferred line item
3 properties
1 required
ValueResourceOfLineItemBudgetOverrides
objectnull
A value resource exposed by the API.
2 properties
SponsoredProductsLineItem
objectnull
Model of a retail media auction line item.
20 properties
7 required
CommonError
object
A JSON:API Common error structure
8 properties
PromotedProductResourceCollectionOutcome
object
Outcome object containing promoted products.
4 properties
LineItemBidMultipliersV2Request
objectnull
A top-level object that encapsulates a Criteo API request for a single entity
1 property
JsonApiPageResponseOfCampaignV202301
object
A wrapper class to return a single page of with metadata
4 properties
2 required
RecommendedKeywordsResult
objectnull
Response model for recommended keywords
2 properties
ValueResourceInputOfSponsoredProductsLineItemUpdateRequestModel
object
A top-level object that encapsulates a Criteo API request for a single value object.
1 property
ValueResourceRecommendedKeywordsResponseV1
objectnull
A value resource exposed by the API.
2 properties
ChoiceOption
object
An option given in a choice
2 properties
2 required
ValueTypeResourceOfAddToBasketTarget202110
object
Data model for a value type resource
2 properties
Keywords
object
Data associated with a normalized keyword phrase
6 properties
ProductMetadata
objectnull
Metadata about the response. Used for pagination.
4 properties
EntityResourceCollectionOutcomeOfSponsoredProductsLineItemAndMetadata
object
A top-level object that encapsulates a Criteo API response for several entities and metadata.
4 properties
ValueResourceAppendCampaignsRequestV1
object
A value resource exposed by the API.
2 properties
InputKeywords
object
Keywords submitted by the user binned by type after some cleanup has been performed
3 properties
ValueResourceOutcomeBalanceCampaignsV1
object
A top-level object that encapsulates a Criteo API response for a single value object.
3 properties
ValueResourceOutcomeOfLineItemBudgetOverrides
object
A top-level object that encapsulates a Criteo API response for a single value object.
3 properties
AddRemoveKeywordModel
object
A single keyword to be added or removed
3 properties
FlightSchedule
objectnull
A flight schedule for a line item.
1 property
AssetResponse
object
A top-level object that encapsulates a Criteo API response for a single entity
3 properties
PageTypeCombinationV2
object
Represents a combination of page type and page environment type for a specific campaign-buy type.
2 properties
JsonApiBodyWithIdOfInt64AndBrandAndBrand
object
A JSON:API wrapper class to format a with external Id, Type, and Attributes properties
3 properties
2 required
ValueResourceOfSponsoredProductsLineItemUpdateRequestModel
object
A value resource exposed by the API.
2 properties
AddToBasketIdsUpdateModel202110Request
object
Data model for a value type input resource
1 property
ValueResourceOutcomeCpcMinBidsResponse
object
A top-level object that encapsulates a Criteo API response for a single value object.
3 properties
Asset
objectnull
Handles pointing towards binary content that advertisers can use later on, for example in their creatives.
2 properties
1 required
StoreTarget202110Request
object
Data model for a value type input resource
1 property
ValueResourceCategoriesSearchRequestV1
object
A value resource exposed by the API.
2 properties
AddToBasketIdsUpdateModel202110
object
Update model for updating add to basket target ids
2 properties
ResourceOfTemplate
objectnull
A class that represents a domain entity exposed by an API.
3 properties
RecommendedKeywordsResponseV1
objectnull
Response model of Recommended Keywords
1 property
1 required
AudienceIdsUpdateModel202110
object
Update model for updating audience target ids
1 property
1 required
ValueResourceRecommendedKeywordsRequestV1
object
A value resource exposed by the API.
2 properties
ValueResourceInputOfRetailerSearchRequestV2
object
A top-level object that encapsulates a Criteo API request for a single value object.
1 property
EntityResourceOutcomeOfCatalogStatusV2
object
A top-level object that encapsulates a Criteo API response for a single entity.
3 properties
ExternalCatalogRequest
object
A request for a catalog under the specified format. Currently "json-newline" is supported.
2 properties
AppendCampaignsRequestV1
object
Request object for appending campaigns to balance campaigns mapping.
1 property
1 required
JsonApiSingleResponseOfCampaignV202301
object
A JSON:API wrapper class to add one JSON:API within a data property
3 properties
1 required
ValueResourceInputAppendCampaignsRequestV1
object
A top-level object that encapsulates a Criteo API request for a single value object.
1 property
AddRemoveKeywordsModelRequest
object
Request object to add or remove keywords from a line item
1 property
SellerIdentifier
object
Identifies a Unique Seller
2 properties
2 required
AddToBasketTarget202110Request
object
Data model for a value type input resource
1 property
JsonApiSingleResponseOfLineItemBidMultipliersV2
object
A JSON:API wrapper class to add one JSON:API within a data property
3 properties
1 required
PageMetadata
object
Metadata related to the current request
6 properties
2 required
RecommendedCategoriesRequestV1
object
An object that represents the request of RecommendCategories endpoint.
1 property
1 required
AudienceTarget202110Response
object
Data model for a value type resource outcome
3 properties
Creative202110ListResponse
object
A top-level object that encapsulates a Criteo API response for several entities.
3 properties
Creative202210Response
object
A top-level object that encapsulates a Criteo API response for a single entity.
3 properties
EntityResourceCollectionOutcomeLineItemKeywordReviewReportAndMetadata
object
A top-level object that encapsulates a Criteo API response for several entities and metadata.
4 properties
PreferredLineItemV2
object
A Retail Media Preferred Line Item used to hold bid settings for one or many promoted products on a single retailer
16 properties
6 required
PageTypeEnvironment202210
object
The PageType-Environment Tuples for creatives
2 properties
StoreIdsUpdateModel202110Request
object
Data model for a value type input resource
1 property
ValueResourceOfSponsoredProductsLineItemCreateRequestModel
object
A value resource exposed by the API.
2 properties
AddRemoveKeywordsModelResource
object
Resource object containing keywords to be added or removed from a line item
3 properties
ValueResourceBalanceCampaignsV1
objectnull
A value resource exposed by the API.
2 properties
LineItemKeywordReviewReport
objectnull
Reports on a line item which contains one or more actionable keyword reviews
9 properties
9 required
MonthlyLineItemBudegetOverride
object
The details for a monthly budget override
4 properties
2 required
SetBidModel
object
A single keyword and associated bid override
2 properties
EntityResourceLineItemKeywordReviewReport
object
A domain entity exposed by the API, identified by a unique id.
3 properties
ValueResourceOfCampaignBudgetOverrides
objectnull
A value resource exposed by the API.
2 properties
EntityResourceOfCatalogStatusV2
objectnull
A domain entity exposed by the API, identified by a unique id.
3 properties
CampaignMonthlyBudgetOverride
object
Campaign monthly budget override.
4 properties
2 required
MatchTypeModel
string
The match type of a keyword.
JsonApiBodyWithIdOfInt64AndCatalogStatusAndCatalogStatus
object
A JSON:API wrapper class to format a with external Id, Type, and Attributes properties
3 properties
2 required
ValueResourceOfSellerCatalogRequestV2
object
A value resource exposed by the API.
2 properties
TextVariableSpecification
objectnull
Specification of a text variable
1 property
KeywordsModelResource
objectnull
Resource object containing keywords associated with a line item.
3 properties
FilesVariableValue
objectnull
A value of a template file variable (one or several files), like images in a creative
1 property
1 required
Metadata
objectnull
Metadata related to the current request.
3 properties
2 required
ValueResourceOutcomeOfCampaignBudgetOverrides
object
A top-level object that encapsulates a Criteo API response for a single value object.
3 properties
PreferredLineItemCreateModelV2Request
object
Data model for a create input resource
1 property
PageTypeEnvironment2
object
The PageType-Environment Tuples for creatives
2 properties
Creative2Response
object
A top-level object that encapsulates a Criteo API response for a single entity.
3 properties
ValueResourceCpcMinBidsRequest
object
A value resource exposed by the API.
2 properties
FilesVariablesSpecification
objectnull
Specification of a file variable
4 properties
1 required
ColorVariableValue
objectnull
A value of a template color variable
1 property
1 required
LineItemProductStatus
stringnull
The status of a promoted product in the context of the line item.
Section
object
Section object that hold template variables
3 properties
1 required
KeywordDataModel
object
A single keyword and associated bid override.
6 properties
ValueResourceOutcomeRetailMediaKeywordsReviewResult
object
A top-level object that encapsulates a Criteo API response for a single value object.
3 properties
PreferredLineItemUpdateModelV2
object
Model used to update a preferred line item
9 properties
4 required
JsonApiBodyWithIdOfInt64AndCampaignV202301AndCampaignV202301
object
A JSON:API wrapper class to format a with Id, Type, and Attributes properties
3 properties
2 required
Category202204
objectnull
List of retailer's categories, including the full hierarchy of categories and their parent category ID
3 properties
3 required
RecommendedKeywordsRequestV1
object
Request model of RecommendedKeywords
1 property
1 required
SetBidsModel
object
Data model containing keywords and their associated bid overrides
1 property
SkuMinBid
object
An object represents the minimum bid amount value of a sku.
2 properties
2 required
Creative202110
objectnull
Metadata and usage info of a preferred deals creative
7 properties
3 required
TemplateListResponse
object
A top-level object that encapsulates a Criteo API response for several entities.
3 properties
PromotedProductResource
object
Resource object containing a promoted product.
3 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Criteo publishes across the network.