public class CustomData extends Object
| 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,
UserData shippingContact,
UserData billingContact,
String externalOrderId,
String originalOrderId,
String message)
params both Business Data API and Conversion API consume
|
| Modifier and Type | Method and Description |
|---|---|
CustomData |
billingContact(UserData billingContact)
Sets the billingcontact for Purchase/Update Order event.
|
CustomData |
contentCategory(String contentCategory)
Sets the contentcategory for the custom data.
|
CustomData |
contentIds(List<String> contentIds)
Sets the contentids for the custom data.
|
CustomData |
contentName(String contentName)
Sets the content name for the custom data.
|
CustomData |
contents(List<Content> contents)
Sets the contents for the custom data.
|
CustomData |
contentType(String contentType)
Sets the content type for the custom data.
|
CustomData |
currency(String currency)
Sets the currency for the custom data.
|
CustomData |
customProperties(HashMap<String,String> customProperties)
Sets the search string for the custom data.
|
CustomData |
deliveryCategory(DeliveryCategory deliveryCategory)
Sets the type of delivery for a purchase event.
|
CustomData |
externalOrderId(String externalOrderId)
Sets the unique id of the order.
|
SignalResponse<UserData,UserData> |
getBillingContact()
Gets the billingcontact for Purchase/Update Order event.
|
CustomData |
getBusinessDataCustomData()
Gets the constructed custom data for Business Data API
|
SignalResponse<String,String> |
getContentCategory()
Gets the content category for the custom data.
|
SignalResponse<List<String>,List<String>> |
getContentIds()
Gets the contentids for the custom data.
|
SignalResponse<String,String> |
getContentName()
Gets the content name for the custom data.
|
SignalResponse<List<Content>,List<Content>> |
getContents()
Gets the contents for the custom data.
|
SignalResponse<String,String> |
getContentType()
Gets the content type for the custom data.
|
SignalResponse<String,String> |
getCurrency()
Gets the currency for the custom data.
|
SignalResponse<HashMap<String,String>,HashMap<String,String>> |
getCustomProperties()
Gets the custom properties to be included in the Custom Data.
|
SignalResponse<DeliveryCategory,DeliveryCategory> |
getDeliveryCategory()
Gets the delivery category.
|
SignalResponse<String,String> |
getExternalOrderId()
Gets the unique id of the order.
|
SignalResponse<String,String> |
getItemNumber()
Gets the item number.
|
SignalResponse<String,String> |
getMessage()
Gets the unique id of the original order.
|
SignalResponse<String,String> |
getNumItems()
Gets the number of items for the custom data.
|
SignalResponse<String,String> |
getOrderId()
Gets the order id for the custom data.
|
SignalResponse<String,String> |
getOriginalOrderId()
Gets the unique id of the original order.
|
SignalResponse<Float,Float> |
getPredictedLtv()
Gets the predicted LifeTimeValue for the (user) in custom data.
|
SignalResponse<String,String> |
getSearchString()
Gets the search string for the custom data.
|
CustomData |
getServerSideCustomData()
Gets the constructed custom data for Business Data API
|
SignalResponse<UserData,UserData> |
getShippingContact()
Gets the shippingcontact for Purchase/Update Order event.
|
SignalResponse<String,String> |
getStatus()
Status of the registration in Registration event or Status of the order in
Purchase/UpdateOrder event.
|
SignalResponse<Float,Float> |
getValue()
Gets the value of the custom data.
|
CustomData |
itemNumber(String itemNumber)
Sets the item number.
|
CustomData |
message(String message)
Sets the unique id of the original order.
|
CustomData |
numItems(String numItems)
Sets the number of items for the custom data.
|
CustomData |
orderId(String orderId)
Sets the orderid for the custom data.
|
CustomData |
originalOrderId(String originalOrderId)
Sets the unique id of the original order.
|
CustomData |
predictedLtv(Float predictedLtv)
Sets the predicted LifeTimeValue for the custom data.
|
CustomData |
searchString(String searchString)
Sets the search string for the custom data.
|
void |
setBillingContact(UserData billingContact)
Sets the billingcontact for Purchase/Update Order event.
|
void |
setContentCategory(String contentCategory)
Sets the contentcategory for the custom data.
|
void |
setContentIds(List<String> contentIds)
Sets the contentids for the custom data.
|
void |
setContentName(String contentName)
Sets the content name for the custom data.
|
void |
setContents(List<Content> contents)
Sets the contents for the custom data.
|
void |
setContentType(String contentType)
Sets the content type for the custom data.
|
void |
setCurrency(String currency)
Sets the currency for the custom data.
|
void |
setCustomProperties(HashMap<String,String> customProperties)
Sets the custom properties to be included in the Custom Data.
|
void |
setdeliverycategory(DeliveryCategory deliveryCategory)
Sets the type of delivery for a purchase event.
|
void |
setExternalOrderId(String externalOrderId)
Sets the unique id of the order.
|
void |
setItemNumber(String itemNumber)
Sets the item number.
|
void |
setMessage(String message)
Sets the unique id of the original order.
|
void |
setNumItems(String numItems)
Sets the number of items for the custom data.
|
void |
setOrderId(String orderId)
Sets the orderid for the custom data.
|
void |
setOriginalOrderId(String originalOrderId)
Sets the unique id of the original order.
|
void |
setPredictedLtv(Float predictedLtv)
Sets the predicted LifeTimeValue for the custom data.
|
void |
setSearchString(String searchString)
Sets the search string for the custom data.
|
void |
setShippingContact(UserData shippingContact)
Sets the shippingcontact for Purchase/Update Order event.
|
void |
setStatus(String status)
Sets status of the registration in Registration event or status of the order
in Purchase/UpdateOrder event.
|
void |
setValue(Float value)
Sets the value of the custom data.
|
CustomData |
shippingContact(UserData shippingContact)
Sets the shippingcontact for Purchase/Update Order event.
|
CustomData |
status(String status)
Sets status of the registration in Registration event or status of the order
in Purchase/UpdateOrder event.
|
CustomData |
value(Float value)
Sets the value of the custom data.
|
public 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, UserData shippingContact, UserData billingContact, String externalOrderId, String originalOrderId, String message)
value - value of the item Eg: 123.45currency - currency involved in the transaction Eg: usdcontents - Array of Content Objects. Use {Content} class to
define a content.orderId - Unique id representing the orderstatus - Status of the registration in Registration event. Use
only with CompleteRegistration events for Conversion
API. Use only with Purchase or UpdateOrder events for
Business Data API params only Conversion API consumescontentName - name of the Content Eg: lettucecontentCategory - category of the content Eg: grocerycontentIds - list of content unique ids involved in the eventcontentType - Type of the Content group or Product SKUpredictedLtv - Predicted LifeTime Value for the customer involved in
the eventnumItems - Number of items involvedsearchString - query string used for the Search eventitemNumber - The item numberdeliveryCategory - The type of delivery for a purchase eventcustomProperties - Custom Properties to be added to the Custom Data
params only Business Data API consumesshippingContact - 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 businessoriginalOrderId - Original order id for refund. For Refund event only.message - Reason for refund. For Refund event only.public SignalResponse<Float,Float> getValue()
public void setValue(Float value)
value - A numeric value associated with this event. This could be a
monetary value or a value in some other metric. Example: 142.54.public CustomData value(Float value)
value - A numeric value associated with this event. This could be a
monetary value or a value in some other metric. Example: 142.54.public SignalResponse<String,String> getCurrency()
public void setCurrency(String currency)
currency - The currency for the value specified, if applicable. Currency
must be a valid ISO 4217 three digit currency code. Example:
'usd'public CustomData currency(String currency)
currency - The currency for the value specified, if applicable. Currency
must be a valid ISO 4217 three digit currency code. Example:
'usd'public SignalResponse<List<Content>,List<Content>> getContents()
public void setContents(List<Content> contents)
contents - An array of Content objects that contain the product IDs
associated with the event plus information about the
products. id, quantity, and itemprice are available fields.
Example: [{'id':'ABC123','quantity' :2,'itemprice':5.99},
{'id':'XYZ789','quantity':2, 'itemprice':9.99}]public CustomData contents(List<Content> contents)
contents - An array of Content objects that contain the product IDs
associated with the event plus information about the
products. id, quantity, and itemprice are available fields.
Example: [{'id':'ABC123','quantity' :2,'itemprice':5.99},
{'id':'XYZ789','quantity':2, 'itemprice':9.99}]public SignalResponse<String,String> getOrderId()
public void setOrderId(String orderId)
orderId - The order ID for this transaction as a String. Example:
'order1234'public CustomData orderId(String orderId)
orderId - The order ID for this transaction as a String. Example:
'order1234'public SignalResponse<String,String> getStatus()
public void setStatus(String status)
status - status, as a String.public CustomData status(String status)
status - status, as a String.public SignalResponse<String,String> getContentName()
public void setContentName(String contentName)
contentName - The name of the page or product associated with the event.
Example: 'lettuce'public CustomData contentName(String contentName)
contentName - The name of the page or product associated with the event.
Example: 'lettuce'public SignalResponse<String,String> getContentCategory()
public void setContentCategory(String contentCategory)
contentCategory - The category of the content associated with the event.
Example: 'grocery'public CustomData contentCategory(String contentCategory)
contentCategory - The category of the content associated with the event.
Example: 'grocery'public SignalResponse<List<String>,List<String>> getContentIds()
public void setContentIds(List<String> contentIds)
contentIds - The content IDs associated with the event, such as product
SKUs for items in an AddToCart, represented as Array of
string. If contenttype 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.
Example: ['ABC123', 'XYZ789']public CustomData contentIds(List<String> contentIds)
contentIds - The content IDs associated with the event, such as product
SKUs for items in an AddToCart, represented as Array of
string. If contenttype 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.
Example: ['ABC123', 'XYZ789']public SignalResponse<String,String> getContentType()
public void setContentType(String contentType)
contentType - A string equal to either product or productgroup. Set to
product if the keys you send contentids or contents
represent products. Set to productgroup if the keys you
send in contentids represent product groups.public CustomData contentType(String contentType)
contentType - A string equal to either product or productgroup. Set to
product if the keys you send contentids or contents
represent products. Set to productgroup if the keys you
send in contentids represent product groups.public SignalResponse<Float,Float> getPredictedLtv()
public void setPredictedLtv(Float predictedLtv)
predictedLtv - The predicted lifetime value of a conversion event, as a
String. Example: '432.12'public CustomData predictedLtv(Float predictedLtv)
predictedLtv - The predicted lifetime value of a conversion event, as a
String. Example: '432.12'public SignalResponse<String,String> getNumItems()
public void setNumItems(String numItems)
numItems - The number of items that a user tries to buy during checkout.
Use only with InitiateCheckout type events. Example: 5public CustomData numItems(String numItems)
numItems - The number of items that a user tries to buy during checkout.
Use only with InitiateCheckout type events. Example: 5public SignalResponse<String,String> getSearchString()
public void setSearchString(String searchString)
searchString - A search query made by a user.Use only with Search
events. Eg: 'lettuce'public CustomData searchString(String searchString)
searchString - A search query made by a user.Use only with Search
events. Eg: 'lettuce'public SignalResponse<String,String> getItemNumber()
public void setItemNumber(String itemNumber)
itemNumber - The item number.public CustomData itemNumber(String itemNumber)
itemNumber - The item number.public SignalResponse<DeliveryCategory,DeliveryCategory> getDeliveryCategory()
public void setdeliverycategory(DeliveryCategory deliveryCategory)
deliveryCategory - The delivery category.public CustomData deliveryCategory(DeliveryCategory deliveryCategory)
deliveryCategory - The delivery category.public SignalResponse<HashMap<String,String>,HashMap<String,String>> getCustomProperties()
public void setCustomProperties(HashMap<String,String> customProperties)
customProperties - custom properties property bag to be included in the
Custom Data. Eg: '{ 'warehouselocation' :
'washington', 'packagesize' : 'L'}'public CustomData customProperties(HashMap<String,String> customProperties)
customProperties - A custom properties property bag 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.public SignalResponse<UserData,UserData> getShippingContact()
public void setShippingContact(UserData shippingContact)
shippingContact - shipping contact of an order, use {SignalUserData} to
buildpublic CustomData shippingContact(UserData shippingContact)
shippingContact - shipping contact of an order, use {SignalUserData} to
buildpublic SignalResponse<UserData,UserData> getBillingContact()
public void setBillingContact(UserData billingContact)
billingContact - billing contact of an order, use {SignalUserData} to
buildpublic CustomData billingContact(UserData billingContact)
billingContact - billing contact of an order, use {SignalUserData} to
buildpublic SignalResponse<String,String> getExternalOrderId()
public void setExternalOrderId(String externalOrderId)
externalOrderId - Unique ID representing the order, universal across
multiple categories from the business.public CustomData externalOrderId(String externalOrderId)
externalOrderId - Unique ID representing the order, universal across
multiple categories from the business.public SignalResponse<String,String> getOriginalOrderId()
public void setOriginalOrderId(String originalOrderId)
originalOrderId - Original order id for refund. For Refund event only.public CustomData originalOrderId(String originalOrderId)
originalOrderId - Original order id for refund. For Refund event only.public SignalResponse<String,String> getMessage()
public void setMessage(String message)
message - Reason for refund. For Refund event only.public CustomData message(String message)
message - Reason for refund. For Refund event only.public CustomData getBusinessDataCustomData()
public CustomData getServerSideCustomData()
Copyright © 2024. All rights reserved.