Salesforce B2C Commerce 24.7 > B2C Commerce API > B2C Commerce Script > dw.extensions.facebook
dw.extensions.facebook
Class FacebookProduct
Object
dw.extensions.facebook.FacebookProduct
Represents a row in the Facebook catalog feed export.
Constants
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.
Properties
ageGroup  :  String
The age group for the Facebook product.
availability  :  String
The availability of the Facebook product.
brand  :  String
The Facebook brand of the product.
color  :  String
The Facebook color value label of the product.
condition  :  String
The condition of the Facebook product.
customLabel0  :  String
The Facebook custom label 0 value of the product.
customLabel1  :  String
The Facebook custom label 1 value of the product.
customLabel2  :  String
The Facebook custom label 2 value of the product.
customLabel3  :  String
The Facebook custom label 3 value of the product.
customLabel4  :  String
The Facebook custom label 4 value of the product.
description  :  String
The description of the Facebook product.
expirationDate  :  Date
The Facebook expiration date of the product. If the product is expired it will not be shown.
gender  :  String
The gender for the Facebook product.
googleProductCategory  :  String
The category of this product in the Google category taxonomy. If the value is longer than 250 characters it is truncated.
gtin  :  String
The Facebook GTIN of the product.
ID  :  String  (Read Only)
The ID of the Facebook product. This is the same as the ID of the Demandware product.
imageLinks  :  List
A list containing the URLs of the images to show in Facebook for the product.
itemGroupID  :  String
The ID of the Facebook item group for the product, that is, its master product.
link  :  URL
The URL of the Demandware storefront link to the product.
material  :  String
The Facebook material value label of the product.
mpn  :  String
The Facebook MPN of the product.
pattern  :  String
The Facebook pattern value label of the product.
price  :  Money
The price to show in Facebook for the product.
productType  :  String
The Facebook product type. This is the retailer-defined category of the item.
salePrice  :  Money
The sale price to show in Facebook for the product.
salePriceEffectiveDateEnd  :  Date
The end date of the Facebook sale price of the product.
salePriceEffectiveDateStart  :  Date
The start date of the Facebook sale price of the product.
shippingHeight  :  Number
The shipping height of the product.
shippingLength  :  Number
The shipping length of the product.
shippingSizeUnit  :  String
The shipping size unit of the product.
shippingWeight  :  Quantity
The shipping weight for the product.
shippingWidth  :  Number
The shipping width of the product.
size  :  String
The Facebook size value label of the product.
title  :  String
The title of the Facebook product.
Constructor Summary
This class does not have a constructor, so you cannot create it directly.
Method Summary
getAgeGroup() : String
Returns the age group for the Facebook product.
getAvailability() : String
Returns the availability of the Facebook product.
getBrand() : String
Returns the Facebook brand of the product.
getColor() : String
Returns the Facebook color value label of the product.
getCondition() : String
Returns the condition of the Facebook product.
getCustomLabel0() : String
Returns the Facebook custom label 0 value of the product.
getCustomLabel1() : String
Returns the Facebook custom label 1 value of the product.
getCustomLabel2() : String
Returns the Facebook custom label 2 value of the product.
getCustomLabel3() : String
Returns the Facebook custom label 3 value of the product.
getCustomLabel4() : String
Returns the Facebook custom label 4 value of the product.
getDescription() : String
Returns the description of the Facebook product.
getExpirationDate() : Date
Returns the Facebook expiration date of the product.
getGender() : String
Returns the gender for the Facebook product.
getGoogleProductCategory() : String
Returns the category of this product in the Google category taxonomy.
getGtin() : String
Returns the Facebook GTIN of the product.
getID() : String
Returns the ID of the Facebook product.
getImageLinks() : List
Returns a list containing the URLs of the images to show in Facebook for the product.
getItemGroupID() : String
Returns the ID of the Facebook item group for the product, that is, its master product.
getLink() : URL
Returns the URL of the Demandware storefront link to the product.
getMaterial() : String
Returns the Facebook material value label of the product.
getMpn() : String
Returns the Facebook MPN of the product.
getPattern() : String
Returns the Facebook pattern value label of the product.
getPrice() : Money
Returns the price to show in Facebook for the product.
getProductType() : String
Returns the Facebook product type.
getSalePrice() : Money
Returns the sale price to show in Facebook for the product.
getSalePriceEffectiveDateEnd() : Date
Returns the end date of the Facebook sale price of the product.
getSalePriceEffectiveDateStart() : Date
Returns the start date of the Facebook sale price of the product.
getShippingHeight() : Number
Returns the shipping height of the product.
getShippingLength() : Number
Returns the shipping length of the product.
getShippingSizeUnit() : String
Returns the shipping size unit of the product.
getShippingWeight() : Quantity
Returns the shipping weight for the product.
getShippingWidth() : Number
Returns the shipping width of the product.
getSize() : String
Returns the Facebook size value label of the product.
getTitle() : String
Returns the title of the Facebook product.
setAgeGroup(ageGroup : String) : void
Sets the age group for the Facebook product.
setAvailability(availability : String) : void
Sets the availability of the Facebook product.
setBrand(brand : String) : void
Sets the Facebook brand of the product.
setColor(color : String) : void
Sets the Facebook color value label of the product.
setCondition(condition : String) : void
Sets the condition of the Facebook product.
setCustomLabel0(customLabel0 : String) : void
Sets the Facebook custom label 0 value of the product.
setCustomLabel1(customLabel1 : String) : void
Sets the Facebook custom label 1 value of the product.
setCustomLabel2(customLabel2 : String) : void
Sets the Facebook custom label 2 value of the product.
setCustomLabel3(customLabel3 : String) : void
Sets the Facebook custom label 3 value of the product.
setCustomLabel4(customLabel4 : String) : void
Sets the Facebook custom label 4 value of the product.
setDescription(description : String) : void
Sets the description of the Facebook product.
setExpirationDate(expirationDate : Date) : void
Sets the Facebook expiration date of the product.
setGender(gender : String) : void
Sets the gender for the Facebook product.
setGoogleProductCategory(googleProductCategory : String) : void
Sets the category of this product in the Google category taxonomy.
setGtin(gtin : String) : void
Sets the Facebook GTIN of the product.
setImageLinks(imageLinks : List) : void
Sets the list of URLs of images to show in Facebook for the product.
setItemGroupID(itemGroupID : String) : void
Sets the ID of the Facebook item group for the product, that is, its master product.
setLink(link : URL) : void
Sets the URL of the Demandware storefront link to the product.
setMaterial(material : String) : void
Sets the Facebook material value label of the product.
setMpn(mpn : String) : void
Sets the Facebook MPN of the product.
setPattern(pattern : String) : void
Sets the Facebook pattern value label of the product.
setPrice(price : Money) : void
Sets the price to show in Facebook for the product.
setProductType(productType : String) : void
Sets the Facebook product type.
setSalePrice(salePrice : Money) : void
Sets the sale price to show in Facebook for the product.
setSalePriceEffectiveDateEnd(salePriceEffectiveDateEnd : Date) : void
Sets the end date of the Facebook sale price of the product.
setSalePriceEffectiveDateStart(salePriceEffectiveDateStart : Date) : void
Sets the start date of the Facebook sale price of the product.
setShippingHeight(shippingHeight : Number) : void
Sets the shipping height of the product.
setShippingLength(shippingLength : Number) : void
Sets the shipping length of the product.
setShippingSizeUnit(shippingSizeUnit : String) : void
Sets the shipping size unit of the product.
setShippingWeight(shippingWeight : Quantity) : void
Sets the shipping weight for the product.
setShippingWidth(shippingWidth : Number) : void
Sets the shipping width of the product.
setSize(size : String) : void
Sets the Facebook size value label of the product.
setTitle(title : String) : void
Sets the title of the Facebook product.
Methods inherited from class Object
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
Method Detail
getAgeGroup
getAgeGroup() : String
Returns the age group for the Facebook product.
Returns:
product age group
getAvailability
getAvailability() : String
Returns the availability of the Facebook product.
Returns:
product availability
getBrand
getBrand() : String
Returns the Facebook brand of the product.
Returns:
the brand
getColor
getColor() : String
Returns the Facebook color value label of the product.
Returns:
the color value label
getCondition
getCondition() : String
Returns the condition of the Facebook product.
Returns:
product condition
getCustomLabel0
getCustomLabel0() : String
Returns the Facebook custom label 0 value of the product.
Returns:
the custom label 0 value
getCustomLabel1
getCustomLabel1() : String
Returns the Facebook custom label 1 value of the product.
Returns:
the custom label 1 value
getCustomLabel2
getCustomLabel2() : String
Returns the Facebook custom label 2 value of the product.
Returns:
the custom label 2 value
getCustomLabel3
getCustomLabel3() : String
Returns the Facebook custom label 3 value of the product.
Returns:
the custom label 3 value
getCustomLabel4
getCustomLabel4() : String
Returns the Facebook custom label 4 value of the product.
Returns:
the custom label 4 value
getDescription
getDescription() : String
Returns the description of the Facebook product.
Returns:
product description
getExpirationDate
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
getGender() : String
Returns the gender for the Facebook product.
Returns:
product gender
getGoogleProductCategory
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
getGtin() : String
Returns the Facebook GTIN of the product.
Returns:
the GTIN
getID
getID() : String
Returns the ID of the Facebook product. This is the same as the ID of the Demandware product.
Returns:
product ID
getImageLinks
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
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
getLink() : URL
Returns the URL of the Demandware storefront link to the product.
Returns:
the URL of the storefront link
getMaterial
getMaterial() : String
Returns the Facebook material value label of the product.
Returns:
the material value label
getMpn
getMpn() : String
Returns the Facebook MPN of the product.
Returns:
the MPN
getPattern
getPattern() : String
Returns the Facebook pattern value label of the product.
Returns:
the pattern value label
getPrice
getPrice() : Money
Returns the price to show in Facebook for the product.
Returns:
the price to show in Facebook
getProductType
getProductType() : String
Returns the Facebook product type. This is the retailer-defined category of the item.
Returns:
the Facebook product type
getSalePrice
getSalePrice() : Money
Returns the sale price to show in Facebook for the product.
Returns:
the sale price to show in Facebook
getSalePriceEffectiveDateEnd
getSalePriceEffectiveDateEnd() : Date
Returns the end date of the Facebook sale price of the product.
Returns:
the end date of the Facebook sale price
getSalePriceEffectiveDateStart
getSalePriceEffectiveDateStart() : Date
Returns the start date of the Facebook sale price of the product.
Returns:
the start date of the Facebook sale price
getShippingHeight
getShippingHeight() : Number
Returns the shipping height of the product.
Returns:
the shipping height
See Also:
getShippingLength()
getShippingWidth()
getShippingSizeUnit()
getShippingLength
getShippingLength() : Number
Returns the shipping length of the product.
Returns:
the shipping length
See Also:
getShippingWidth()
getShippingHeight()
getShippingSizeUnit()
getShippingSizeUnit
getShippingSizeUnit() : String
Returns the shipping size unit of the product.
Returns:
the shipping size unit
See Also:
getShippingLength()
getShippingWidth()
getShippingHeight()
getShippingWeight
getShippingWeight() : Quantity
Returns the shipping weight for the product.
Returns:
the shipping weight
getShippingWidth
getShippingWidth() : Number
Returns the shipping width of the product.
Returns:
the shipping width
See Also:
getShippingLength()
getShippingHeight()
getShippingSizeUnit()
getSize
getSize() : String
Returns the Facebook size value label of the product.
Returns:
the size value label
getTitle
getTitle() : String
Returns the title of the Facebook product.
Returns:
product title
setAgeGroup
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
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
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
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
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
setCustomLabel0(customLabel0 : String) : void
Sets the Facebook custom label 0 value of the product.
Parameters:
customLabel0 - custom label 0 value
setCustomLabel1
setCustomLabel1(customLabel1 : String) : void
Sets the Facebook custom label 1 value of the product.
Parameters:
customLabel1 - custom label 1 value
setCustomLabel2
setCustomLabel2(customLabel2 : String) : void
Sets the Facebook custom label 2 value of the product.
Parameters:
customLabel2 - custom label 2 value
setCustomLabel3
setCustomLabel3(customLabel3 : String) : void
Sets the Facebook custom label 3 value of the product.
Parameters:
customLabel3 - custom label 3 value
setCustomLabel4
setCustomLabel4(customLabel4 : String) : void
Sets the Facebook custom label 4 value of the product.
Parameters:
customLabel4 - custom label 4 value
setDescription
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
setExpirationDate(expirationDate : Date) : void
Sets the Facebook expiration date of the product.
Parameters:
expirationDate - Facebook expiration date
setGender
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
setGoogleProductCategory(googleProductCategory : String) : void
Sets the category of this product in the Google category taxonomy.
Parameters:
googleProductCategory - Google product category
setGtin
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
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
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
setLink(link : URL) : void
Sets the URL of the Demandware storefront link to the product.
Parameters:
link - Demandware storefront link to the product
setMaterial
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
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
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
setPrice(price : Money) : void
Sets the price to show in Facebook for the product.
Parameters:
price - Facebook price
setProductType
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
setSalePrice(salePrice : Money) : void
Sets the sale price to show in Facebook for the product.
Parameters:
salePrice - Facebook sale price
setSalePriceEffectiveDateEnd
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
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
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(Number)
setShippingWidth(Number)
setShippingSizeUnit(String)
setShippingLength
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:
setShippingWidth(Number)
setShippingHeight(Number)
setShippingSizeUnit(String)
setShippingSizeUnit
setShippingSizeUnit(shippingSizeUnit : String) : void
Sets the shipping size unit of the product.
Parameters:
shippingSizeUnit - shipping size unit
See Also:
setShippingLength(Number)
setShippingWidth(Number)
setShippingHeight(Number)
setShippingWeight
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
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:
setShippingLength(Number)
setShippingHeight(Number)
setShippingSizeUnit(String)
setSize
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
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

Infocenter Retirement: On June 30, 2023, the Infocenter was retired, and documentation currently hosted on the Infocenter will be published to Salesforce Help, Commerce Cloud Developer Center, and Salesforce B2C Commerce Developer Documentation Resources. For more information, see the release note.