public class Event extends Object
| Constructor and Description |
|---|
Event()
Default Constructor.
|
Event(String eventName,
Long eventTime,
String eventSourceUrl,
Boolean optOut,
String eventId,
UserData userData,
CustomData customData,
String[] dataProcessingOptions,
Integer dataProcessingOptionsCountry,
Integer dataProcessingOptionsState)
Constructor.
|
| Modifier and Type | Method and Description |
|---|---|
Event |
customData(CustomData customData)
Set customData object that includes additional business data about the event.
|
Event |
dataProcessingOptions(String[] dataProcessingOptions)
Set dataProcessingOptions Processing options you would like to enable for a specific event.
|
Event |
dataProcessingOptionsCountry(Integer dataProcessingOptionsCountry)
Set dataProcessingOptionsCountry for the event.
|
Event |
dataProcessingOptionsState(Integer dataProcessingOptionsState)
Set dataProcessingOptionsState for the event.
|
boolean |
equals(Object o) |
Event |
eventId(String eventId)
Sets an ID used by Facebook to deduplicate the same event sent from both server and browser.
|
Event |
eventName(String eventName)
Set Facebook pixel Standard Event or Custom Event name.
|
Event |
eventSourceUrl(String eventSourceUrl)
Set browser URL where the event happened.
|
Event |
eventTime(Long eventTime)
Set Unix timestamp in seconds indicating when the actual event occurred.
|
CustomData |
getCustomData()
Get customData object that includes additional business data about the event.
|
String[] |
getDataProcessingOptions()
Get dataProcessingOptions
|
Integer |
getDataProcessingOptionsCountry()
Get dataProcessingOptionsCountry
|
Integer |
getDataProcessingOptionsState()
Get dataProcessingOptionsState
|
String |
getEventId()
Get Event ID can be any string chosen by the advertiser.
|
String |
getEventName()
Get Facebook pixel Standard Event or Custom Event name.
|
String |
getEventSourceUrl()
Get browser URL where the event happened.
|
Long |
getEventTime()
Get Unix timestamp in seconds indicating when the actual event occurred.
|
UserData |
getUserData()
Get UserData object that contains user data
|
int |
hashCode() |
Boolean |
isOptOut()
Get flag that indicates we should not use this event for ads delivery optimization.
|
Event |
optOut(Boolean optOut)
Set flag that indicates we should not use this event for ads delivery optimization.
|
void |
setCustomData(CustomData customData)
Set customData object that includes additional business data about the event.
|
void |
setDataProcessingOptions(String[] dataProcessingOptions)
Set dataProcessingOptions Processing options you would like to enable for a specific event.
|
void |
setDataProcessingOptionsCountry(Integer dataProcessingOptionsCountry)
Set dataProcessingOptionsCountry for the event.
|
void |
setDataProcessingOptionsState(Integer dataProcessingOptionsState)
Set dataProcessingOptionsState for the event.
|
void |
setEventId(String eventId)
Sets an ID used by Facebook to deduplicate the same event sent from both server and browser.
|
void |
setEventName(String eventName)
Set Facebook pixel Standard Event or Custom Event name.
|
void |
setEventSourceUrl(String eventSourceUrl)
Set browser URL where the event happened.
|
void |
setEventTime(Long eventTime)
Set Unix timestamp in seconds indicating when the actual event occurred.
|
void |
setOptOut(Boolean optOut)
Set flag that indicates we should not use this event for ads delivery optimization.
|
void |
setUserData(UserData userData)
Set UserData object that contains user data
|
String |
toString() |
Event |
userData(UserData userData)
Set UserData object that contains user data
|
public Event()
public Event(String eventName, Long eventTime, String eventSourceUrl, Boolean optOut, String eventId, UserData userData, CustomData customData, String[] dataProcessingOptions, Integer dataProcessingOptionsCountry, Integer dataProcessingOptionsState)
eventName - Facebook pixel Standard Event or Custom Event nameeventTime - Unix timestamp in seconds indicating when the actual event occurred.eventSourceUrl - browser URL where the event happenedoptOut - flag that indicates to use this event for ads delivery optimization or noteventId - any string chosen by the advertiseruserData - UserData object that contains user infocustomData - customData object that includes additional business datadataProcessingOptions - Processing options you would like to enable for a specific event.dataProcessingOptionsCountry - country that you want to associate to this data processing option.dataProcessingOptionsState - state that you want to associate with this data processing option.public Event eventName(String eventName)
eventName - Facebook pixel Standard Event or Custom Event name.public String getEventName()
public void setEventName(String eventName)
eventName - Facebook pixel Standard Event or Custom Event name.public Event eventTime(Long eventTime)
eventTime - Unix timestamp in seconds indicating when the actual event occurredpublic Long getEventTime()
public void setEventTime(Long eventTime)
eventTime - Unix timestamp in seconds indicating when the actual event occurredpublic Event eventSourceUrl(String eventSourceUrl)
eventSourceUrl - rowser URL where the event happenedpublic String getEventSourceUrl()
public void setEventSourceUrl(String eventSourceUrl)
eventSourceUrl - rowser URL where the event happenedpublic Event optOut(Boolean optOut)
optOut - indicates we should not use this event for ads delivery optimizationpublic Boolean isOptOut()
public void setOptOut(Boolean optOut)
optOut - indicates we should not use this event for ads delivery optimizationpublic Event eventId(String eventId)
eventId - This ID can be any unique string chosen by the advertiser. eventId is used to
deduplicate events sent by both Facebook Pixel and Server-Side API. eventName is also used in
the deduplication process.public String getEventId()
public void setEventId(String eventId)
eventId - This ID can be any unique string chosen by the advertiser. eventId is used to
deduplicate events sent by both Facebook Pixel and Server-Side API. eventName is also used in
the deduplication process.public Event userData(UserData userData)
userData - object that contains user datapublic UserData getUserData()
public void setUserData(UserData userData)
userData - object that contains user datapublic Event customData(CustomData customData)
customData - object that includes additional business data about the event.public CustomData getCustomData()
public void setCustomData(CustomData customData)
customData - object that includes additional business data about the event.public Event dataProcessingOptions(String[] dataProcessingOptions)
dataProcessingOptions - specfies the data processing options you would like to enable for a specific event, e.g. `new String[] {}` or `new String[] {"LDU"}`;public String[] getDataProcessingOptions()
public void setDataProcessingOptions(String[] dataProcessingOptions)
dataProcessingOptions - specfies the data processing options you would like to enable for a specific event, e.g. `new String[] {}` or `new String[] {"LDU"}`;public Event dataProcessingOptionsCountry(Integer dataProcessingOptionsCountry)
dataProcessingOptionsCountry - represents country that you want to associate to this data processing option. If you set a country, you must also set a state.public Integer getDataProcessingOptionsCountry()
public void setDataProcessingOptionsCountry(Integer dataProcessingOptionsCountry)
dataProcessingOptionsCountry - represents country that you want to associate to this data processing option. If you set a country, you must also set a state.public Event dataProcessingOptionsState(Integer dataProcessingOptionsState)
dataProcessingOptionsState - represents the state that you want to associate with this data processing option.public Integer getDataProcessingOptionsState()
public void setDataProcessingOptionsState(Integer dataProcessingOptionsState)
dataProcessingOptionsState - represents the state that you want to associate with this data processing option.Copyright © 2020. All rights reserved.