| id |
string |
A unique identifier for the item. Aka Product ID. Don’t use casing to make IDs unique. |
|
| offer_id |
string |
Not used by Criteo. |
[optional] |
| title |
string |
Title of the item. (500 UTF8 characters max). |
|
| description |
string |
Description of the item. RECOMMENDED. (5000 UTF8 characters max). |
[optional] |
| link |
string |
URL directly linking to your item's page on your website. (1000 UTF8 characters max). |
|
| image_link |
string |
URL of an image of the item. Supported formats: PNG, JPEG, GIF. (2000 UTF8 characters max). |
|
| additional_image_links |
string[] |
Additional URLs of images of the item. |
[optional] |
| content_language |
string |
The two-letter ISO 639-1 language code for the item. |
[optional] |
| target_country |
string |
The CLDR territory code for the item. |
[optional] |
| channel |
string |
The item's channel (online only). |
|
| expiration_date |
string |
Date on which the item should expire, as specified upon insertion, in ISO 8601 format. |
[optional] |
| adult |
bool |
Set to true if the item is targeted towards adults. RECOMMENDED. |
[optional] |
| kind |
string |
Identifies what kind of resource this is. |
[optional] |
| brand |
string |
Brand of the item. RECOMMENDED. |
[optional] |
| color |
string |
Color of the item. |
[optional] |
| google_product_category |
string |
Google's category of the item (see Google product taxonomy). RECOMMENDED. |
[optional] |
| gtin |
string |
Global Trade Item Number (GTIN) of the item. RECOMMENDED. |
[optional] |
| item_group_id |
string |
Shared identifier for all variants of the same product. RECOMMENDED. Don’t use casing to make IDs unique. (50 characters max) |
[optional] |
| material |
string |
The material of which the item is made. |
[optional] |
| mpn |
string |
Manufacturer Part Number (MPN) of the item. RECOMMENDED. |
[optional] |
| pattern |
string |
The item's pattern (e.g. polka dots). |
[optional] |
| price |
\criteo\api\retailmedia\preview\Model\Price |
|
[optional] |
| sale_price |
\criteo\api\retailmedia\preview\Model\Price |
|
[optional] |
| sale_price_effective_date |
string |
Date range during which the item is on sale. |
[optional] |
| shipping |
\criteo\api\retailmedia\preview\Model\ProductShipping[] |
Shipping rules. |
[optional] |
| shipping_weight |
\criteo\api\retailmedia\preview\Model\ProductShippingWeight |
|
[optional] |
| sizes |
string[] |
Size of the item. RECOMMENDED. Only one value is allowed. For variants with different sizes, insert a separate product for each size with the same itemGroupId value. |
[optional] |
| taxes |
\criteo\api\retailmedia\preview\Model\ProductTax[] |
Tax information. |
[optional] |
| custom_attributes |
\criteo\api\retailmedia\preview\Model\CustomAttribute[] |
A list of custom (merchant-provided) attributes. This is useful for submitting attributes not explicitly exposed by the API. Declaring attributes explicitly exposed by the API using is forbidden |
[optional] |
| identifier_exists |
bool |
False when the item does not have unique product identifiers appropriate to its category, such as GTIN, MPN, and brand. Required according to the Unique Product Identifier Rules for all target countries except for Canada. |
[optional] |
| installment |
\criteo\api\retailmedia\preview\Model\Installment |
|
[optional] |
| loyalty_points |
\criteo\api\retailmedia\preview\Model\LoyaltyPoints |
|
[optional] |
| multipack |
int |
The number of identical products in a merchant-defined multipack. To avoid any overflow issue, pass it as a string. |
[optional] |
| custom_label0 |
string |
Custom label 0 for custom grouping of items in a Shopping campaign. |
[optional] |
| custom_label1 |
string |
Custom label 1 for custom grouping of items in a Shopping campaign. |
[optional] |
| custom_label2 |
string |
Custom label 2 for custom grouping of items in a Shopping campaign. |
[optional] |
| custom_label3 |
string |
Custom label 3 for custom grouping of items in a Shopping campaign. |
[optional] |
| custom_label4 |
string |
Custom label 4 for custom grouping of items in a Shopping campaign. |
[optional] |
| is_bundle |
bool |
Whether the item is a merchant-defined bundle. A bundle is a custom grouping of different products sold by a merchant for a single price. |
[optional] |
| mobile_link |
string |
accounts.link to a mobile-optimized version of the landing page. |
[optional] |
| availability_date |
string |
The day a pre-ordered product becomes available for delivery, in ISO 8601 format. |
[optional] |
| shipping_label |
string |
The shipping label of the product, used to group product in account-level shipping rules. |
[optional] |
| unit_pricing_measure |
\criteo\api\retailmedia\preview\Model\ProductUnitPricingMeasure |
|
[optional] |
| unit_pricing_base_measure |
\criteo\api\retailmedia\preview\Model\ProductUnitPricingBaseMeasure |
|
[optional] |
| shipping_length |
\criteo\api\retailmedia\preview\Model\ProductShippingDimension |
|
[optional] |
| shipping_width |
\criteo\api\retailmedia\preview\Model\ProductShippingDimension |
|
[optional] |
| shipping_height |
\criteo\api\retailmedia\preview\Model\ProductShippingDimension |
|
[optional] |
| display_ads_id |
string |
An identifier for an item for dynamic remarketing campaigns. |
[optional] |
| display_ads_similar_ids |
string[] |
Advertiser-specified recommendations. |
[optional] |
| display_ads_title |
string |
Title of an item for dynamic remarketing campaigns. |
[optional] |
| display_ads_link |
string |
URL directly to your item's landing page for dynamic remarketing campaigns. |
[optional] |
| display_ads_value |
float |
Offer margin for dynamic remarketing campaigns. |
[optional] |
| sell_on_google_quantity |
int |
The quantity of the product that is available for selling on Google. Supported only for online products. |
[optional] |
| promotion_ids |
string[] |
The unique ID of a promotion. |
[optional] |
| max_handling_time |
int |
Maximal product handling time (in business days). |
[optional] |
| min_handling_time |
int |
Minimal product handling time (in business days). |
[optional] |
| cost_of_goods_sold |
\criteo\api\retailmedia\preview\Model\Price |
|
[optional] |
| source |
string |
The source of the offer, i.e., how the offer was created. |
[optional] |
| included_destinations |
string[] |
The list of destinations to include for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in excludedDestinations. |
[optional] |
| excluded_destinations |
string[] |
The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center). |
[optional] |
| ads_grouping |
string |
Used to group items in an arbitrary way. Only for CPA%, discouraged otherwise. |
[optional] |
| ads_labels |
string[] |
Similar to adsGrouping, but only works on CPC. |
[optional] |
| ads_redirect |
string |
Allows advertisers to override the item URL when the product is shown within the context of Product Ads. |
[optional] |
| product_types |
string[] |
Categories of the item (formatted as in products data specification). |
[optional] |
| product_type_keys |
string[] |
Category keys of the item (formatted as in productTypes). |
[optional] |
| age_group |
string |
Target age group of the item. |
[optional] |
| availability |
string |
Availability status of the item. RECOMMENDED. |
[optional] |
| condition |
string |
Condition or state of the item. |
[optional] |
| gender |
string |
Target gender of the item. |
[optional] |
| size_system |
string |
System in which the size is specified. Recommended for apparel items. |
[optional] |
| size_type |
string |
The cut of the item. Recommended for apparel items. |
[optional] |
| energy_efficiency_class |
string |
The energy efficiency class as defined in EU directive 2010/30/EU. |
[optional] |
| min_energy_efficiency_class |
string |
The energy efficiency class as defined in EU directive 2010/30/EU. |
[optional] |
| max_energy_efficiency_class |
string |
The energy efficiency class as defined in EU directive 2010/30/EU. |
[optional] |
| tax_category |
string |
The tax category of the product, used to configure detailed tax nexus in account-level tax settings. |
[optional] |
| transit_time_label |
string |
The transit time label of the product, used to group product in account-level transit time tables. |
[optional] |
| seller_id |
string |
(Deprecated Field) The external ID of the seller (case sensitive and 50 UTF8 characters max). This information is required by the Criteo Offsite Ads. |
[optional] |
| external_seller_id |
string |
The external id of the seller (case sensitive and 50 UTF8 characters max). This information is required by the Criteo Offsite Ads. |
[optional] |
| external_seller_name |
string |
The external name of the seller (case sensitive and 50 UTF8 characters max). This information is required by the Criteo Offsite Ads. |
[optional] |
| number_of_reviews |
int |
The number of customer reviews for the product |
[optional] |
| product_rating |
string |
The product rating for the product |
[optional] |
| badge |
string |
URL of a badge image to display on the product. |
[optional] |