CustomData (com.facebook.business.sdk:facebook-java-business-sdk 9.0.0 API)

java.lang.Object
- com.facebook.ads.sdk.serverside.CustomData

```
public class CustomData
extends Object
```
CustomData contains parameters to send additional data we can use for ads delivery optimization.

Constructor Summary

Constructors
Constructor and Description
`CustomData()` Default Constructor.
`CustomData(Float value, String currency, String contentName, String contentCategory, List<String> contentIds, List<Content> contents, String contentType, String orderId, Float predictedLtv, String numItems, String status, String searchString, DeliveryCategory deliveryCategory, String itemNumber, HashMap<String,String> customProperties)` Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CustomData`	`addContent(Content content)` Add a Content objects that contain the product IDs associated with the event plus information about the products.
`CustomData`	`contentCategory(String contentCategory)` Set category of the content associated with the event.
`CustomData`	`contentIds(List<String> contentIds)` Set content IDs associated with the event, such as product SKUs for items in an AddToCart event: [ABC123, XYZ789].
`CustomData`	`contentName(String contentName)` Set name of the page or product associated with the event.
`CustomData`	`contents(List<Content> contents)` Set a list of Content objects that contain the product IDs associated with the event plus information about the products.
`CustomData`	`contentType(String contentType)` Set a String equal to either product or product_group.
`CustomData`	`currency(String currency)` Set currency code for the value specified, if applicable.
`CustomData`	`customProperties(HashMap<String,String> customProperties)` Sets the custom properties to be included in the Custom Data.
`CustomData`	`deliveryCategory(DeliveryCategory deliveryCategory)` Set a Type of delivery for a purchase event.
`boolean`	`equals(Object o)`
`String`	`getContentCategory()` The category of the content associated with the event.
`List<String>`	`getContentIds()` The content IDs associated with the event, such as product SKUs for items in an AddToCart event: [ABC123, XYZ789].
`String`	`getContentName()` The name of the page or product associated with the event.
`List<Content>`	`getContents()` A list of Content objects that contain the product IDs associated with the event plus information about the products.
`String`	`getContentType()` A String equal to either product or product_group.
`String`	`getCurrency()` The currency code for the value specified, if applicable.
`HashMap<String,String>`	`getCustomProperties()` Gets the custom properties to be included in the Custom Data.
`DeliveryCategory`	`getDeliveryCategory()` Type of delivery for a purchase event.
`String`	`getItemNumber()` Get the item number
`String`	`getNumItems()` The number of items that a user tries to buy during checkout.
`String`	`getOrderId()` The order ID for this transaction as a String.
`Float`	`getPredictedLtv()` The predicted lifetime value of a conversion event, as a String.
`String`	`getSearchString()` A search query made by a use.
`String`	`getStatus()` The status of the registration event, as a String.
`Float`	`getValue()` A numeric value associated with this event.
`int`	`hashCode()`
`CustomData`	`itemNumber(String itemNumber)` Set the item number
`CustomData`	`numItems(String numItems)` Set number of items that a user tries to buy during checkout.
`CustomData`	`orderId(String orderId)` Set order ID for this transaction as a String.
`CustomData`	`predictedLtv(Float predictedLtv)` Set predicted lifetime value of a conversion event, as a String.
`CustomData`	`searchString(String searchString)` Set a search query made by a use.
`void`	`setContentCategory(String contentCategory)` Set category of the content associated with the event.
`void`	`setContentIds(List<String> contentIds)` Set content IDs associated with the event, such as product SKUs for items in an AddToCart event: [ABC123, XYZ789].
`void`	`setContentName(String contentName)` Set name of the page or product associated with the event.
`void`	`setContents(List<Content> contents)` Set a list of Content objects that contain the product IDs associated with the event plus information about the products.
`void`	`setContentType(String contentType)` Set a String equal to either product or product_group.
`void`	`setCurrency(String currency)` Set currency code for the value specified, if applicable.
`void`	`setCustomProperties(HashMap<String,String> customProperties)` Sets the custom properties to be included in the Custom Data.
`void`	`setDeliveryCategory(DeliveryCategory deliveryCategory)` Set a Type of delivery for a purchase event.
`void`	`setItemNumber(String itemNumber)` Set the item number
`void`	`setNumItems(String numItems)` Set number of items that a user tries to buy during checkout.
`void`	`setOrderId(String orderId)` Set order ID for this transaction as a String.
`void`	`setPredictedLtv(Float predictedLtv)` Set predicted lifetime value of a conversion event, as a String.
`void`	`setSearchString(String searchString)` Set a search query made by a use.
`void`	`setStatus(String status)` Set status of the registration event, as a String.
`void`	`setValue(Float value)` Set a numeric value associated with this event.
`CustomData`	`status(String status)` Set status of the registration event, as a String.
`String`	`toString()`
`CustomData`	`value(Float value)` Set a numeric value associated with this event.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CustomData
```
public CustomData()
```
    Default Constructor.
  - CustomData
```
public CustomData(Float value,
                  String currency,
                  String contentName,
                  String contentCategory,
                  List<String> contentIds,
                  List<Content> contents,
                  String contentType,
                  String orderId,
                  Float predictedLtv,
                  String numItems,
                  String status,
                  String searchString,
                  DeliveryCategory deliveryCategory,
                  String itemNumber,
                  HashMap<String,String> customProperties)
```
    Constructor.
    
    Parameters:
    
    value - a numeric value associated with this event
    
    currency - currency code for the value specified
    
    contentName - name of the page or product associated with the event
    
    contentCategory - category of the content associated with the event
    
    contentIds - content IDs associated with the event, such as product SKUs for items in an AddToCart
    
    contents - list of Content objects that contain the product info
    
    contentType - either 'product' or 'product_group'
    
    orderId - order ID for this transaction
    
    predictedLtv - predicted lifetime value of a conversion event
    
    numItems - number of items that a user tries to buy during checkout
    
    status - status of the registration event
    
    searchString - a search query made by a user
    
    deliveryCategory - type of delivery for a purchase event.
    
    itemNumber - the item number
    
    customProperties - Custom Properties to be added to the Custom Data
- Method Detail
  - value
```
public CustomData value(Float value)
```
    Set a numeric value associated with this event. This could be a monetary value or a value in some other metric.
    Example: 142.54.
    
    Parameters:
    
    value - a numeric value associated with this event
    
    Returns:
    
    CustomData
  - getValue
```
public Float getValue()
```
    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)
```
    Set a numeric value associated with this event. This could be a monetary value or a value in some other metric.
    Example: 142.54.
    
    Parameters:
    
    value - a numeric value associated with this event
  - currency
```
public CustomData currency(String currency)
```
    Set currency code for the value specified, if applicable. Currency must be a valid ISO 4217 three digit currency code.
    
    Parameters:
    
    currency - currency code for the value specified
    
    Returns:
    
    CustomData
  - getCurrency
```
public String getCurrency()
```
    The currency code for the value specified, if applicable. Currency must be a valid ISO 4217 three digit currency code.
    
    Returns:
    
    currency
  - setCurrency
```
public void setCurrency(String currency)
```
    Set currency code for the value specified, if applicable. Currency must be a valid ISO 4217 three digit currency code.
    
    Parameters:
    
    currency - currency code for the value specified
  - contentName
```
public CustomData contentName(String contentName)
```
    Set name of the page or product associated with the event.
    Example: lettuce.
    
    Parameters:
    
    contentName - name of the page or product associated with the event
    
    Returns:
    
    CustomData
  - getContentName
```
public String getContentName()
```
    The name of the page or product associated with the event.
    Example: lettuce.
    
    Returns:
    
    contentName
  - setContentName
```
public void setContentName(String contentName)
```
    Set name of the page or product associated with the event.
    Example: lettuce.
    
    Parameters:
    
    contentName - name of the page or product associated with the event
  - contentCategory
```
public CustomData contentCategory(String contentCategory)
```
    Set category of the content associated with the event.
    Example: grocery
    
    Parameters:
    
    contentCategory - category of the content associated with the event.
    
    Returns:
    
    CustomData
  - getContentCategory
```
public String getContentCategory()
```
    The category of the content associated with the event.
    Example: grocery
    
    Returns:
    
    contentCategory
  - setContentCategory
```
public void setContentCategory(String contentCategory)
```
    Set category of the content associated with the event.
    Example: grocery
    
    Parameters:
    
    contentCategory - category of the content associated with the event.
  - contentIds
```
public CustomData contentIds(List<String> contentIds)
```
    Set content IDs associated with the event, such as product SKUs for items in an AddToCart event: [ABC123, XYZ789]. If content_type is a product, then your content IDs must be an array with a single string value. Otherwise, this array can contain any number of string values.
    
    Parameters:
    
    contentIds - content IDs associated with the event
    
    Returns:
    
    CustomData
  - getContentIds
```
public List<String> getContentIds()
```
    The content IDs associated with the event, such as product SKUs for items in an AddToCart event: [ABC123, XYZ789]. If content_type is a product, then your content IDs must be an array with a single string value. Otherwise, this array can contain any number of string values.
    
    Returns:
    
    contentIds
  - setContentIds
```
public void setContentIds(List<String> contentIds)
```
    Set content IDs associated with the event, such as product SKUs for items in an AddToCart event: [ABC123, XYZ789]. If content_type is a product, then your content IDs must be an array with a single string value. Otherwise, this array can contain any number of string values.
    
    Parameters:
    
    contentIds - content IDs associated with the event
  - contents
```
public CustomData contents(List<Content> contents)
```
    Set a list of Content objects that contain the product IDs associated with the event plus information about the products. id, quantity, and item_price are available fields.
    Example: [{id:ABC123,quantity :2,item_price:5.99}, {id:XYZ789,quantity:2, item_price:9.99}]
    
    Parameters:
    
    contents - list of Content objects that contain the products associated with the event
    
    Returns:
    
    CustomData
  - addContent
```
public CustomData addContent(Content content)
```
    Add a Content objects that contain the product IDs associated with the event plus information about the products. id, quantity, and item_price are available fields.
    Example: {id:ABC123,quantity :2,item_price:5.99}
    
    Parameters:
    
    content - Content objects that contain the product associated with the event
    
    Returns:
    
    CustomData
  - getContents
```
public List<Content> getContents()
```
    A list of Content objects that contain the product IDs associated with the event plus information about the products. id, quantity, and item_price are available fields.
    Example: [{id:ABC123,quantity :2,item_price:5.99}, {id:XYZ789,quantity:2, item_price:9.99}]
    
    Returns:
    
    contents
  - setContents
```
public void setContents(List<Content> contents)
```
    Set a list of Content objects that contain the product IDs associated with the event plus information about the products. id, quantity, and item_price are available fields.
    Example: [{id:ABC123,quantity :2,item_price:5.99}, {id:XYZ789,quantity:2, item_price:9.99}]
    
    Parameters:
    
    contents - list of Content objects that contain the products associated with the event
  - contentType
```
public CustomData contentType(String contentType)
```
    Set a String equal to either product or product_group. Set to product if the keys you send content_ids or contents represent products. Set to product_group if the keys you send in content_ids represent product groups.
    
    Parameters:
    
    contentType - product or product_group
    
    Returns:
    
    CustomData
  - getContentType
```
public String getContentType()
```
    A String equal to either product or product_group. Set to product if the keys you send content_ids or contents represent products. Set to product_group if the keys you send in content_ids represent product groups.
    
    Returns:
    
    contentType
  - setContentType
```
public void setContentType(String contentType)
```
    Set a String equal to either product or product_group. Set to product if the keys you send content_ids or contents represent products. Set to product_group if the keys you send in content_ids represent product groups.
    
    Parameters:
    
    contentType - product or product_group
  - orderId
```
public CustomData orderId(String orderId)
```
    Set order ID for this transaction as a String.
    Example: order1234.
    
    Parameters:
    
    orderId - order ID for this transaction
    
    Returns:
    
    CustomData
  - getOrderId
```
public String getOrderId()
```
    The order ID for this transaction as a String.
    Example: order1234.
    
    Returns:
    
    orderId
  - setOrderId
```
public void setOrderId(String orderId)
```
    Set order ID for this transaction as a String.
    Example: order1234.
    
    Parameters:
    
    orderId - order ID for this transaction
  - predictedLtv
```
public CustomData predictedLtv(Float predictedLtv)
```
    Set predicted lifetime value of a conversion event, as a String.
    Example: 432.12.
    
    Parameters:
    
    predictedLtv - predicted lifetime value of a conversion event
    
    Returns:
    
    CustomData
  - getPredictedLtv
```
public Float getPredictedLtv()
```
    The predicted lifetime value of a conversion event, as a String.
    Example: 432.12.
    
    Returns:
    
    predictedLtv
  - setPredictedLtv
```
public void setPredictedLtv(Float predictedLtv)
```
    Set predicted lifetime value of a conversion event, as a String.
    Example: 432.12.
    
    Parameters:
    
    predictedLtv - predicted lifetime value of a conversion event
  - numItems
```
public CustomData numItems(String numItems)
```
    Set number of items that a user tries to buy during checkout. Use only with InitiateCheckout events.
    
    Parameters:
    
    numItems - number of items that a user tries to buy during checkout
    
    Returns:
    
    CustomData
  - getNumItems
```
public String getNumItems()
```
    The number of items that a user tries to buy during checkout. Use only with InitiateCheckout events.
    
    Returns:
    
    numItems
  - setNumItems
```
public void setNumItems(String numItems)
```
    Set number of items that a user tries to buy during checkout. Use only with InitiateCheckout events.
    
    Parameters:
    
    numItems - number of items that a user tries to buy during checkout
  - status
```
public CustomData status(String status)
```
    Set status of the registration event, as a String. Use only with CompleteRegistration events.
    
    Parameters:
    
    status - status of the registration event
    
    Returns:
    
    CustomData
  - getStatus
```
public String getStatus()
```
    The status of the registration event, as a String. Use only with CompleteRegistration events.
    
    Returns:
    
    status
  - setStatus
```
public void setStatus(String status)
```
    Set status of the registration event, as a String. Use only with CompleteRegistration events.
    
    Parameters:
    
    status - status of the registration event
  - getSearchString
```
public String getSearchString()
```
    A search query made by a use. Use only with Search events. Example: 'lettuce'.
    
    Returns:
    
    searchString
  - setSearchString
```
public void setSearchString(String searchString)
```
    Set a search query made by a use. Use only with Search events.
    
    Parameters:
    
    searchString - a search query made by a use
  - searchString
```
public CustomData searchString(String searchString)
```
    Set a search query made by a use. Use only with Search events.
    
    Parameters:
    
    searchString - a search query made by a use
    
    Returns:
    
    CustomData
  - getDeliveryCategory
```
public DeliveryCategory getDeliveryCategory()
```
    Type of delivery for a purchase event. Example: in_store.
    
    Returns:
    
    deliveryCategory
  - setDeliveryCategory
```
public void setDeliveryCategory(DeliveryCategory deliveryCategory)
```
    Set a Type of delivery for a purchase event.
    
    Parameters:
    
    deliveryCategory - type of delivery
  - deliveryCategory
```
public CustomData deliveryCategory(DeliveryCategory deliveryCategory)
```
    Set a Type of delivery for a purchase event.
    
    Parameters:
    
    deliveryCategory - type of delivery
    
    Returns:
    
    CustomData
  - itemNumber
```
public CustomData itemNumber(String itemNumber)
```
    Set the item number
    
    Parameters:
    
    itemNumber - Item number
    
    Returns:
    
    CustomData
  - getItemNumber
```
public String getItemNumber()
```
    Get the item number
    
    Returns:
    
    itemNumber
  - setItemNumber
```
public void setItemNumber(String itemNumber)
```
    Set the item number
    
    Parameters:
    
    itemNumber - Item number
  - getCustomProperties
```
public HashMap<String,String> getCustomProperties()
```
    Gets the custom properties to be included in the Custom Data. If our predefined object properties don't suit your needs, you can include your own, custom properties. Custom properties can be used with both standard and custom events, and can help you further define custom audiences. This behavior is the same for Server-Side API and Facebook Pixel. See (https://developers.facebook.com/docs/marketing-api/server-side-api/parameters/custom-data#custom-properties) Eg: '{ 'warehouse_location' : 'washington', 'package_size' : 'L'}'
    
    Returns:
    
    customProperties
  - setCustomProperties
```
public void setCustomProperties(HashMap<String,String> customProperties)
```
    Sets the custom properties to be included in the Custom Data.
    
    Parameters:
    
    customProperties - custom properties property bag to be included in the Custom Data. Eg: '{ 'warehouse_location' : 'washington', 'package_size' : 'L'}'
  - customProperties
```
public CustomData customProperties(HashMap<String,String> customProperties)
```
    Sets the custom properties to be included in the Custom Data.
    
    Parameters:
    
    customProperties - custom properties property bag to be included in the Custom Data. Eg: '{ 'warehouse_location' : 'washington', 'package_size' : 'L'}'
    
    Returns:
    
    CustomData
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class CustomData

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CustomData

CustomData

Method Detail

value

getValue

setValue

currency

getCurrency

setCurrency

contentName

getContentName

setContentName

contentCategory

getContentCategory

setContentCategory

contentIds

getContentIds

setContentIds

contents

addContent

getContents

setContents

contentType

getContentType

setContentType

orderId

getOrderId

setOrderId

predictedLtv

getPredictedLtv

setPredictedLtv

numItems

getNumItems

setNumItems

status

getStatus

setStatus

getSearchString

setSearchString

searchString

getDeliveryCategory

setDeliveryCategory

deliveryCategory

itemNumber

getItemNumber

setItemNumber

getCustomProperties

setCustomProperties

customProperties

equals

hashCode

toString