com.facebook.ads.sdk.signal

Class Content

java.lang.Object

com.facebook.ads.sdk.signal.Content

public class Content
extends Object

Constructor Summary

Constructors

Constructor and Description
Content() Default Constructor.
Content(String id, Long quantity, Float price, Float itemPrice, String title, String description, String brand, String category, DeliveryCategory deliveryCategory, Float tax, String externalContentId)

Method Summary

Modifier and Type	Method and Description
Content	brand(String brand) Sets the Brand of the Product.
Content	category(String category) Sets the Category of the Product.
Content	deliveryCategory(DeliveryCategory deliveryCategory) Sets the type of delivery for a purchase event.
Content	description(String description) Sets the Product Description of the Item.
Content	externalContentId(String externalContentId) Sets the total tax of the Item.
SignalResponse<String,String>	getbrand() Gets the Brand of the listed Item.
Content	getBusinessDataContent() Gets the constructed content for Business Data API
SignalResponse<String,String>	getCategory() Gets the Category of the listed Item.
SignalResponse<DeliveryCategory,DeliveryCategory>	getDeliveryCategory() Gets the delivery category.
SignalResponse<String,String>	getDescription() Gets the Description of the listed Item.
SignalResponse<String,String>	getExternalContentId() Gets the external id for this order item The external id for the products that are being involved in the customer interaction.
SignalResponse<String,String>	getId() Gets the Product Id of the Item.
SignalResponse<Float,Float>	getItemPrice() Gets the item price for the Product.
SignalResponse<Float,Float>	getPrice() Gets the total price of the Item.
SignalResponse<Long,Long>	getQuantity() Gets the quantity of the Item.
Content	getServerSideContent() Gets the constructed content for Conversion API
SignalResponse<Float,Float>	getTax() Gets the total tax of the Item.
SignalResponse<String,String>	getTitle() Gets the Title of the listed Item.
Content	id(String id) Sets the Product Id of the Item.
Content	itemPrice(Float itemPrice) Sets the item price for the Content.
Content	price(Float price) Sets the total price of the Item.
Content	quantity(Long quantity) Sets the quantity of the Content/Item.
void	setbrand(String brand) Sets the Brand of the listed Item.
void	setCategory(String category) Sets the Category of the listed Item.
void	setdeliverycategory(DeliveryCategory deliveryCategory) Sets the type of delivery for a purchase event.
void	setDescription(String description) Sets the Description of the listed Item.
void	setExternalcontentid(String externalContentId) Sets the external id for this order item
void	setId(String id) Sets the Product Id of the Item.
void	setItemPrice(Float itemPrice) Sets the item price for the Content.
void	setPrice(Float price) Sets the total price of the Item.
void	setQuantity(Long quantity) Sets the quantity of the Item.
void	setTax(Float tax) Sets the total tax of the Item.
void	setTitle(String title) Sets the Title of the listed Item.
Content	tax(Float tax) Sets the total tax of the Item.
Content	title(String title) Sets the Title of the Item.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Content

public Content()

Default Constructor.

Content

public Content(String id,
               Long quantity,
               Float price,
               Float itemPrice,
               String title,
               String description,
               String brand,
               String category,
               DeliveryCategory deliveryCategory,
               Float tax,
               String externalContentId)

Parameters:

id - Product Id of the Item.

quantity - Quantity of the Item.

price - Subtotal for the content/product.

itemPrice - Price per unit of the content/product.

title - Title of the listed Item.

description - Product description used for the item.

brand - Brand of the item.

category - Category of the Item.

deliveryCategory - The type of delivery for a purchase event

tax - Subtotal tax for the content/product.

externalContentId - Unique ID for the contents/products that are being involved in the customer interaction.

Method Detail

getId

public SignalResponse<String,String> getId()

Gets the Product Id of the Item. A string representing the unique Id for the product. Example: XYZ.

Returns:

id

setId

public void setId(String id)

Sets the Product Id of the Item.

Parameters:

id - A string representing the unique Id for the product. Example: XYZ.

id

public Content id(String id)

Sets the Product Id of the Item.

Parameters:

id - is a string representing the unique id for the product. Example: XYZ.

Returns:

Content

getQuantity

public SignalResponse<Long,Long> getQuantity()

Gets the quantity of the Item. The number/quantity of the content that is being involved in the customer interaction. Example: 5

Returns:

quantity

setQuantity

public void setQuantity(Long quantity)

Sets the quantity of the Item.

Parameters:

quantity - The number/quantity of the product that is being involved in the customer interaction. Example: 5

quantity

public Content quantity(Long quantity)

Sets the quantity of the Content/Item.

Parameters:

quantity - The number/quantity of the product that is being involved in the customer interaction. Example: 5

Returns:

Content

getItemPrice

public SignalResponse<Float,Float> getItemPrice()

Gets the item price for the Product. The item price or price per unit of the product. Example: '123.45'

Returns:

itemPrice

setItemPrice

public void setItemPrice(Float itemPrice)

Sets the item price for the Content.

Parameters:

itemPrice - The item price or price per unit of the product. Example: '123.45'

itemPrice

public Content itemPrice(Float itemPrice)

Sets the item price for the Content.

Parameters:

itemPrice - The item price or price per unit of the product. Example: '123.45'

Returns:

Content

getTitle

public SignalResponse<String,String> getTitle()

Gets the Title of the listed Item. A string representing the Title for the product.

Returns:

title

setTitle

public void setTitle(String title)

Sets the Title of the listed Item.

Parameters:

title - A string representing the Title for the product.

title

public Content title(String title)

Sets the Title of the Item.

Parameters:

title - is a string representing listed title for the product.

Returns:

Content

getDescription

public SignalResponse<String,String> getDescription()

Gets the Description of the listed Item. A string representing the Description for the product.

Returns:

description

setDescription

public void setDescription(String description)

Sets the Description of the listed Item.

Parameters:

description - A string representing the Description for the product.

description

public Content description(String description)

Sets the Product Description of the Item.

Parameters:

description - is a string representing the description for the product.

Returns:

Content

getbrand

public SignalResponse<String,String> getbrand()

Gets the Brand of the listed Item. A string representing the Brand for the product.

Returns:

brand

setbrand

public void setbrand(String brand)

Sets the Brand of the listed Item.

Parameters:

brand - A string representing the Brand for the product.

brand

public Content brand(String brand)

Sets the Brand of the Product.

Parameters:

brand - is a string representing the Brand for the product.

Returns:

Content

getCategory

public SignalResponse<String,String> getCategory()

Gets the Category of the listed Item. A string representing the Category for the product.

Returns:

Category

setCategory

public void setCategory(String category)

Sets the Category of the listed Item.

Parameters:

category - A string representing the Category for the product.

category

public Content category(String category)

Sets the Category of the Product.

Parameters:

category - is a string representing the Category for the product.

Returns:

Content

getDeliveryCategory

public SignalResponse<DeliveryCategory,DeliveryCategory> getDeliveryCategory()

Gets the delivery category.

Returns:

DeliveryCategory

setdeliverycategory

public void setdeliverycategory(DeliveryCategory deliveryCategory)

Sets the type of delivery for a purchase event.

Parameters:

deliveryCategory - The delivery category.

deliveryCategory

public Content deliveryCategory(DeliveryCategory deliveryCategory)

Sets the type of delivery for a purchase event.

Parameters:

deliveryCategory - The delivery category.

Returns:

Content

getTax

public SignalResponse<Float,Float> getTax()

Gets the total tax of the Item. The total tax for the products that are being involved in the customer interaction. Example: 45.5

Returns:

Tax

setTax

public void setTax(Float tax)

Sets the total tax of the Item.

Parameters:

tax - The total tax for the products that are being involved in the customer interaction. Example: 45.5

tax

public Content tax(Float tax)

Sets the total tax of the Item.

Parameters:

tax - The total tax for the products that are being involved in the customer interaction. Example: 45.5

Returns:

Content

getExternalContentId

public SignalResponse<String,String> getExternalContentId()

Gets the external id for this order item The external id for the products that are being involved in the customer interaction.

Returns:

ExternalContentId

setExternalcontentid

public void setExternalcontentid(String externalContentId)

Sets the external id for this order item

Parameters:

externalContentId - The external id for the products that are being involved in the customer interaction.

externalContentId

public Content externalContentId(String externalContentId)

Sets the total tax of the Item.

Parameters:

externalContentId - The total tax for the products that are being involved in the customer interaction.

Returns:

Content

getPrice

public SignalResponse<Float,Float> getPrice()

Gets the total price of the Item. The total price for the products that are being involved in the customer interaction. Example: '123.45'

Returns:

Price

setPrice

public void setPrice(Float price)

Sets the total price of the Item.

Parameters:

price - The total price for the products that are being involved in the customer interaction. Example: '123.45'

price

public Content price(Float price)

Sets the total price of the Item.

Parameters:

price - The total price for the products that are being involved in the customer interaction. Example: '123.45'

Returns:

Content

getBusinessDataContent

public Content getBusinessDataContent()

Gets the constructed content for Business Data API

Returns:

businessDataContent

getServerSideContent

public Content getServerSideContent()

Gets the constructed content for Conversion API

Returns:

serverSideContent