com.facebook.ads.sdk.serverside

Class Event

java.lang.Object

com.facebook.ads.sdk.serverside.Event

public class Event
extends Object

Server side pixel event

Constructor Summary

Constructors

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.

Method Summary

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

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Event

public Event()

Default Constructor.

Event

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

Constructor.

Parameters:

eventName - Facebook pixel Standard Event or Custom Event name

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

eventSourceUrl - browser URL where the event happened

optOut - flag that indicates to use this event for ads delivery optimization or not

eventId - any string chosen by the advertiser

userData - UserData object that contains user info

customData - customData object that includes additional business data

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

Method Detail

eventName

public Event eventName(String eventName)

Set Facebook pixel Standard Event or Custom Event name.

Parameters:

eventName - Facebook pixel Standard Event or Custom Event name.

Returns:

Event

getEventName

public String getEventName()

Get Facebook pixel Standard Event or Custom Event name.

Returns:

eventName

setEventName

public void setEventName(String eventName)

Set Facebook pixel Standard Event or Custom Event name.

Parameters:

eventName - Facebook pixel Standard Event or Custom Event name.

eventTime

public Event eventTime(Long eventTime)

Set Unix timestamp in seconds indicating when the actual event occurred.

Parameters:

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

Returns:

Event

getEventTime

public Long getEventTime()

Get Unix timestamp in seconds indicating when the actual event occurred.

Returns:

eventTime

setEventTime

public void setEventTime(Long eventTime)

Set Unix timestamp in seconds indicating when the actual event occurred.

Parameters:

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

eventSourceUrl

public Event eventSourceUrl(String eventSourceUrl)

Set browser URL where the event happened.

Parameters:

eventSourceUrl - rowser URL where the event happened

Returns:

Event

getEventSourceUrl

public String getEventSourceUrl()

Get browser URL where the event happened.

Returns:

eventSourceUrl

setEventSourceUrl

public void setEventSourceUrl(String eventSourceUrl)

Set browser URL where the event happened.

Parameters:

eventSourceUrl - rowser URL where the event happened

optOut

public Event optOut(Boolean optOut)

Set flag that indicates we should not use this event for ads delivery optimization. If set to true, we only use the event for attribution.

Parameters:

optOut - indicates we should not use this event for ads delivery optimization

Returns:

Event

isOptOut

public Boolean isOptOut()

Get flag that indicates we should not use this event for ads delivery optimization. If set to true, we only use the event for attribution.

Returns:

optOut

setOptOut

public void setOptOut(Boolean optOut)

Set flag that indicates we should not use this event for ads delivery optimization. If set to true, we only use the event for attribution.

Parameters:

optOut - indicates we should not use this event for ads delivery optimization

eventId

public Event eventId(String eventId)

Sets an ID used by Facebook to deduplicate the same event sent from both server and browser.

Parameters:

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.

Returns:

Event

getEventId

public String getEventId()

Get Event ID can be any string chosen by the advertiser.

Returns:

eventId

setEventId

public void setEventId(String eventId)

Sets an ID used by Facebook to deduplicate the same event sent from both server and browser.

Parameters:

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.

userData

public Event userData(UserData userData)

Set UserData object that contains user data

Parameters:

userData - object that contains user data

Returns:

Event

getUserData

public UserData getUserData()

Get UserData object that contains user data

Returns:

userData

setUserData

public void setUserData(UserData userData)

Set UserData object that contains user data

Parameters:

userData - object that contains user data

customData

public Event customData(CustomData customData)

Set customData object that includes additional business data about the event.

Parameters:

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

Returns:

Event

getCustomData

public CustomData getCustomData()

Get customData object that includes additional business data about the event.

Returns:

customData

setCustomData

public void setCustomData(CustomData customData)

Set customData object that includes additional business data about the event.

Parameters:

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

dataProcessingOptions

public Event dataProcessingOptions(String[] dataProcessingOptions)

Set dataProcessingOptions Processing options you would like to enable for a specific event.

Parameters:

dataProcessingOptions - specfies the data processing options you would like to enable for a specific event, e.g. `new String[] {}` or `new String[] {"LDU"}`;

Returns:

Event

See Also:

Data Processing Options for the event

getDataProcessingOptions

public String[] getDataProcessingOptions()

Get dataProcessingOptions

Returns:

dataProcessingOptions

setDataProcessingOptions

public void setDataProcessingOptions(String[] dataProcessingOptions)

Set dataProcessingOptions Processing options you would like to enable for a specific event.

Parameters:

dataProcessingOptions - specfies the data processing options you would like to enable for a specific event, e.g. `new String[] {}` or `new String[] {"LDU"}`;

See Also:

Data Processing Options for the event

dataProcessingOptionsCountry

public Event dataProcessingOptionsCountry(Integer dataProcessingOptionsCountry)

Set dataProcessingOptionsCountry for the event.

Parameters:

dataProcessingOptionsCountry - represents country that you want to associate to this data processing option. If you set a country, you must also set a state.

Returns:

Event

getDataProcessingOptionsCountry

public Integer getDataProcessingOptionsCountry()

Get dataProcessingOptionsCountry

Returns:

dataProcessingOptionsCountry

setDataProcessingOptionsCountry

public void setDataProcessingOptionsCountry(Integer dataProcessingOptionsCountry)

Set dataProcessingOptionsCountry for the event.

Parameters:

dataProcessingOptionsCountry - represents country that you want to associate to this data processing option. If you set a country, you must also set a state.

See Also:

Data Processing Options for the event

dataProcessingOptionsState

public Event dataProcessingOptionsState(Integer dataProcessingOptionsState)

Set dataProcessingOptionsState for the event.

Parameters:

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

Returns:

Event

See Also:

Data Processing Options for the event

getDataProcessingOptionsState

public Integer getDataProcessingOptionsState()

Get dataProcessingOptionsState

Returns:

dataProcessingOptionsState

setDataProcessingOptionsState

public void setDataProcessingOptionsState(Integer dataProcessingOptionsState)

Set dataProcessingOptionsState for the event.

Parameters:

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

See Also:

Data Processing Options for the event

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object