Class FacebookProduct
Represents a row in the Facebook catalog feed export.
| Constant | Description |
|---|---|
| AGE_GROUP_ADULT: String = "adult" | Indicates that the product is for adults. |
| AGE_GROUP_INFANT: String = "infant" | Indicates that the product is for infant children. |
| AGE_GROUP_KIDS: String = "kids" | Indicates that the product is for children. |
| AGE_GROUP_NEWBORN: String = "newborn" | Indicates that the product is for newborn children. |
| AGE_GROUP_TODDLER: String = "toddler" | Indicates that the product is for toddler children. |
| AVAILABILITY_AVAILABLE_FOR_ORDER: String = "available for order" | Indicates that the product can be ordered for later shipment. |
| AVAILABILITY_IN_STOCK: String = "in stock" | Indicates that the product is available to ship immediately. |
| AVAILABILITY_OUT_OF_STOCK: String = "out of stock" | Indicates that the product is out of stock. |
| AVAILABILITY_PREORDER: String = "preorder" | Indicates that the product will be available in the future. |
| CONDITION_NEW: String = "new" | Indicates that the product is new. |
| CONDITION_REFURBISHED: String = "refurbished" | Indicates that the product is used but has been refurbished. |
| CONDITION_USED: String = "used" | Indicates that the product has been used. |
| GENDER_FEMALE: String = "female" | Indicates that the product is for females. |
| GENDER_MALE: String = "male" | Indicates that the product is for males. |
| GENDER_UNISEX: String = "unisex" | Indicates that the product is for both males and females. |
| SHIPPING_SIZE_UNIT_CM: String = "cm" | Indicates that the product is measured in centimeters. |
| SHIPPING_SIZE_UNIT_FT: String = "ft" | Indicates that the product is measured in feet. |
| SHIPPING_SIZE_UNIT_IN: String = "in" | Indicates that the product is measured in inches. |
| SHIPPING_SIZE_UNIT_M: String = "m" | Indicates that the product is measured in meters. |
| SHIPPING_WEIGHT_UNIT_G: String = "g" | Indicates that the product is weighed in grams. |
| SHIPPING_WEIGHT_UNIT_KG: String = "kg" | Indicates that the product is weighed in kilograms. |
| SHIPPING_WEIGHT_UNIT_LB: String = "lb" | Indicates that the product is weighed in pounds. |
| SHIPPING_WEIGHT_UNIT_OZ: String = "oz" | Indicates that the product is weighed in ounces. |
| Property | Description |
|---|---|
ID: String (read-only) | Returns the ID of the Facebook product. |
| ageGroup: String | Returns the age group for the Facebook product. |
| availability: String | Returns the availability of the Facebook product. |
| brand: String | Returns the Facebook brand of the product. |
| color: String | Returns the Facebook color value label of the product. |
| condition: String | Returns the condition of the Facebook product. |
| customLabel0: String | Returns the Facebook custom label 0 value of the product. |
| customLabel1: String | Returns the Facebook custom label 1 value of the product. |
| customLabel2: String | Returns the Facebook custom label 2 value of the product. |
| customLabel3: String | Returns the Facebook custom label 3 value of the product. |
| customLabel4: String | Returns the Facebook custom label 4 value of the product. |
| description: String | Returns the description of the Facebook product. |
| expirationDate: Date | Returns the Facebook expiration date of the product. |
| gender: String | Returns the gender for the Facebook product. |
| googleProductCategory: String | Returns the category of this product in the Google category taxonomy. |
| gtin: String | Returns the Facebook GTIN of the product. |
| imageLinks: List | Returns a list containing the URLs of the images to show in Facebook for the product. |
| itemGroupID: String | Returns the ID of the Facebook item group for the product, that is, its master product. |
| link: URL | Returns the URL of the Demandware storefront link to the product. |
| material: String | Returns the Facebook material value label of the product. |
| mpn: String | Returns the Facebook MPN of the product. |
| pattern: String | Returns the Facebook pattern value label of the product. |
| price: Money | Returns the price to show in Facebook for the product. |
| productType: String | Returns the Facebook product type. |
| salePrice: Money | Returns the sale price to show in Facebook for the product. |
| salePriceEffectiveDateEnd: Date | Returns the end date of the Facebook sale price of the product. |
| salePriceEffectiveDateStart: Date | Returns the start date of the Facebook sale price of the product. |
| shippingHeight: Number | Returns the shipping height of the product. |
| shippingLength: Number | Returns the shipping length of the product. |
| shippingSizeUnit: String | Returns the shipping size unit of the product. |
| shippingWeight: Quantity | Returns the shipping weight for the product. |
| shippingWidth: Number | Returns the shipping width of the product. |
| size: String | Returns the Facebook size value label of the product. |
| title: String | Returns the title of the Facebook product. |
This class does not have a constructor, so you cannot create it directly.
| Method | Description |
|---|---|
| getAgeGroup() | Returns the age group for the Facebook product. |
| getAvailability() | Returns the availability of the Facebook product. |
| getBrand() | Returns the Facebook brand of the product. |
| getColor() | Returns the Facebook color value label of the product. |
| getCondition() | Returns the condition of the Facebook product. |
| getCustomLabel0() | Returns the Facebook custom label 0 value of the product. |
| getCustomLabel1() | Returns the Facebook custom label 1 value of the product. |
| getCustomLabel2() | Returns the Facebook custom label 2 value of the product. |
| getCustomLabel3() | Returns the Facebook custom label 3 value of the product. |
| getCustomLabel4() | Returns the Facebook custom label 4 value of the product. |
| getDescription() | Returns the description of the Facebook product. |
| getExpirationDate() | Returns the Facebook expiration date of the product. |
| getGender() | Returns the gender for the Facebook product. |
| getGoogleProductCategory() | Returns the category of this product in the Google category taxonomy. |
| getGtin() | Returns the Facebook GTIN of the product. |
| getID() | Returns the ID of the Facebook product. |
| getImageLinks() | Returns a list containing the URLs of the images to show in Facebook for the product. |
| getItemGroupID() | Returns the ID of the Facebook item group for the product, that is, its master product. |
| getLink() | Returns the URL of the Demandware storefront link to the product. |
| getMaterial() | Returns the Facebook material value label of the product. |
| getMpn() | Returns the Facebook MPN of the product. |
| getPattern() | Returns the Facebook pattern value label of the product. |
| getPrice() | Returns the price to show in Facebook for the product. |
| getProductType() | Returns the Facebook product type. |
| getSalePrice() | Returns the sale price to show in Facebook for the product. |
| getSalePriceEffectiveDateEnd() | Returns the end date of the Facebook sale price of the product. |
| getSalePriceEffectiveDateStart() | Returns the start date of the Facebook sale price of the product. |
| getShippingHeight() | Returns the shipping height of the product. |
| getShippingLength() | Returns the shipping length of the product. |
| getShippingSizeUnit() | Returns the shipping size unit of the product. |
| getShippingWeight() | Returns the shipping weight for the product. |
| getShippingWidth() | Returns the shipping width of the product. |
| getSize() | Returns the Facebook size value label of the product. |
| getTitle() | Returns the title of the Facebook product. |
| setAgeGroup(String) | Sets the age group for the Facebook product. |
| setAvailability(String) | Sets the availability of the Facebook product. |
| setBrand(String) | Sets the Facebook brand of the product. |
| setColor(String) | Sets the Facebook color value label of the product. |
| setCondition(String) | Sets the condition of the Facebook product. |
| setCustomLabel0(String) | Sets the Facebook custom label 0 value of the product. |
| setCustomLabel1(String) | Sets the Facebook custom label 1 value of the product. |
| setCustomLabel2(String) | Sets the Facebook custom label 2 value of the product. |
| setCustomLabel3(String) | Sets the Facebook custom label 3 value of the product. |
| setCustomLabel4(String) | Sets the Facebook custom label 4 value of the product. |
| setDescription(String) | Sets the description of the Facebook product. |
| setExpirationDate(Date) | Sets the Facebook expiration date of the product. |
| setGender(String) | Sets the gender for the Facebook product. |
| setGoogleProductCategory(String) | Sets the category of this product in the Google category taxonomy. |
| setGtin(String) | Sets the Facebook GTIN of the product. |
| setImageLinks(List) | Sets the list of URLs of images to show in Facebook for the product. |
| setItemGroupID(String) | Sets the ID of the Facebook item group for the product, that is, its master product. |
| setLink(URL) | Sets the URL of the Demandware storefront link to the product. |
| setMaterial(String) | Sets the Facebook material value label of the product. |
| setMpn(String) | Sets the Facebook MPN of the product. |
| setPattern(String) | Sets the Facebook pattern value label of the product. |
| setPrice(Money) | Sets the price to show in Facebook for the product. |
| setProductType(String) | Sets the Facebook product type. |
| setSalePrice(Money) | Sets the sale price to show in Facebook for the product. |
| setSalePriceEffectiveDateEnd(Date) | Sets the end date of the Facebook sale price of the product. |
| setSalePriceEffectiveDateStart(Date) | Sets the start date of the Facebook sale price of the product. |
| setShippingHeight(Number) | Sets the shipping height of the product. |
| setShippingLength(Number) | Sets the shipping length of the product. |
| setShippingSizeUnit(String) | Sets the shipping size unit of the product. |
| setShippingWeight(Quantity) | Sets the shipping weight for the product. |
| setShippingWidth(Number) | Sets the shipping width of the product. |
| setSize(String) | Sets the Facebook size value label of the product. |
| setTitle(String) | Sets the title of the Facebook product. |
assign, create, create, defineProperties, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toLocaleString, toString, valueOf, values
- AGE_GROUP_ADULT: String = "adult"
Indicates that the product is for adults.
- AGE_GROUP_INFANT: String = "infant"
Indicates that the product is for infant children.
- AGE_GROUP_KIDS: String = "kids"
Indicates that the product is for children.
- AGE_GROUP_NEWBORN: String = "newborn"
Indicates that the product is for newborn children.
- AGE_GROUP_TODDLER: String = "toddler"
Indicates that the product is for toddler children.
- AVAILABILITY_AVAILABLE_FOR_ORDER: String = "available for order"
Indicates that the product can be ordered for later shipment.
- AVAILABILITY_IN_STOCK: String = "in stock"
Indicates that the product is available to ship immediately.
- AVAILABILITY_OUT_OF_STOCK: String = "out of stock"
Indicates that the product is out of stock.
- AVAILABILITY_PREORDER: String = "preorder"
Indicates that the product will be available in the future.
- CONDITION_NEW: String = "new"
Indicates that the product is new.
- CONDITION_REFURBISHED: String = "refurbished"
Indicates that the product is used but has been refurbished.
- CONDITION_USED: String = "used"
Indicates that the product has been used.
- GENDER_FEMALE: String = "female"
Indicates that the product is for females.
- GENDER_MALE: String = "male"
Indicates that the product is for males.
- GENDER_UNISEX: String = "unisex"
Indicates that the product is for both males and females.
- SHIPPING_SIZE_UNIT_CM: String = "cm"
Indicates that the product is measured in centimeters.
- SHIPPING_SIZE_UNIT_FT: String = "ft"
Indicates that the product is measured in feet.
- SHIPPING_SIZE_UNIT_IN: String = "in"
Indicates that the product is measured in inches.
- SHIPPING_SIZE_UNIT_M: String = "m"
Indicates that the product is measured in meters.
- SHIPPING_WEIGHT_UNIT_G: String = "g"
Indicates that the product is weighed in grams.
- SHIPPING_WEIGHT_UNIT_KG: String = "kg"
Indicates that the product is weighed in kilograms.
- SHIPPING_WEIGHT_UNIT_LB: String = "lb"
Indicates that the product is weighed in pounds.
- SHIPPING_WEIGHT_UNIT_OZ: String = "oz"
Indicates that the product is weighed in ounces.
- ID: String
(read-only) Returns the ID of the Facebook product. This is the same as the ID of the Demandware product.
- ageGroup: String
Returns the age group for the Facebook product.
- availability: String
Returns the availability of the Facebook product.
- brand: String
Returns the Facebook brand of the product.
- color: String
Returns the Facebook color value label of the product.
- condition: String
Returns the condition of the Facebook product.
- customLabel0: String
Returns the Facebook custom label 0 value of the product.
- customLabel1: String
Returns the Facebook custom label 1 value of the product.
- customLabel2: String
Returns the Facebook custom label 2 value of the product.
- customLabel3: String
Returns the Facebook custom label 3 value of the product.
- customLabel4: String
Returns the Facebook custom label 4 value of the product.
- description: String
Returns the description of the Facebook product.
- expirationDate: Date
Returns the Facebook expiration date of the product. If the product is expired it will not be shown.
- gender: String
Returns the gender for the Facebook product.
- googleProductCategory: String
Returns the category of this product in the Google category taxonomy. If the value is longer than 250 characters it is truncated.
- gtin: String
Returns the Facebook GTIN of the product.
- imageLinks: List
Returns a list containing the URLs of the images to show in Facebook for the product.
- itemGroupID: String
Returns the ID of the Facebook item group for the product, that is, its master product.
- link: URL
Returns the URL of the Demandware storefront link to the product.
- material: String
Returns the Facebook material value label of the product.
- mpn: String
Returns the Facebook MPN of the product.
- pattern: String
Returns the Facebook pattern value label of the product.
- price: Money
Returns the price to show in Facebook for the product.
- productType: String
Returns the Facebook product type. This is the retailer-defined category of the item.
- salePrice: Money
Returns the sale price to show in Facebook for the product.
- salePriceEffectiveDateEnd: Date
Returns the end date of the Facebook sale price of the product.
- salePriceEffectiveDateStart: Date
Returns the start date of the Facebook sale price of the product.
- shippingHeight: Number
Returns the shipping height of the product.
See Also:
- shippingLength: Number
Returns the shipping length of the product.
See Also:
- shippingSizeUnit: String
Returns the shipping size unit of the product.
See Also:
- shippingWeight: Quantity
Returns the shipping weight for the product.
- shippingWidth: Number
Returns the shipping width of the product.
See Also:
- size: String
Returns the Facebook size value label of the product.
- title: String
Returns the title of the Facebook product.
- getAgeGroup(): String
Returns the age group for the Facebook product.
Returns:
- product age group
- getAvailability(): String
Returns the availability of the Facebook product.
Returns:
- product availability
- getBrand(): String
Returns the Facebook brand of the product.
Returns:
- the brand
- getColor(): String
Returns the Facebook color value label of the product.
Returns:
- the color value label
- getCondition(): String
Returns the condition of the Facebook product.
Returns:
- product condition
- getCustomLabel0(): String
Returns the Facebook custom label 0 value of the product.
Returns:
- the custom label 0 value
- getCustomLabel1(): String
Returns the Facebook custom label 1 value of the product.
Returns:
- the custom label 1 value
- getCustomLabel2(): String
Returns the Facebook custom label 2 value of the product.
Returns:
- the custom label 2 value
- getCustomLabel3(): String
Returns the Facebook custom label 3 value of the product.
Returns:
- the custom label 3 value
- getCustomLabel4(): String
Returns the Facebook custom label 4 value of the product.
Returns:
- the custom label 4 value
- getDescription(): String
Returns the description of the Facebook product.
Returns:
- product description
- getExpirationDate(): Date
Returns the Facebook expiration date of the product. If the product is expired it will not be shown.
Returns:
- the expiration date
- getGender(): String
Returns the gender for the Facebook product.
Returns:
- product gender
- getGoogleProductCategory(): String
Returns the category of this product in the Google category taxonomy. If the value is longer than 250 characters it is truncated.
Returns:
- the category of this product in the Google category taxonomy
- getGtin(): String
Returns the Facebook GTIN of the product.
Returns:
- the GTIN
- getID(): String
Returns the ID of the Facebook product. This is the same as the ID of the Demandware product.
Returns:
- product ID
- getImageLinks(): List
Returns a list containing the URLs of the images to show in Facebook for the product.
Returns:
- the URLs of the images
- getItemGroupID(): String
Returns the ID of the Facebook item group for the product, that is, its master product.
Returns:
- the ID of the Facebook item group
- getLink(): URL
Returns the URL of the Demandware storefront link to the product.
Returns:
- the URL of the storefront link
- getMaterial(): String
Returns the Facebook material value label of the product.
Returns:
- the material value label
- getMpn(): String
Returns the Facebook MPN of the product.
Returns:
- the MPN
- getPattern(): String
Returns the Facebook pattern value label of the product.
Returns:
- the pattern value label
- getPrice(): Money
Returns the price to show in Facebook for the product.
Returns:
- the price to show in Facebook
- getProductType(): String
Returns the Facebook product type. This is the retailer-defined category of the item.
Returns:
- the Facebook product type
- getSalePrice(): Money
Returns the sale price to show in Facebook for the product.
Returns:
- the sale price to show in Facebook
- getSalePriceEffectiveDateEnd(): Date
Returns the end date of the Facebook sale price of the product.
Returns:
- the end date of the Facebook sale price
- getSalePriceEffectiveDateStart(): Date
Returns the start date of the Facebook sale price of the product.
Returns:
- the start date of the Facebook sale price
- getShippingHeight(): Number
Returns the shipping height of the product.
Returns:
- the shipping height
See Also:
- getShippingLength(): Number
Returns the shipping length of the product.
Returns:
- the shipping length
See Also:
- getShippingSizeUnit(): String
Returns the shipping size unit of the product.
Returns:
- the shipping size unit
See Also:
- getShippingWeight(): Quantity
Returns the shipping weight for the product.
Returns:
- the shipping weight
- getShippingWidth(): Number
Returns the shipping width of the product.
Returns:
- the shipping width
See Also:
- getSize(): String
Returns the Facebook size value label of the product.
Returns:
- the size value label
- getTitle(): String
Returns the title of the Facebook product.
Returns:
- product title
- setAgeGroup(ageGroup: String): void
Sets the age group for the Facebook product. Possible values are AGE_GROUP_ADULT, AGE_GROUP_INFANT, AGE_GROUP_KIDS, AGE_GROUP_NEWBORN, AGE_GROUP_TODDLER, or
null.Parameters:
- ageGroup - the ageGroup to set for this product
- setAvailability(availability: String): void
Sets the availability of the Facebook product. Possible values are AVAILABILITY_AVAILABLE_FOR_ORDER, AVAILABILITY_IN_STOCK, AVAILABILITY_OUT_OF_STOCK, or AVAILABILITY_PREORDER
Parameters:
- availability - the availability status to set for this product
- setBrand(brand: String): void
Sets the Facebook brand of the product. If the value is longer than 70 characters it is truncated.
Parameters:
- brand - Facebook brand, up to 70 characters
- setColor(color: String): void
Sets the Facebook color value label of the product. If the value is longer than 100 characters it is truncated.
Parameters:
- color - Facebook color value label, up to 100 characters
- setCondition(condition: String): void
Sets the condition of the Facebook product. Possible values are CONDITION_NEW, CONDITION_REFURBISHED, or CONDITION_USED.
Parameters:
- condition - the condition status to set for this product
- setCustomLabel0(customLabel0: String): void
Sets the Facebook custom label 0 value of the product.
Parameters:
- customLabel0 - custom label 0 value
- setCustomLabel1(customLabel1: String): void
Sets the Facebook custom label 1 value of the product.
Parameters:
- customLabel1 - custom label 1 value
- setCustomLabel2(customLabel2: String): void
Sets the Facebook custom label 2 value of the product.
Parameters:
- customLabel2 - custom label 2 value
- setCustomLabel3(customLabel3: String): void
Sets the Facebook custom label 3 value of the product.
Parameters:
- customLabel3 - custom label 3 value
- setCustomLabel4(customLabel4: String): void
Sets the Facebook custom label 4 value of the product.
Parameters:
- customLabel4 - custom label 4 value
- setDescription(description: String): void
Sets the description of the Facebook product. If the value is longer than 5000 characters it is truncated.
Parameters:
- description - product description, up to 5000 characters
- setExpirationDate(expirationDate: Date): void
Sets the Facebook expiration date of the product.
Parameters:
- expirationDate - Facebook expiration date
- setGender(gender: String): void
Sets the gender for the Facebook product. Possible values are GENDER_MALE, GENDER_FEMALE, GENDER_UNISEX, or
null.Parameters:
- gender - the gender to set for this product
- setGoogleProductCategory(googleProductCategory: String): void
Sets the category of this product in the Google category taxonomy.
Parameters:
- googleProductCategory - Google product category
- setGtin(gtin: String): void
Sets the Facebook GTIN of the product. If the value is longer than 70 characters it is truncated.
Parameters:
- gtin - Facebook GTIN, up to 70 characters
- setImageLinks(imageLinks: List): void
Sets the list of URLs of images to show in Facebook for the product.
Parameters:
- imageLinks - links to the product images
- setItemGroupID(itemGroupID: String): void
Sets the ID of the Facebook item group for the product, that is, its master product.
Parameters:
- itemGroupID - ID of Facebook item group
- setLink(link: URL): void
Sets the URL of the Demandware storefront link to the product.
Parameters:
- link - Demandware storefront link to the product
- setMaterial(material: String): void
Sets the Facebook material value label of the product. If the value is longer than 200 characters it is truncated.
Parameters:
- material - Facebook material value label, up to 200 characters
- setMpn(mpn: String): void
Sets the Facebook MPN of the product. If the value is longer than 70 characters it is truncated.
Parameters:
- mpn - Facebook MPN, up to 70 characters
- setPattern(pattern: String): void
Sets the Facebook pattern value label of the product. If the value is longer than 100 characters it is truncated.
Parameters:
- pattern - Facebook pattern value label, up to 100 characters
- setPrice(price: Money): void
Sets the price to show in Facebook for the product.
Parameters:
- price - Facebook price
- setProductType(productType: String): void
Sets the Facebook product type. If the value is longer than 750 characters it is truncated.
Parameters:
- productType - Facebook product type, up to 750 characters
- setSalePrice(salePrice: Money): void
Sets the sale price to show in Facebook for the product.
Parameters:
- salePrice - Facebook sale price
- setSalePriceEffectiveDateEnd(salePriceEffectiveDateEnd: Date): void
Sets the end date of the Facebook sale price of the product.
Parameters:
- salePriceEffectiveDateEnd - end date of Facebook sale price
- setSalePriceEffectiveDateStart(salePriceEffectiveDateStart: Date): void
Sets the start date of the Facebook sale price of the product.
Parameters:
- salePriceEffectiveDateStart - start date of Facebook sale price
- setShippingHeight(shippingHeight: Number): void
Sets the shipping height of the product. If the value is negative it is truncated to 0.
Parameters:
- shippingHeight - shipping height, may not be negative
See Also:
- setShippingLength(shippingLength: Number): void
Sets the shipping length of the product. If the value is negative it is truncated to 0.
Parameters:
- shippingLength - shipping length, may not be negative
See Also:
- setShippingSizeUnit(shippingSizeUnit: String): void
Sets the shipping size unit of the product.
Parameters:
- shippingSizeUnit - shipping size unit
See Also:
- setShippingWeight(shippingWeight: Quantity): void
Sets the shipping weight for the product. Possible unit values are SHIPPING_WEIGHT_UNIT_LB, SHIPPING_WEIGHT_UNIT_OZ, SHIPPING_WEIGHT_UNIT_G, or SHIPPING_WEIGHT_UNIT_KG.
Parameters:
- shippingWeight - product shipping weight
- setShippingWidth(shippingWidth: Number): void
Sets the shipping width of the product. If the value is negative it is truncated to 0.
Parameters:
- shippingWidth - shipping width, may not be negative
See Also:
- setSize(size: String): void
Sets the Facebook size value label of the product. If the value is longer than 100 characters it is truncated.
Parameters:
- size - Facebook size value label, up to 100 characters
- setTitle(title: String): void
Sets the title of the Facebook product. If the value is longer than 100 characters it is truncated.
Parameters:
- title - product title, up to 100 characters