- 27 Oct 2024
- DarkLight
Enhanced Feeds: Column Descriptions
- Updated on 27 Oct 2024
- DarkLight
Awin Product
An Awin Product has the same structure as the official Google product data specification.
The Google format however has several fields that are used for managing Google Merchant Centre settings. Awin accepts feeds with any of those values submitted, but will neither store nor display them to publishers:
costs_of_goods_sold
ads_redirect
custom_label_0-4
promotion_id
external_seller_id
excluded_destination
included_destination
shopping_ads
excluded_country
pause
shipping_label
transit_time_label
tax_category
Product Example:
{"product_basic":{"id":"16817108","title":"Organic Cotton Men''s T-Shirt - Blue - M","description":"Made from 100% organic cotton, this classic red men''s polo has a slim fit and signature logo embroidered on the left chest. Machine wash cold; imported.","link":"https://www.example.com/writing/pens","image_link":"http:// www.example.com/image1.jpg","additional_image_link":["http://www.example.com/image1.jpg","http://www.example.com/image2.jpg"],"mobile_link":"https://www.m.example.com/writing/pens"},"price_and_availability":{"availability":"in_stock","availability_date":"2023-12-25T13:00-0800","expiration_date":"2023-12-26T13:00-0800","price":"15.00 GBP","sale_price":"5.00 GBP","sale_price_effective_date":"2022-02-24T13:00-0800/2022-03-29T15:30-0800","cost_of_goods_sold":"3526.63 USD","unit_pricing_measure":"750 ml","unit_pricing_base_measure":"100 ml","installment":{"months":6,"amount":"50 BRL"},"subscription_cost":{"period":"month","period_length":"12","amount":"35.00 EUR"},"loyalty_points":"Programme A:100:0.5"},"product_category":{"google_product_category":"Apparel & Accessories > Clothing > Dresses","product_type":"Home > Women > Dresses > Maxi Dresses"},"product_identifiers":{"brand":"Google","gtin":"3243567980126","mpn":"EXA12345MPLE","identifier_exists":"yes"},"product_detailed":{"condition":"new","adult":"yes","multipack":20,"is_bundle":false,"energy_efficiency_class":"A+","min_energy_efficiency_class":"A+","max_energy_efficiency_class":"D","age_group":"adult","color":"yellow","gender":"unisex","material":"Cotton/polyester/elastane","pattern":"Striped","size":"L","size_type":["regular","plus"],"size_system":"UK","item_group_id":"AB12345","product_length":"14 cm","product_width":"14 cm","product_height":"14 cm","product_weight":"173 g","product_detail":[{"section_name":"General","attribute_name":"Product Type","attribute_value":"Digital player"},{"section_name":"General","attribute_name":"Product Type","attribute_value":"Digital Video"}],"product_highlight":["Supports thousands of apps, including Netflix, YouTube, HBO Now, Spotify, Showtime, Pandora, Google Play Movies","Supports thousands of apps, including Netflix, YouTube, HBO Now, Spotify, Showtime, Pandora, Google Play Movies","Supports thousands of apps, including Netflix, YouTube, HBO Now, Spotify, Showtime, Pandora, Google Play Movies"]},"shopping_campaign":{"lifestyle_image_link":"https://www.example.com/image1.jpg","short_title":"Running Shoes"},"delivery":{"shipping":[{"country":"US","region":"US","postal_code":"80302","service":"Overnight","price":"16.00 USD","min_handling_time":"1","max_handling_time":"1","min_transit_time":"3","max_transit_time":"3"}],"shipping_weight":"3 kg","shipping_length":"20 in","shipping_width":"40 cm","shipping_height":"20 in","ships_from_country":"DE","min_handling_time":1,"max_handling_time":10},"tax":{"tax":[{"country":"US","region":"CA","postal_code":"94043","rate":"8.75","tax_ship":"yes"}]}} |
This is an example of one valid product, there should not be any new lines within the product’s JSON.
Product Sections
An Awin Product consists of sections which contain the individual fields that contain product information.
Basic Product Data
id - Required | Advertiser’s unique product ID to identify each product
1–50 characters |
{"product_basic":{"id":"16817108"}} |
title | Advertiser's product name. Distinguish between variants where applicable
1–150 characters |
{"product_basic":{"title":"Organic Cotton Men''s T-Shirt - Blue - M"}} |
description | Advertiser's product description
1–5,000 characters |
{"product_basic":{"Made from 100% organic cotton, this classic red men''s polo has a slim fit and signature logo embroidered on the left chest. Machine wash cold; imported."}} |
link | Direct link to the product – non trackable URL (including http or https), ASCII characters only RFC 3986 compliant 1–2000 characters |
{"product_basic":{"link":"https://www.example.com/writing/pens"}} |
image_link | Direct link to product image – non trackable
JPEG (.jpg/.jpeg), WebP (.webp), PNG (.png), GIF (.gif), BMP (.bmp), and TIFF (.tif/.tiff). The image's file extension should correspond to its format. 1–2,000 characters |
{"product_basic":{"image_link":"http:// www.example.com/image1.jpg"}} |
additional_image link - Optional | Direct links to additional product images – non trackable Json Array of String
JPEG (.jpg/.jpeg), WebP (.webp), PNG (.png), GIF (.gif), BMP (.bmp), and TIFF (.tif/.tiff). The image's file extension should correspond to its format. 1–2,000 characters To submit more than 1 image (up to 10), separate each URL with a comma ( , ): https://www.example.com/image2.jpg,https://www.example.com/image3.jpg Make sure that you encode any commas (as %2C) within the URL, but don't encode the comma that you use to separate each image URL: https://www.example.com/image2%2C3.jpg,https://www.example.com/image2%2C4.jpg |
{"product_basic":{"additional_image_link":[ "http://www.example.com/image1.jpg", "http://www.example.com/image2.jpg" ]}} |
mobile_link - Optional | A mobile-optimised version of advertiser’s landing page link URL (including http or https), ASCII characters only RFC 3986 compliant 1–2000 characters |
{"product_basic":{"mobile_link":"https://www.m.example.com/writing/pens"}} |
Price and Availability
availability | Indicate product availability Supported values must be submitted in English:
If 'preorder' or 'backorder' are set, you must also provide the 'availability_date' |
{"price_and_availability":{"availability":"in_stock"}} |
availability_date | Date a product set to 'preorder' or 'backorder' becomes available YYYY-MM-DDThh:mm[±hhmm], or YYYY-MM-DDThh:mmZ If a time or timezone isn't included, the default will be set to 12am, midnight, in the UTC timezone. |
{"price_and_availability":{"availability_date":"2023-12-25T13:00-0800"}} |
expiration_date - Optional | The date the product will stop being available. Note: This field does not affect when the product will be visible to publishers. YYYY-MM-DDThh:mm[±hhmm], or YYYY-MM-DDThh:mmZ If a time or timezone isn't included, the default will be set to 12am, midnight, in the UTC timezone. |
{"price_and_availability": "expiration_date":"2023-12-26T13:00-0800"}} |
price | Product price Number plus currency (ISO 4217) Don't provide more than 2 digits after the decimal separator. |
{"price_and_availability":{"price":"15.00 GBP"}} |
sale_price | Product price during sale periods Number plus currency (ISO 4217) Don't provide more than 2 digits after the decimal separator. |
{"price_and_availability":{"sale_price":"5.00 GBP"}} |
sale_price_effective_date | To indicate the date range the sale will run for when using the sale_price attribute Date range (use ISO 8601 standard). Submit a start date and an end date with time and timezone of format YYY-MM-DDThh:mm[±hhmm] or YYY-MM-DDThh:mmZ, separated by slash If a time isn't included, the sale price will start at 12AM, midnight, on the start date and end at 11:59PM on the end date. If a timezone isn't included, it will default to the UTC timezone. |
{"price_and_availability":{"sale_price_effective_date":"2022-02-24T13:00-0800/2022-03-29T15:30-0800"}} |
unit_pricing_measure - Optional | Define the measure and dimension of the product. This value allows publishers and users to understand the exact cost per unit for the product. This attribute is optional, but may be required based on local laws or regulations. Some products that often use this attribute: Hardware, Office Supplies, Food, Beverages, Flooring, Business Cards, Perfume Supported units:
|
{"price_and_availability":{"unit_pricing_measure":"750 ml"}} |
unit_pricing_base_measure - Optional | The product’s base measure for pricing (for example, ‘100ml’ means the price is calculated based on a 100ml units) Positive number or positive number plus unit Supported units:
Additional supported metric integer + unit combinations:
|
{"price_and_availability":{"unit_pricing_base_measure":"100 ml"}} |
installment - Optional | The installment payment plan available for the product. Supported by Google for all product categories in Latin America, for wireless products and services in specific other countries.
|
{"price_and_availability":{"installment":{ "months":6, "amount":"50 BRL" }}} |
subscription_cost - Optional | The details of a monthly or annual payment plan that bundles a communications service contract with a wireless product (mobile phone or tablet). Supported by Google for specific countries. Supported values:
|
{"price_and_availability":{"subscription_cost":{ "period":"month", "period_length":12, "amount":"35.00 EUR" }}} |
loyalty_program | Specify how many and what type of loyalty points a customer receives when buying the product. String (Unicode characters, Recommend: ASCII only) JSON Array of Objects:
|
{"price_and_availability":{"loyalty_program":[ { "program_label":"Progamme A" "tier_label":"silver" "price":"100 USD" "loyalty_points":"0.5" } ]}} |
Product Category
google_product_category - Recommended | Google-defined product category for the product Refer to the Google product category [google_product_category] - Google Merchant Center Help Submit either the numerical category ID or the full category path. Publishers will receive both the ID and the category string in the language provided. Awin accepts the full category path in the below languages. If just the ID is provided, publishers will receive both the ID and the category string in English. For the pilot, we only support Google categories in English. |
{"product_category":{"google_product_category":"Apparel & Accessories > Clothing > Dresses"}} |
product_type | Advertiser's product category
1–750 characters |
{"product_category":{"product_type":"Home > Women > Dresses > Maxi Dresses"}} |
Product Identifiers
brand | Name of the product's brand Unicode characters (Recommended: ASCII only) 1–70 characters
|
{"product_identifiers":{"brand":"Google"}} |
gtin | Global Trade Item Number (GTIN), a unique and internationally recognised identifier for a product. Number (spaces and dashes are accepted, but ignored)
Each product and variant of a product (different colours or sizes) has its own GTIN, so make sure to submit the correct value. If the product doesn't have a GTIN (e.g. vintage clothing or handmade goods), provide the 'MPN' and 'brand' attributes. |
{"product_identifiers":{"gtin":"3243567980126"}} |
mpn | Product's Manufacturer Part Number (MPN), a unique number issued by manufacturers to identify individual products String (Alphanumeric, Unicode characters. Recommended: ASCII only) 1–70 characters If the product doesn’t have a clearly associated MPN or is a custom-made product (for example, art, custom t-shirts, novelty products, and handmade products), the attribute is optional. |
{"product_identifiers":{"mpn":"EXA12345MPLE"}} |
identifier_exists | Use the identifier_exists attribute to indicate that unique product identifiers (GTIN, MPN, Brand) aren’t available for the product. Supported values must be submitted in English:
|
{"product_identifiers":{"identifier_exists":”yes”}} |
Detailed product description
condition | Condition of the product
|
{"product_detailed":{"condition":"new"}} |
Certification | If your products target any of the EU or EFTA member states or the UK, consult EU energy efficiency regulations or any applicable local law to determine if you need to provide this attribute. This includes products covered by rescaled EU energy labels Json Array containing Json Object with keys: Authority [certification_authority] (Required) - The authority or certification body responsible for issuing the certification. At this time, we support the following values:
Name [certification_name] (Required): The name of the certification. At this time, we support the following values:
Code [certification_code] (Sometimes Required): The code of the certification. For example, for the EPREL certificate with the link https://eprel.ec.europa.eu/screen/product/dishwashers2019/123456 the code is 123456. The code is required for European Energy Labels. Not required for Vehicle ads. Value [certification_value] (Sometimes Required): The value of the certification. This field is ignored for certifications that require a certification code, like EPREL, but can be provided for specific certifications where a code isn't applicable. Specifically, the value of the appropriate CO2 Emission Class is required when listing vehicles in some countries. For details, refer to the Vehicle ads overview. | |
{"certification":{ |
adult | Indicate that the product is for adults only because it contains adult content such as nudity, sexually suggestive content, or is intended to enhance sexual activity.
|
{"product_detailed":{"adult":true}} |
multipack | Indicate that multiple identical products have been grouped for sale as one product
|
{"product_detailed":{"multipack":20}} |
is_bundle | Indicate that a main product is grouped with other, different products, sold together as one package for a single price. The main product of a bundle is the featured product of those products included in the bundle. The additional products should be accessories or add-ons that complement the main product. For a video game console sold with three video games, the video game console is the main product.
|
{"product_detailed":{"is_bundle":false}} |
energy_efficiency_class | The energy efficiency label of the product. To be used in combination with ‘min_energy_efficiency_class’ and ‘max_energy_efficiency_class’ to create an energy efficiency label, for example, A+ (A+++ to G) Supported values:
The energy efficiency class value must be within the range of the minimum energy efficiency class value and the maximum energy efficiency class value.
|
{"product_detailed":{"energy_efficiency_class":"A+"}} |
min_energy_efficiency_class | The minimum energy efficiency label of the product. To be used in combination with ‘energy_efficiency_class’ and 'max_energy_efficiency_class' to create an energy efficiency label, for example, A+ (A+++ to D) Supported values:
|
{"product_detailed":{"min_energy_efficiency_class":"A+"}} |
max_energy_efficiency_class | The maximum energy efficiency label of the product. To be used in combination with ‘energy_efficiency_class’ and ‘min_energy_efficiency_class’ to create an energy efficiency label, for example, A+ (A+++ to D) Supported values:
|
{"product_detailed":{"max_energy_efficiency_class":"D"}} |
age_group | The demographic the product is designed for
Google requires this for free listings for all Apparel & Accessories (ID 166) products Google requires this for Shopping ads for all Apparel & Accessories (ID 166) products when targeting these countries:
Optional for all other categories and for products in the following Apparel & Accessories sub-categories:
|
{"product_detailed":{"age_group":"adult"}} |
color | The product’s colour 1–100 characters total
Google requires this for free listings for all Apparel Accessories (ID:166) products Google also requires this for Shopping ads for Apparel Accessories (ID:166) products when targeting these countries:
Optional otherwise |
{"product_detailed":{"color":"yellow"}} |
gender | The gender the product is designed for Supported values must be submitted in English:
Google requires this for free listings for all Apparel & Accessories (ID 166) products Google requires this for Shopping ads for all Apparel & Accessories (ID 166) products when targeting these countries:
Optional for all other categories and for products in the following Apparel & Accessories sub-categories:
|
{"product_detailed":{"gender":"unisex"}} |
material | The main fabric or material the product is made of Max 200 characters
|
{"product_detailed":{"material":"Cotton/polyester/elastane"}} |
pattern | The pattern or graphic print on the product Max 100 characters |
{"product_detailed":{"pattern":"Striped"}} |
size | The standardised size of the product String (Alphanumeric, Unicode characters. Recommended: ASCII) 1–100 characters
Google requires this for free listings for all Apparel & Accessories > Clothing (ID 1604) and Apparel & Accessories > Shoes (ID 187) products Google also requires this for Shopping ads for Apparel & Accessories > Clothing (ID 1604) and Apparel & Accessories > Shoes (ID 187) products when targeting these countries:
|
{"product_detailed":{"size":"L"}} |
size_type | The product’s size type or cut Json Array of String Supported values must be submitted in English:
|
{"product_detailed":{"size_type":[ "regular", "plus" ]}} |
size_system | The country’s sizing system the product uses Supported values must be submitted in English:
Make sure to submit the specific size of the product using the ‘size’ attribute. |
{"product_detailed":{"size_system":"UK"}} |
item_group_id | The product’s group ID. If the product is one variation of a set of products (e.g. the same shoes in multiple sizes and colours), use this attribute for the ID/SKU of the product. Publishers will be able to group variations of the same product that way. String (Alphanumeric, Unicode characters. Recommended: ASCII 1–50 characters
Google requires this for free listings for product variants Google also requires this for Shopping ads for product variants targeting the following countries:
|
{"product_detailed":{"item_group_id":"AB12345"}} |
product_length | Length of the product
Supported units:
Values between 1–3,000 Decimal values are supported (.) |
{"product_detailed":{"product_length":"14 cm"}} |
product_width | Width of the product Number plus measurement unit Supported units:
Values between 1–3,000 Decimal values are supported (.) |
{"product_detailed":{"product_width":"14 cm"}} |
product_height | Length of the product Number plus measurement unit Supported units:
Values between 1–3,000 Decimal values are supported (.) |
{"product_detailed":{"product_height":"14 cm"}} |
product_weight | Weight of the product Number plus measurement unit Supported units:
Values between 0–2,000 Decimal values are supported (.) |
{"product_detailed":{"product_weight":"173 g"}} |
product_detail - Optional | Provide technical specifications or additional details of the product not explicitly covered by other attributes Json Array containing Json Object with keys:
String (Alphanumeric, Unicode characters. Recommended: ASCII) Section name: up to 140 characters Attribute name: up to 140 characters Attribute value: up to 1,000 characters |
{"product_detailed":{"product_detail":[ { "section_name":"General", "attribute_name":"Product Type", "attribute_value":"Digital player" }, { "attribute_name":"Product Type", "attribute_value":"Digital Video" } ]}} |
product_highlight - Optional | Provide short bulleted lists of the most relevant highlights of your products Json Array of String String (Alphanumeric, Unicode characters. Recommended: ASCII) 1–150 characters per highlight Minimum 2, Maximum of 100 highlights |
{"product_detailed":{“product_highlight":[ "Supports thousands of apps, including Netflix, YouTube, HBO Now, Spotify, Showtime, Pandora, Google Play Movies", "Supports thousands of apps, including Netflix, YouTube, HBO Now, Spotify, Showtime, Pandora, Google Play Movies", "Supports thousands of apps, including Netflix, YouTube, HBO Now, Spotify, Showtime, Pandora, Google Play Movies" ]}} |
Shopping Campaigns and other configurations
If no shopping camping information is required, the key does not need to be set.
lifestyle_image_link - Optional | Include the URL for a lifestyle image to showcase your product in a real world context, for example, clothing worn by a model, furniture staged within a room, multiple products displayed as a complete set, or products shown with vivid background colours or presented in playful situations. GIF (.gif), JPEG (.jpg/.jpeg), PNG (.png), BMP (.bmp), and TIFF (.tif/.tiff). The image's file extension should correspond to its format 1–2,000 characters
|
{"shopping_campaign":{"lifestyle_image_link":"https://www.example.com/image1.jpg"}} |
Delivery
If no delivery information is required, the key does not need to be set.
shipping - Optional | Provide shipping speed and cost for the product. The ‘shipping’ attribute uses sub-attributes to define country, delivery area, service, price, handling time, and transit time. Json Array containing Json Object with keys:
|
{"delivery":{"shipping": [ { "country":"US", "region":"US", "postal_code":"80302", "location_id":21137, "location_group_name":"Outback", "service":"Overnight", "price":"16.00 USD", "min_handling_time":1, "max_handling_time":1, "min_transit_time":3, "max_transit_time":3 } ]}} |
shipping_weight - Optional | The weight to use when calculating shipping costs Number plus measurement unit Supported units:
Values between 1–1,000 for metric and 1–2,000 for imperial Decimal points (e.g. 1.5 kg) are supported |
{"delivery":{"shipping_weight":"3 kg"} |
shipping_length - Optional | Length dimensions of the package for the product Number plus measurement unit Supported units:
Values between 1–400 for metric and 1–150 for imperial |
{"delivery":{"shipping_length":"20 in"} |
shipping_width - Optional | Width dimensions of the package for the product Number plus measurement unit Supported units:
Values between 1–400 for metric and 1–150 for imperial |
{"delivery":{"shipping_width":"40 cm"} |
shipping_ height - Optional | Height dimensions of the package for the product Number plus measurement unit Supported units:
Values between 1–400 for metric and 1–150 for imperial |
{"delivery":{"shipping_height":"20 in"} |
ships_from_country - Optional | The country from which the product will usually be dispatched from
ISO 3166-1 Alpha-2 country code |
{"delivery":{"ships_from_country":"DE"} |
min_handling_time - Optional | The shortest amount of time between when an order is placed for a product and when the product ships Number (whole number), greater than or equal to 0 Integer, greater than or equal to 0
|
{"delivery":{"min_handling_time":1} |
max_handling_time - Optional | The longest amount of time between when an order is placed for a product and when the product ships Number (whole number), greater than or equal to 0
|
{"delivery":{"max_handling_time":10} |
Tax
If no tax information is required, the key does not need to be set.
Tax fields are required for US Tax only, otherwise they’re optional.
tax - Required for the United States/Optional | The product’s sales tax. Google only support this for US sales tax. Don't use it for other taxes, such as value-added tax (VAT) or import tax Json Array containing Json Object with keys:
|
{"tax":{ "tax":[ { "country":"US", "region":"CA", "postal_code":"94043", "rate":8.75, "tax_ship":"yes" } ] }} |