Pages

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from this space and version 5.16

...

PropertyDescriptionTypeRole
frosmoProductIdProduct ID.String (128)Required
frosmoProductArea

Geographical region, typically a part of a country, that applies to the product in some way.

For example, if the product is a hotel room, this property can provide the name of the in-country region in which the hotel is located:

  • frosmoProductCountry: Greece
  • frosmoProductArea: Rhodes
  • frosmoProductCity: Lindos
String (32)Optional
frosmoProductCampaignSales or other campaign with which the product is associated.String (32)Optional
frosmoProductCategories

Additional product categories to which the product belongs.

For more information about the object type, see the instructions below this table.

Object or stringified object (1024)Optional
frosmoProductCategory

Product type.

Info

Even if you do not have a value for this property, it is recommended that you nonetheless pass an empty string.


String (128)Optional
frosmoProductCity

City or town that applies to the product in some way.

For example, if the product is a hotel room, this property provides the name of the city or town in which the hotel is located:

  • frosmoProductCountry: Greece
  • frosmoProductArea: Rhodes
  • frosmoProductCity: Lindos
String (32)Optional
frosmoProductColors

Color options for the product.

For more information about the object type, see the instructions below this table.

Object or stringified object (1024)Optional
frosmoProductCompanyCompany that offers the product.String (32)Optional
frosmoProductConversion

If you do not want the product data push to increment the view count for the product, set this property to 1. In this case, the Frosmo Platform merely stores the pushed product data.

The default value is 0, which means that the Frosmo Platform also registers the product data push as a product view.

Info

Despite the name, this property does not trigger a conversion event for the product, regardless of the property value. If you want to trigger a conversion event for the product, use a conversion or transaction object, depending on whether the conversion is a product purchase.


NumberOptional
frosmoProductCountry

Country that applies to the product in some way.

For example, if the product is a hotel room, this property provides the name of the country in which the hotel is located:

  • frosmoProductCountry: Greece
  • frosmoProductArea: Rhodes
  • frosmoProductCity: Lindos
String (32)Optional
frosmoProductCustomImages

URLs of additional product images.

For more information about the object type, see the instructions below this table.

Object or stringified object (1024)Optional
frosmoProductData

Any piece of product data that does not logically belong to the other product properties but that you want to push with the product data. Use this property to send your own custom product attributes along with the product data.

For more information about the object type, see the instructions below this table.

Object or stringified object (2048)Optional
frosmoProductDescriptionProduct description.String (512)Optional
frosmoProductDiscountPriceDiscount unit price for the product.NumberOptionalfrosmoProductIdProduct ID.String (128)Required
frosmoProductIds

Additional product IDs.

For example, if the product consists of multiple child products, you can add their IDs to this property.

For more information about the object type, see the instructions below this table.

Object or stringified object (1024)Optional
frosmoProductImage

Product image URL.

Info

Even if you do not have a value for this property, it is recommended that you nonetheless pass an empty string.


String (512)Optional
frosmoProductMainCategoryMain product category to which the product belongs.String (128)Optional
frosmoProductManufacturerCompany that produces the product, or the brand name for the product.String (512)Optional
frosmoProductModelProduct model name.String (32)Optional
frosmoProductMultiPrices

Additional unit price options for the product.

For more information about the object type, see the instructions below this table.

Object or stringified object (2048)Optional
frosmoProductName

Product name.

Info

Even if you do not have a value for this property, it is recommended that you nonetheless pass an empty string.


String (128)Optional
frosmoProductPrice

Unit price for the product.

Info

Even if you do not have a value for this property, it is recommended that you nonetheless pass an empty string.


NumberOptional
frosmoProductPromotionLabel

Promotion-related label, such as "Weekend Sale" or "80% off!".

Info

This property is intended for promotion-related label strings. Do not use this property for stringified objects. If you need to store extra product data beyond the standard product data properties listed here, use the frosmoProductData property.


String (512)Optional
frosmoProductRatingProduct rating.String (512)Optional
frosmoProductStockNumber of product units in stock.NumberOptional
frosmoProductSubCategorySubcategory to which the product belongs. The subcategory should be a child category of the main product category.String (128)Optional
frosmoProductUrl

Product page URL.

Info

Even if you do not have a value for this property, it is recommended that you nonetheless pass an empty string.


String (512)Optional
frosmoProductUrnUniform Resource Names (URN) for the product.String (32)Optional
frosmoProductVenue

Venue in which the product is available.

For example, if the product is a specific showing of a movie, this property would be the movie theater in which the movie is shown.

String (64)Optional

...