com.facebook.ads.sdk.businessdataapi

Class Event

java.lang.Object

com.facebook.ads.sdk.businessdataapi.Event

public class Event
extends Object

Constructor Summary

Constructors

Constructor and Description
Event() Default Constructor.
Event(String eventName, Long eventTime, 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 object for the current Event.
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	eventTime(Long eventTime) Sets the Event Time when the current Event happened.
CustomData	getCustomData() Gets the custom data object for the current Event.
String[]	getDataProcessingOptions() Gets the dataProcessingOptions for the current event.
Integer	getDataProcessingOptionsCountry() Gets the dataProcessingOptionsCountry for the current event.
Integer	getDataProcessingOptionsState() Gets the dataProcessingOptionsState for the current event.
String	getEventId() Gets the eventId for the current Event.
String	getEventName() Gets the Event Name for the current Event.
Long	getEventTime() Gets the Event Time when the current Event happened.
UserData	getUserData() Gets the user data object for the current Event.
void	setCustomData(CustomData customData) Sets the custom data object for the current Event.
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	setEventTime(Long eventTime) Sets the Event Time when the current Event happened.
void	setUserData(UserData userData) Sets the user data object for the current Event.
Event	userData(UserData userData) Sets the user data object for the current Event.

Methods inherited from class java.lang.Object

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

Constructor Detail

Event

public Event()

Default Constructor.

Event

public Event(String eventName,
             Long eventTime,
             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.

eventId - This ID can be any string chosen by the advertiser.

userData - A map that contains user data. See UserData Class for options.

customData - A map that contains user data. See CustomData Class for options.

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 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 - a Facebook pixel Standard Event or Custom Event name.

Returns:

Event

getEventTime

public 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

getEventId

public 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 - Unique id for the event.

eventId

public Event eventId(String eventId)

Sets the event Id for the current Event.

Parameters:

eventId - Unique id for the event.

Returns:

Event

getUserData

public UserData getUserData()

Gets the user data object for the current Event.

Returns:

UserData

setUserData

public void setUserData(UserData userData)

Sets the user data object for the current Event.

Parameters:

userData - userData is an object that contains user data.

userData

public Event userData(UserData userData)

Sets the user data object for the current Event.

Parameters:

userData - userData is an object that contains user data.

Returns:

Event

getCustomData

public CustomData getCustomData()

Gets the custom data object for the current Event.

Returns:

customData

setCustomData

public void setCustomData(CustomData customData)

Sets the custom data object for the current Event.

Parameters:

customData - is an object that includes additional business data about the event.

customData

public Event customData(CustomData customData)

Sets the custom data object for the current Event.

Parameters:

customData - is an object that includes additional business data about the event.

Returns:

Event

getDataProcessingOptions

public 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 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 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