com.facebook.ads.sdk.signal

Class Event

java.lang.Object

com.facebook.ads.sdk.signal.Event

public class Event
extends Object

Constructor Summary

Constructors

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)

Method Summary

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

Event

public Event()

Event

public Event(String eventName,
             Long eventTime,
             String eventSourceUrl,
             Boolean optOut,
             String eventId,
             UserData userData,
             CustomData customData,
             String[] dataProcessingOptions,
             Integer dataProcessingOptionsCountry,
             Integer dataProcessingOptionsState)

Parameters:

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 API

customData - SignalCustomData contains custom data for both Business Data API and Conversion API

dataProcessingOptions - 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.

Method Detail

getEventName

public SignalResponse<String,String> getEventName()

Gets the Event Name for the current Event.

Returns:

EventName

setEventName

public void setEventName(String eventName)

Sets the Event Name for the current Event.

Parameters:

eventName - a Facebook pixel Standard Event or Custom Event name.

eventName

public Event eventName(String eventName)

Sets the Event Name for the current Event.

Parameters:

eventName - Facebook pixel Standard Event or Custom Event name.

Returns:

Event

getEventTime

public SignalResponse<Long,Long> getEventTime()

Gets the Event Time when the current Event happened.

Returns:

EventTime

setEventTime

public void setEventTime(Long eventTime)

Sets the Event Time when the current Event happened.

Parameters:

eventTime - is a Unix timestamp in seconds indicating when the actual event occurred.

eventTime

public Event eventTime(Long eventTime)

Sets the Event Time when the current Event happened.

Parameters:

eventTime - is a Unix timestamp in seconds indicating when the actual event occurred.

Returns:

Event

getEventSourceUrl

public SignalResponse<String,String> getEventSourceUrl()

Gets the browser url source for the current event.

Returns:

eventSourceUrl

setEventSourceUrl

public void setEventSourceUrl(String eventSourceUrl)

Sets the browser url source for the current event.

Parameters:

eventSourceUrl - The browser URL where the event happened.

eventSourceUrl

public Event eventSourceUrl(String eventSourceUrl)

Sets the browser url source for the current event.

Parameters:

eventSourceUrl - The browser URL where the event happened.

Returns:

Event

getEventId

public SignalResponse<String,String> getEventId()

Gets the eventId for the current Event.

Returns:

eventId

setEventId

public void setEventId(String eventId)

Sets the event Id for the current Event.

Parameters:

eventId - can be any string chosen by the advertiser. This is used with eventName to determine if events are identical for Conversion API.

eventId

public Event eventId(String eventId)

Sets the event Id for the current Event.

Parameters:

eventId - can be any string chosen by the advertiser. This is used with eventName to determine if events are identical for Conversion API.

Returns:

Event

getOptOut

public 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. If public Event to true, we only use the event for attribution.

Returns:

OptOut

setOptOut

public void setOptOut(Boolean optOut)

Sets the optOut feature for the current event.

Parameters:

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.

optOut

public Event optOut(Boolean optOut)

Sets the optOut feature for the current event.

Parameters:

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.

Returns:

Event

getUserData

public SignalResponse<UserData,UserData> getUserData()

Gets the user data objects for Business Data API and Conversion API.

Returns:

userData

setUserData

public void setUserData(UserData userData)

Sets the user data objects for Business Data API and Conversion API.

Parameters:

userData - contains user data, use SignalUserData to construct

userData

public Event userData(UserData userData)

Sets the user data objects for Business Data API and Conversion API.

Parameters:

userData - contains user data, use SignalUserData to construct

Returns:

Event

getCustomData

public SignalResponse<CustomData,CustomData> getCustomData()

Gets the custom data objects for Business Data API and Conversion API.

Returns:

customData

setCustomData

public void setCustomData(CustomData customData)

Sets the custom data objects for Business Data API and Conversion API.

Parameters:

customData - contains custom data, use SignalCustomData to construct

customData

public Event customData(CustomData customData)

Sets the custom data objects for Business Data API and Conversion API.

Parameters:

customData - contains custom data, use SignalCustomData to construct

Returns:

Event

getDataProcessingOptions

public SignalResponse<String[],String[]> getDataProcessingOptions()

Gets the dataProcessingOptions for the current event. Processing options you would like to enable for a specific event.

Returns:

dataProcessingOptions

setDataProcessingOptions

public void setDataProcessingOptions(String[] dataProcessingOptions)

Sets the dataProcessingOptions for the current event.

Parameters:

dataProcessingOptions - represents Data processing options you would like to enable for a specific event, e.g. [] or ['LDU']

dataProcessingOptions

public Event dataProcessingOptions(String[] dataProcessingOptions)

Sets the dataProcessingOptions for the current event.

Parameters:

dataProcessingOptions - represents Data processing options you would like to enable for a specific event, e.g. [] or ['LDU']

Returns:

Event

getDataProcessingOptionsCountry

public SignalResponse<Integer,Integer> getDataProcessingOptionsCountry()

Gets the dataProcessingOptionsCountry for the current event. A country that you want to associate to this data processing option.

Returns:

dataProcessingOptionsCountry

setDataProcessingOptionsCountry

public void setDataProcessingOptionsCountry(Integer dataProcessingOptionsCountry)

Sets the dataProcessingOptionsCountry for the current event.

Parameters:

dataProcessingOptionsCountry - represents country that you want to associate to this data processing option.

DataProcessingOptionsCountry

public Event DataProcessingOptionsCountry(Integer dataProcessingOptionsCountry)

Sets the dataProcessingOptionsCountry for the current event.

Parameters:

dataProcessingOptionsCountry - represents country that you want to associate to this data processing option.

Returns:

Event

getDataProcessingOptionsState

public SignalResponse<Integer,Integer> getDataProcessingOptionsState()

Gets the dataProcessingOptionsState for the current event. A state that you want to associate with this data processing option.

Returns:

dataProcessingOptionsState

setDataProcessingOptionsState

public void setDataProcessingOptionsState(Integer dataProcessingOptionsState)

Sets the dataProcessingOptionsstate for the current event.

Parameters:

dataProcessingOptionsState - represents state that you want to associate with this data processing option.

DataProcessingOptionsState

public Event DataProcessingOptionsState(Integer dataProcessingOptionsState)

Sets the dataProcessingOptionsstate for the current event.

Parameters:

dataProcessingOptionsState - represents state that you want to associate with this data processing option.

Returns:

Event

getBusinessDataEvent

public Event getBusinessDataEvent()

Gets the constructed custom data for Business Data API

Returns:

businessDataEvent

getServerSideEvent

public Event getServerSideEvent()

Gets the constructed custom data for Business Data API

Returns:

serverSideEvent