com.facebook.ads.sdk.businessdataapi

Class CustomData

java.lang.Object

com.facebook.ads.sdk.businessdataapi.CustomData

public class CustomData
extends Object

Constructor Summary

Constructors

Constructor and Description
CustomData() Default Constructor.
CustomData(Float value, String currency, List<Content> contents, String orderId, String status, UserData shippingContact, UserData billingContact, String externalOrderId, String originalOrderId, String message)

Method Summary

Modifier and Type	Method and Description
CustomData	billingContact(UserData billingContact) Sets the billing contact of the order.
CustomData	contents(List<Content> contents) Sets the contents for the custom data.
CustomData	currency(String currency) Sets the currency for the custom data.
CustomData	externalOrderId(String externalOrderId) Sets the unique id of the order.
UserData	getBillingContact() Gets the billing contact of the order.
List<Content>	getContents() Gets the contents for the custom data.
String	getCurrency() Gets the currency for the custom data.
String	getExternalOrderId() Gets the unique id of the order.
String	getMessage() Gets the unique id of the original order.
String	getOrderId() Gets the order id for the custom data.
String	getOriginalOrderId() Gets the unique id of the original order.
UserData	getShippingContact() Gets the shipping contact of the order.
String	getStatus() Gets the status of order.
Float	getValue() Gets the total value of the order.
CustomData	message(String message) Sets the unique id of the original order.
CustomData	orderId(String orderId) Sets the order_id for the custom data.
CustomData	originalOrderId(String originalOrderId) Sets the unique id of the original order.
void	setBillingContact(UserData billingContact) Sets the billing contact of the order.
void	setContents(List<Content> contents) Sets the contents for the custom data.
void	setCurrency(String currency) Sets the currency for the custom data.
void	setExternalOrderId(String externalOrderId) Sets the unique id of the order.
void	setMessage(String message) Sets the unique id of the original order.
void	setOrderId(String orderId) Sets the order_id for the custom data.
void	setOriginalOrderId(String originalOrderId) Sets the unique id of the original order.
void	setShippingContact(UserData shippingContact) Sets the shipping contact of the order.
void	setStatus(String status) Gets the status of order.
void	setValue(Float value) Sets the value of the custom data.
CustomData	shippingContact(UserData shippingContact) Sets the shipping contact of the order.
CustomData	status(String status) Sets the status of the registration event.
CustomData	value(Float value) Sets the value of the custom data.

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomData

public CustomData()

Default Constructor.

CustomData

public CustomData(Float value,
                  String currency,
                  List<Content> contents,
                  String orderId,
                  String status,
                  UserData shippingContact,
                  UserData billingContact,
                  String externalOrderId,
                  String originalOrderId,
                  String message)

Parameters:

value - value of the order Eg: 123.45

currency - currency involved in the transaction Eg: usd

contents - Array of Content Objects. Use {Content} class to define a content.

orderId - Unique id representing the order

status - Status of order

shippingContact - Shipping contact information. User {UserData} class to define a contact.

billingContact - Billing contact information. User {UserData} class to define a contact.

externalOrderId - Unique ID representing the order, universal across multiple categories from the business

originalOrderId - Original order id for refund. For Refund event only.

message - Reason for refund. For Refund event only.

Method Detail

getValue

public Float getValue()

Gets the total value of the order. A numeric value associated with this event. This could be a monetary value or a value in some other metric. Example: 142.54.

Returns:

value

setValue

public void setValue(Float value)

Sets the value of the custom data.

Parameters:

value - A numeric value associated with this event. This could be a monetary value or a value in some other metric. Example: 142.54.

value

public CustomData value(Float value)

Sets the value of the custom data.

Parameters:

value - A numeric value associated with this event. This could be a monetary value or a value in some other metric. Example: 142.54.

Returns:

CustomData

getCurrency

public String getCurrency()

Gets the currency for the custom data. The currency for the value specified, if applicable. Currency must be a valid ISO 4217 three digit currency code. Example: 'usd'

Returns:

currency

setCurrency

public void setCurrency(String currency)

Sets the currency for the custom data.

Parameters:

currency - The currency for the value specified, if applicable. Currency must be a valid ISO 4217 three digit currency code. Example: 'usd'

currency

public CustomData currency(String currency)

Sets the currency for the custom data.

Parameters:

currency - The currency for the value specified, if applicable. Currency must be a valid ISO 4217 three digit currency code. Example: 'usd'

Returns:

CustomData

getContents

public List<Content> getContents()

Gets the contents for the custom data. An array of Content objects that contain the product IDs associated with the event plus information about the products. Example: [{'id':'ABC123','quantity' :2,'price':5.99}, {'id':'XYZ789','quantity':2, 'price':9.99}]

Returns:

Contents

setContents

public void setContents(List<Content> contents)

Sets the contents for the custom data.

Parameters:

contents - An array of Content objects that contain the product IDs associated with the event plus information about the products. Example: [{'id':'ABC123','quantity' :2,'price':5.99}, {'id':'XYZ789','quantity':2, 'price':9.99}]

contents

public CustomData contents(List<Content> contents)

Sets the contents for the custom data.

Parameters:

contents - An array of Content objects that contain the product IDs associated with the event plus information about the products. Example: [{'id':'ABC123','quantity' :2,'item_price':5.99}, {'id':'XYZ789','quantity':2, 'item_price':9.99}]

Returns:

CustomData

getOrderId

public String getOrderId()

Gets the order id for the custom data. order_id is the order ID for this transaction as a String. Example: 'order1234'

Returns:

orderId

setOrderId

public void setOrderId(String orderId)

Sets the order_id for the custom data.

Parameters:

orderId - The order ID for this transaction as a String. Example: 'order1234'

orderId

public CustomData orderId(String orderId)

Sets the order_id for the custom data.

Parameters:

orderId - The order ID for this transaction as a String. Example: 'order1234'

Returns:

CustomData

getStatus

public String getStatus()

Gets the status of order. Status of the order, as a String.

Returns:

Status

setStatus

public void setStatus(String status)

Gets the status of order.

Parameters:

status - Status of the order, as a String.

status

public CustomData status(String status)

Sets the status of the registration event.

Parameters:

status - Status of the registration event, as a String.

Returns:

CustomData

getShippingContact

public UserData getShippingContact()

Gets the shipping contact of the order. An Object contains the user data of shipping contact. Use {UserData} to construct the object.

Returns:

shippingContact

setShippingContact

public void setShippingContact(UserData shippingContact)

Sets the shipping contact of the order.

Parameters:

shippingContact - An Object contains the user data of shipping contact. Use {UserData} to construct the object.

shippingContact

public CustomData shippingContact(UserData shippingContact)

Sets the shipping contact of the order.

Parameters:

shippingContact - An Object contains the user data of shipping contact. Use {UserData} to construct the object.

Returns:

CustomData

getBillingContact

public UserData getBillingContact()

Gets the billing contact of the order. An Object contains the user data of billing contact. Use {UserData} to construct the object.

Returns:

billingContact

setBillingContact

public void setBillingContact(UserData billingContact)

Sets the billing contact of the order.

Parameters:

billingContact - An Object contains the user data of billing contact. Use {UserData} to construct the object.

billingContact

public CustomData billingContact(UserData billingContact)

Sets the billing contact of the order.

Parameters:

billingContact - An Object contains the user data of billing contact. Use {UserData} to construct the object.

Returns:

CustomData

getExternalOrderId

public String getExternalOrderId()

Gets the unique id of the order. Unique ID representing the order, universal across multiple categories from the business.

Returns:

externalOrderId

setExternalOrderId

public void setExternalOrderId(String externalOrderId)

Sets the unique id of the order.

Parameters:

externalOrderId - Unique ID representing the order, universal across multiple categories from the business.

externalOrderId

public CustomData externalOrderId(String externalOrderId)

Sets the unique id of the order.

Parameters:

externalOrderId - Unique ID representing the order, universal across multiple categories from the business.

Returns:

CustomData

getOriginalOrderId

public String getOriginalOrderId()

Gets the unique id of the original order. Original order id for refund. For Refund event only.

Returns:

originalOrderId

setOriginalOrderId

public void setOriginalOrderId(String originalOrderId)

Sets the unique id of the original order.

Parameters:

originalOrderId - Original order id for refund. For Refund event only.

originalOrderId

public CustomData originalOrderId(String originalOrderId)

Sets the unique id of the original order.

Parameters:

originalOrderId - Original order id for refund. For Refund event only.

Returns:

CustomData

getMessage

public String getMessage()

Gets the unique id of the original order. Reason for refund. For Refund event only.

Returns:

message

setMessage

public void setMessage(String message)

Sets the unique id of the original order.

Parameters:

message - Reason for refund. For Refund event only.

message

public CustomData message(String message)

Sets the unique id of the original order.

Parameters:

message - Reason for refund. For Refund event only.

Returns:

CustomData