com.facebook.ads.sdk.serverside

Class EventRequest

java.lang.Object

com.facebook.ads.sdk.serverside.EventRequest

public class EventRequest
extends Object

Server side pixel event request

Constructor Summary

Constructors

Constructor and Description
EventRequest(String pixelId, APIContext context) Constructor.
EventRequest(String pixelId, APIContext context, List<Event> data, String testEventCode, String partnerAgent, String namespaceId, String uploadId, String uploadTag, String uploadSource, HttpServiceInterface httpServiceClient) Constructor.

Method Summary

Modifier and Type	Method and Description
EventRequest	addDataItem(Event dataItem) Add a Server Event object
EventRequest	cloneWithoutData()
EventRequest	data(List<Event> data) Set a list of Server Event objects
boolean	equals(Object o)
EventResponse	execute() Synchronously send Event to Facebook GraphAPI.
com.google.common.util.concurrent.ListenableFuture<EventResponse>	executeAsync() Asynchronously send Event to Facebook GraphAPI.
List<Event>	getData() A list of Server Event objects
HttpServiceInterface	getHttpServiceClient() Get the httpServiceClient.
String	getNamespaceId() The namespace id is a scope used to resolve extern_id or Third-party ID.
String	getPartnerAgent() A value that represents the platform that is sending the event.
String	getSerializedPayload()
String	getTestEventCode() Code used to verify that your server events are received correctly by Facebook.
String	getUploadId() The upload id is a unique id used to denote the current set being uploaded.
String	getUploadSource() The upload source is the origin/source of data for the dataset to be uploaded.
String	getUploadTag() The upload tag is a tag string added to track your Offline event uploads.
int	hashCode()
EventRequest	namespaceId(String namespaceId) Set namespace id
EventRequest	partnerAgent(String partnerAgent) Sets a value that represents the platform that is sending the event.
void	setData(List<Event> data) Set a list of Server Event objects
void	setHttpServiceClient(HttpServiceInterface httpServiceClient) Set a custom http client that will be used to send the event request.
void	setNamespaceId(String namespaceId) Set namespace id
void	setPartnerAgent(String partnerAgent) Set a value that represents the platform that is sending the event.
void	setTestEventCode(String testEventCode) Set code used to verify that your server events are received correctly by Facebook.
void	setUploadId(String uploadId) Set upload id
void	setUploadSource(String uploadSource) Set upload source
void	setUploadTag(String uploadTag) Set upload tag
EventRequest	testEventCode(String testEventCode) Set code used to verify that your server events are received correctly by Facebook.
String	toString()
EventRequest	uploadId(String uploadId) Set upload id
EventRequest	uploadSource(String uploadSource) Set upload source
EventRequest	uploadTag(String uploadTag) Set upload tag

Methods inherited from class java.lang.Object

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

Constructor Detail

EventRequest

public EventRequest(String pixelId,
                    APIContext context)

Constructor.

Parameters:

pixelId - Ad pixel id

context - Api context

EventRequest

public EventRequest(String pixelId,
                    APIContext context,
                    List<Event> data,
                    String testEventCode,
                    String partnerAgent,
                    String namespaceId,
                    String uploadId,
                    String uploadTag,
                    String uploadSource,
                    HttpServiceInterface httpServiceClient)

Constructor.

Parameters:

pixelId - Ad pixel id

context - Api context

data - list of event

testEventCode - code used to verify that your server events are received correctly by

partnerAgent - A value that represents the platform that is sending the event

namespaceId - Scope used to resolve extern_id or Third-party ID. Can be another data set or data partner ID.

uploadId - Unique id used to denote the current set being uploaded.

uploadTag - Tag string added to track your Offline event uploads.

uploadSource - The origin/source of data for the dataset to be uploaded.

httpServiceClient - The HttpServiceInterface client to use for executing the request. Facebook

Method Detail

data

public EventRequest data(List<Event> data)

Set a list of Server Event objects

Parameters:

data - list of Server Event

Returns:

EventRequest

addDataItem

public EventRequest addDataItem(Event dataItem)

Add a Server Event object

Parameters:

dataItem - Server Event

Returns:

EventRequest

getData

public List<Event> getData()

A list of Server Event objects

Returns:

data

setData

public void setData(List<Event> data)

Set a list of Server Event objects

Parameters:

data - list of Server Event

getNamespaceId

public String getNamespaceId()

The namespace id is a scope used to resolve extern_id or Third-party ID. Can be another data set or data partner ID.

Returns:

namespaceId

setNamespaceId

public void setNamespaceId(String namespaceId)

Set namespace id

Parameters:

namespaceId - Scope used to resolve extern_id or Third-party ID. Can be another data set or data partner ID.

namespaceId

public EventRequest namespaceId(String namespaceId)

Set namespace id

Parameters:

namespaceId - Scope used to resolve extern_id or Third-party ID. Can be another data set or data partner ID.

Returns:

EventRequest

getUploadId

public String getUploadId()

The upload id is a unique id used to denote the current set being uploaded.

Returns:

uploadId

setUploadId

public void setUploadId(String uploadId)

Set upload id

Parameters:

uploadId - Unique id used to denote the current set being uploaded.

uploadId

public EventRequest uploadId(String uploadId)

Set upload id

Parameters:

uploadId - Unique id used to denote the current set being uploaded.

Returns:

EventRequest

getUploadTag

public String getUploadTag()

The upload tag is a tag string added to track your Offline event uploads.

Returns:

uploadTag

setUploadTag

public void setUploadTag(String uploadTag)

Set upload tag

Parameters:

uploadTag - Tag string added to track your Offline event uploads.

uploadTag

public EventRequest uploadTag(String uploadTag)

Set upload tag

Parameters:

uploadTag - Tag string added to track your Offline event uploads.

Returns:

EventRequest

getUploadSource

public String getUploadSource()

The upload source is the origin/source of data for the dataset to be uploaded.

Returns:

uploadSource

setUploadSource

public void setUploadSource(String uploadSource)

Set upload source

Parameters:

uploadSource - The origin/source of data for the dataset to be uploaded.

uploadSource

public EventRequest uploadSource(String uploadSource)

Set upload source

Parameters:

uploadSource - The origin/source of data for the dataset to be uploaded.

Returns:

EventRequest

testEventCode

public EventRequest testEventCode(String testEventCode)

Set code used to verify that your server events are received correctly by Facebook. Use this code to test your server events in the Test Events feature in Events Manager. See Test Events Tool (https://developers.facebook.com/docs/marketing-api/facebook-pixel/server-side-api/using-the-api#testEvents) for an example.

Parameters:

testEventCode - ode used to verify that your server events

Returns:

EventRequest

getTestEventCode

public String getTestEventCode()

Code used to verify that your server events are received correctly by Facebook. Use this code to test your server events in the Test Events feature in Events Manager. See Test Events Tool (https://developers.facebook.com/docs/marketing-api/facebook-pixel/server-side-api/using-the-api#testEvents) for an example.

Returns:

testEventCode

setTestEventCode

public void setTestEventCode(String testEventCode)

Set code used to verify that your server events are received correctly by Facebook. Use this code to test your server events in the Test Events feature in Events Manager. See Test Events Tool (https://developers.facebook.com/docs/marketing-api/facebook-pixel/server-side-api/using-the-api#testEvents) for an example.

Parameters:

testEventCode - ode used to verify that your server events

partnerAgent

public EventRequest partnerAgent(String partnerAgent)

Sets a value that represents the platform that is sending the event.

Parameters:

partnerAgent - a value that represents the platform that is sending the event

Returns:

EventRequest

getPartnerAgent

public String getPartnerAgent()

A value that represents the platform that is sending the event.

Returns:

partnerAgent

setPartnerAgent

public void setPartnerAgent(String partnerAgent)

Set a value that represents the platform that is sending the event.

Parameters:

partnerAgent - a value that represents the platform that is sending the event

getHttpServiceClient

public HttpServiceInterface getHttpServiceClient()

Get the httpServiceClient.

Returns:

httpServiceClient

setHttpServiceClient

public void setHttpServiceClient(HttpServiceInterface httpServiceClient)

Set a custom http client that will be used to send the event request.

Parameters:

httpServiceClient - the object implementing HttpServiceInterface

execute

public EventResponse execute()
                      throws APIException

Synchronously send Event to Facebook GraphAPI.

Returns:

event response

Throws:

APIException - Api Exception

executeAsync

public com.google.common.util.concurrent.ListenableFuture<EventResponse> executeAsync()
                                                                               throws APIException

Asynchronously send Event to Facebook GraphAPI.

Returns:

ListenableFuture of event response

Throws:

APIException - Api Exception

getSerializedPayload

public String getSerializedPayload()

cloneWithoutData

public EventRequest cloneWithoutData()

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