Dataset parameters
Introduction
You will find on this page a comprehensive list of fields that can be sent in your product dataset.
Recommended fields are not mandatory, but will streamline your campaign management, help improve performance, and/or enhance your shoppers’ experience.
Product Importer API
If you are working with a big dataset, we strongly recommend that you use the Product Importer API, mainly for performance reasons. The Product Importer API has an ingestion time of a few minutes, versus a few hours with traditionnal catalog uploads.
The Product Importer API accepts all the parameters listed on this page.
Parameters statuses for Onsite VS Offsite
You will find in the table below the list of feed parameters by name, description, and statuses (required, recommended, or N/A) depending on if you are building a feed for Retail Media Offsiteor Onsite, or both.
- The Required parameters will prevent product ingestion if they are left blank or not included.
- The Recommended parameters will significantly improve performance if present.
- The N/A mention means the parameter is Non Applicable for this solution.
We provide more details for each parameters in the section below.
Parameter name | Definition | Retail Media Offsite | Retail Media Onsite |
---|---|---|---|
id | The ID is a unique product identifier that represents only one product. If multiple products are multiple variants of the same product, each variant should have a unique ID. | Required | Required |
title | The product's name or title. | Required | Required |
link | Link to the SKU's product detail page | Required | Required |
image_link | Link to an image of the SKU | Required | Required |
brand | Brand of the product | Recommended | Required Blank values in this field will prevent the SKU from being added to campaigns. |
product_type | A hierarchical list of categories that represent where the SKU can be found on your website. | Required | Required Must match client architecture website to display relevant ads depending where you are |
product_type_key | The corresponding category IDs for the categories passed in the product_type field above. These category IDs should match those shown on the site. | Required | Required in the output. RM TS does not explicitly request this field from retailers. Rather, it is made up from the value(s) in product_type . |
price | The current sale price of the SKU | Recommended | Required |
availability | Indicates the availability of the product | Recommended | Required preorder; out of stock; in stock |
google_product_category | Google product taxonomy of the SKU, this is important as we use these categories to attribute correctly in the post-click post-view lookback windows. Incorrect categories could lead to incorrect attribution. | Recommended | Required Not using category1/2/3 |
description | The description is a short piece of text that provides additional information about a product beyond its name. | Recommended | Recommended Used for the machine learning (like keyword matching after a search on retailer page). |
filters | This feature allows Criteo to return relevant products on filtered pages. | Recommended | Recommended if ads serving on a page with filtering capabilities |
gtin | A unique identifier for products within the global marketplace. Used to search for and add products to campaigns. | Recommended | Recommended for use in campaign setup and reporting |
item_group_id | The 'parent' SKU ID. For example, if an apparel retailer has several child variants in the feed (one for each size and color) each variant should include the same item_group_id value. | Recommended (if applicable) | Recommended To be able not to display variants of the product in the same ads. |
mpn | A number that uniquely identifies the product to its manufacturer. | Recommended | Recommended |
number_of_reviews | Number of reviews for the SKU | N/A | Recommended |
product_rating | Rating of the SKU | Recommended | Recommended |
seller_name & seller_id | Name of the seller on the marketplace, ID of the seller on the marketplace | Recommended | Required if client is using private market and reselling a product for several sellers (the user needs to set " isMarketplace " field to true ). |
regiondata | The store IDs where the product is available and its local prices. | N/A | Required only if availability is store-based. |
sale_price | This parameter is required if you want the ad to show the discounted price. If a product is "on sale", this field should reflect the higher price | Recommended | N/A |
size | Use the size parameter to describe the standardized size of your product. | Recommended | Recommended |
expiration_date | Date when the product listing will expire. | Recommended | Recommended |
Required parameters
id
id
Definition
The ID is a unique product identifier that represents only one product. If multiple products are multiple variants of the same product, each variant should have a unique ID.
Example
25c48
Specifications
- Must be unique and consistent; changes to product IDs will break attribution and reporting.
- Cannot match
item_group_id
. - Must match with the data shared in OneTag/API calls.
- Maximum of 50 characters.
- Quotation marks, non-ASCII characters, and the hyphen symbol (-) are not supported.
- Will default to lowercase in our ad response if using alphanumeric IDs.
title
title
Definition
The product's name or title.
Example
Red Men's T-Shirt Size L
Specifications
- Maximum of 500 characters.
- If multiple titles are possible, please choose the longer of the two.
link
link
Definition
Link to the SKU's product detail page
Example
https://www.example.com/ProductA
Specifications
- Maximum of 2000 characters, including CAT prefix + encoded URL.
- Specify protocol (http or https).
- Ideally, no tracking code.
image_link
image_link
Definition
Link to an image of the SKU
Example
https://www.example.com/image.png
Specifications
- Maximum of 2000 characters.
- Recommended: minimum 800x800 pixels and weight under 16MB.
- Supported formats: PNG, JPEG, or GIF.
brand
brand
Definition
Brand of the product
Example
Adidas
Specifications
- Must be consistently set across products; changes to brand values will break campaign attribution and reporting.
- Maximum of 70 characters.
- Must start with either a letter or number.
- Recommended: only ASCII characters.
- Non-ASCII version of the brand can be added as an extra parameter.
product_type
product_type
Definition
A hierarchical list of categories that represent where the SKU can be found on your website.
Example
- CSV:
'Computing>Keyboards and Mice>Mice','Hardware>Input Device'
- XML:
'Computing>Keyboards and Mice>Mice','Hardware>Input Device'
Specifications
- Maximum of 10240 characters. The maximum length of an individual category node is 750 characters.
- Only ASCII characters.
- Must start with a letter or number.
- Individual levels of a path must be separated by
>
or>
in the XML file. - Multiple categories should be comma-separated.
- Case sensitive. Ensure that you use proper casing to reflect what is shown on site
- Each path should be wrapped in single quotes (
'
). - Must match client website architecture.
- If multiple categories are passed:
- The first one must be the most relevant (main category for PDP recommendations).
- Submit up to 10 categories.
product_type_key
product_type_key
Definition
The corresponding category IDs for the categories passed in the product_type
field above. These category IDs should match those shown on the site.
Example
- CSV:
'123>4567>89012','456>7890'
- XML:
'123>4567>89012','456>7890'
Specifications
- Same specifications as
product_type
. - Ensure that the structure and hierarchy of the
product_type
categories are mirrored exactly by theproduct_type_key
. If they don't, it will prevent the SKU from serving anywhere on site. - Individual levels of a path must be separated by
>
or>
in the XML file. - If multiple categories are passed, the first one must be the most relevant (main category for PDP recommendations).
- Must match exactly with the
category
parameter passed in the ad request
price
price
Definition
The current sale price of the SKU
Example
24.99
Specifications
- Maximum of 14 characters.
- Decimal separator must be a period (.) with no thousands separator.
- If there are sales/discounts/promotions, the price parameter should contain the lowest price.
availability
availability
Definition
Indicates the availability of the product
Example
In Stock
Specifications
- Must be either "In stock", "Out of stock", or "Preorder".
google_product_category
google_product_category
Definition
Google product taxonomy of the SKU, this is important as we use these categories to attribute correctly in the post-click post-view lookback windows. Incorrect categories could lead to incorrect attribution.
Example
Electronics > Electronics Accessories > Memory
Specifications
- Full category path in the local language or English is recommended.
- Case sensitive
Recommended parameters
These are parameters that will improve performance if present.
description
description
Definition
The description is a short piece of text that provides additional information about a product beyond its name.
Example
A red cotton t-shirt
Specifications
- Must start with either a letter or number.
- Maximum of 500 characters.
filters
filters
Definition
This feature allows Criteo to return relevant products on filtered pages.
Example
Color=Red|Black, Size=S|M|L|XL, Screen size=21
Specifications
- Maximum of 2000 characters.
- Comma-separated.
- Pipe
|
must be used as an “or” separator for multiple filter values. - Ensure that there are no ampersand characters (
&
) in the filter names or values as this will break the URL parsing when included in an ad request. - Filters passed in the product feed must exactly match the filters passed in the ad call on site.
gtin
gtin
Definition
A unique identifier for products within the global marketplace. Used to search for and add products to campaigns.
Example
123456789012
Specifications
- Must be an 8-, 12-, 13-, or 14-digit number.
- UPC: 12-digit GTIN used mainly in North America.
- EAN: 13-digit GTIN used internationally.
- JAN: Japanese version of the EAN.
- ISBN: 13-digit identifier for books.
item_group_id
item_group_id
Definition
The 'parent' SKU id. For example, if an apparel retailer has several child variants in the feed (one for each size and color) each variant should include the same item_group_id
value.
Example
256dc9
Specifications
- Must be unique and consistent across products; changes to parent IDs can break attribution and reporting.
- String, maximum of 240 characters.
item_group_id
andid
can't have the same value. If there is only one variant, leaveitem_group_id
empty.- Quotation marks and non-ASCII characters are not supported.
- Case insensitive.
mpn
mpn
Definition
A number that uniquely identifies the product to its manufacturer.
Example
HV-HM02
Specifications
- Maximum of 70 characters.
number_of_reviews
number_of_reviews
Definition
Number of reviews for the SKU
Example
58
Specifications
- Maximum of 8 digits.
product_rating
product_rating
Definition
Rating of the SKU
Example
4.56
Specifications
- Maximum of 8 characters.
- Decimal separator must be a period (.).
size
size
Definition
Use the size parameter to describe the standardized size of your product.
Example
XL
Specification
- 100 char max
- Submit only one attribute per product
- Provide more size details using the other size parameters:
size_type
: Type of size (e.g., 'regular', 'petite', 'plus', 'big and tall', 'maternity')size_system
: Size standard (e.g., 'US', 'UK', 'EU', 'DE', 'FR', 'JP', 'CN' (China), 'IT', 'BR', 'MEX', 'AU')
expiration_date
expiration_date
Definition
Date when the product listing will expire.
Example
2025-06-31
Specification
- Date in ISO 8601 format. e.g. "2025-07-10", represents the 10th of July 2025.
Marketplace
Marketplace
seller_name
, seller_id
seller_name
, seller_id
This feature allows sellers that use your platform to advertise their own products.
- Important: if you have the same product being sold by different sellers, each product + seller combination must have its own unique
id
. - If your catalog uses the same ID for both 1P and 3P products, the recommended way of setting the
id
of products sold by sellers is[id]-[seller_id]
, e.g.ab123cd-as5df
seller_name
seller_name
Definition
Name of the seller on the marketplace
Example
bestbookshop
Specifications
- String, maximum of 200 characters.
seller_id
seller_id
Definition
ID of the seller on the marketplace
Example
as5df
Specifications
- Must be consistently set across products for each seller; changes to seller ID will break campaign attribution and reporting.
- String, maximum of 200 characters.
Regional data
Regional data
regiondata
regiondata
Definition
The store IDs where the product is available and its local prices.
Example
{'123':{'Price':'3.50'}, '456':{'Price':'4.29'}, '872':{'Price':'3.75'}, '958':{'Price':'5.00'}}
Specifications
- Comma-separated
- It is possible to send the price object empty (i.e.
{'123':{}, '456':{}}
) In this case, we will fallback toprice
as its value. - If the product is truly “out of stock” on the website across all stores, this field should contain
{}
(no stores)
Discounts
Discounts
sale_price
sale_price
Definition
This parameter is required if you want the ad to show the discounted price. If a product is "on sale", this field should reflect the higher price
Example
12.99
Specifications
- Maximum of 14 characters.
- Decimal separator must be a period (.) with no thousands separator.
Custom Parameters
Criteo allows the inclusion of custom parameters to enhance SKU representation on your site, aligning the appearance of SKUs with your organic tiles more closely.
These customizations ensure that the product tile rendered by Criteo match the native look and feel of your site.
Implementation details
JavaScript implementations
For JavaScript-based implementations, it is essential that all data necessary to display the product tile are included in the feed. This ensures that Criteo can effectively use the data on-site.
If your current feed does not include these fields, they should be added as new columns in the product feed file. This addition enables dynamic rendering of product tiles that include custom attributes specific to your site's design and functional requirements.
API implementations
For retailers using API implementations where the retailer pulls data from their own systems based on product ID, there is no requirement to adjust the feed for custom parameters. The API method allows for more flexibility in fetching additional data as needed without altering the feed structure.
Examples of custom parameters in use
To better understand how custom parameters can be used, here are two visual examples:
Standard feed parameters
In this first example, all the data necessary for the product tile is already included as eligible parameters in the standard feed.
Custom feed parameters
In the second example, the highlighted information includes "custom" data not present in the standard feed. These would need to be added to the feed in additional fields to allow Criteo to utilize them for rendering.
These examples highlight the flexibility of Criteo's platform in accommodating various data requirements, ensuring that the product tiles seamlessly integrate with the existing user interface of your website.
Updated 9 days ago