public class Event extends Object
| Constructor and Description |
|---|
Event() |
Event(String eventName,
Long eventTime,
String eventSourceUrl,
Boolean optOut,
String eventId,
UserData userData,
CustomData customData,
String[] dataProcessingOptions,
Integer dataProcessingOptionsCountry,
Integer dataProcessingOptionsState) |
| Modifier and Type | Method and Description |
|---|---|
Event |
customData(CustomData customData)
Sets the custom data objects for Business Data API and Conversion API.
|
Event |
dataProcessingOptions(String[] dataProcessingOptions)
Sets the dataProcessingOptions for the current event.
|
Event |
DataProcessingOptionsCountry(Integer dataProcessingOptionsCountry)
Sets the dataProcessingOptionsCountry for the current event.
|
Event |
DataProcessingOptionsState(Integer dataProcessingOptionsState)
Sets the dataProcessingOptionsstate for the current event.
|
Event |
eventId(String eventId)
Sets the event Id for the current Event.
|
Event |
eventName(String eventName)
Sets the Event Name for the current Event.
|
Event |
eventSourceUrl(String eventSourceUrl)
Sets the browser url source for the current event.
|
Event |
eventTime(Long eventTime)
Sets the Event Time when the current Event happened.
|
Event |
getBusinessDataEvent()
Gets the constructed custom data for Business Data API
|
SignalResponse<CustomData,CustomData> |
getCustomData()
Gets the custom data objects for Business Data API and Conversion API.
|
SignalResponse<String[],String[]> |
getDataProcessingOptions()
Gets the dataProcessingOptions for the current event.
|
SignalResponse<Integer,Integer> |
getDataProcessingOptionsCountry()
Gets the dataProcessingOptionsCountry for the current event.
|
SignalResponse<Integer,Integer> |
getDataProcessingOptionsState()
Gets the dataProcessingOptionsState for the current event.
|
SignalResponse<String,String> |
getEventId()
Gets the eventId for the current Event.
|
SignalResponse<String,String> |
getEventName()
Gets the Event Name for the current Event.
|
SignalResponse<String,String> |
getEventSourceUrl()
Gets the browser url source for the current event.
|
SignalResponse<Long,Long> |
getEventTime()
Gets the Event Time when the current Event happened.
|
SignalResponse<Boolean,Boolean> |
getOptOut()
Gets the optOut feature for the current event.optOut is a boolean flag that
indicates we should not use this event for ads delivery optimization.
|
Event |
getServerSideEvent()
Gets the constructed custom data for Business Data API
|
SignalResponse<UserData,UserData> |
getUserData()
Gets the user data objects for Business Data API and Conversion API.
|
Event |
optOut(Boolean optOut)
Sets the optOut feature for the current event.
|
void |
setCustomData(CustomData customData)
Sets the custom data objects for Business Data API and Conversion API.
|
void |
setDataProcessingOptions(String[] dataProcessingOptions)
Sets the dataProcessingOptions for the current event.
|
void |
setDataProcessingOptionsCountry(Integer dataProcessingOptionsCountry)
Sets the dataProcessingOptionsCountry for the current event.
|
void |
setDataProcessingOptionsState(Integer dataProcessingOptionsState)
Sets the dataProcessingOptionsstate for the current event.
|
void |
setEventId(String eventId)
Sets the event Id for the current Event.
|
void |
setEventName(String eventName)
Sets the Event Name for the current Event.
|
void |
setEventSourceUrl(String eventSourceUrl)
Sets the browser url source for the current event.
|
void |
setEventTime(Long eventTime)
Sets the Event Time when the current Event happened.
|
void |
setOptOut(Boolean optOut)
Sets the optOut feature for the current event.
|
void |
setUserData(UserData userData)
Sets the user data objects for Business Data API and Conversion API.
|
Event |
userData(UserData userData)
Sets the user data objects for Business Data API and Conversion API.
|
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 - A Facebook pixel Standard Event or Custom
Event name.eventTime - A Unix timestamp in seconds indicating
when the actual event occurred.eventSourceUrl - The browser URL where the event happened.eventId - This ID can be any string chosen by the
advertiser.optOut - A flag that indicates we should not use
this event for ads delivery optimization.userData - SignalUserData contains user data for
both Business Data API and Conversion APIcustomData - SignalCustomData contains custom data for
both Business Data API and Conversion APIdataProcessingOptions - Processing options you would like to
enable for a specific event.dataProcessingOptionsCountry - A country that you want to associate to
this data processing option.dataProcessingOptionsState - A state that you want to associate with
this data processing option.public SignalResponse<String,String> getEventName()
public void setEventName(String eventName)
eventName - a Facebook pixel Standard Event or Custom Event name.public Event eventName(String eventName)
eventName - Facebook pixel Standard Event or Custom Event name.public SignalResponse<Long,Long> getEventTime()
public void setEventTime(Long eventTime)
eventTime - is a Unix timestamp in seconds indicating when the actual
event occurred.public Event eventTime(Long eventTime)
eventTime - is a Unix timestamp in seconds indicating when the actual
event occurred.public SignalResponse<String,String> getEventSourceUrl()
public void setEventSourceUrl(String eventSourceUrl)
eventSourceUrl - The browser URL where the event happened.public Event eventSourceUrl(String eventSourceUrl)
eventSourceUrl - The browser URL where the event happened.public SignalResponse<String,String> getEventId()
public void setEventId(String eventId)
eventId - can be any string chosen by the advertiser. This is used with
eventName to determine if events are identical for Conversion
API.public Event eventId(String eventId)
eventId - can be any string chosen by the advertiser. This is used with
eventName to determine if events are identical for Conversion
API.public SignalResponse<Boolean,Boolean> getOptOut()
public void setOptOut(Boolean optOut)
optOut - is a boolean flag that indicates we should not use this event
for ads delivery optimization. If public void setto true, we
only use the event for attribution.public Event optOut(Boolean optOut)
optOut - is a boolean flag that indicates we should not use this event
for ads delivery optimization. If public void setto true, we
only use the event for attribution.public SignalResponse<UserData,UserData> getUserData()
public void setUserData(UserData userData)
userData - contains user data, use SignalUserData to constructpublic Event userData(UserData userData)
userData - contains user data, use SignalUserData to constructpublic SignalResponse<CustomData,CustomData> getCustomData()
public void setCustomData(CustomData customData)
customData - contains custom data, use SignalCustomData to constructpublic Event customData(CustomData customData)
customData - contains custom data, use SignalCustomData to constructpublic SignalResponse<String[],String[]> getDataProcessingOptions()
public void setDataProcessingOptions(String[] dataProcessingOptions)
dataProcessingOptions - represents Data processing options you would
like to enable for a specific event, e.g. [] or
['LDU']public Event dataProcessingOptions(String[] dataProcessingOptions)
dataProcessingOptions - represents Data processing options you would
like to enable for a specific event, e.g. [] or
['LDU']public SignalResponse<Integer,Integer> getDataProcessingOptionsCountry()
public void setDataProcessingOptionsCountry(Integer dataProcessingOptionsCountry)
dataProcessingOptionsCountry - represents country that you want to
associate to this data processing option.public Event DataProcessingOptionsCountry(Integer dataProcessingOptionsCountry)
dataProcessingOptionsCountry - represents country that you want to
associate to this data processing option.public SignalResponse<Integer,Integer> getDataProcessingOptionsState()
public void setDataProcessingOptionsState(Integer dataProcessingOptionsState)
dataProcessingOptionsState - represents state that you want to associate
with this data processing option.public Event DataProcessingOptionsState(Integer dataProcessingOptionsState)
dataProcessingOptionsState - represents state that you want to associate
with this data processing option.public Event getBusinessDataEvent()
public Event getServerSideEvent()
Copyright © 2024. All rights reserved.