com.facebook.ads.sdk.signal

Class EventRequest

java.lang.Object

com.facebook.ads.sdk.signal.EventRequest

public class EventRequest
extends Object

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
EventRequest	data(List<Event> data) Set a list of Event objects
SignalResponse<EventResponse,EventResponse>	execute() Synchronously send Event to Facebook GraphAPI.
EventRequest	getBusinessDataEventRequest() Return Business Data API event request
SignalResponse<List<Event>,List<Event>>	getData() A list of Event objects
SignalResponse<HttpServiceInterface,HttpServiceInterface>	getHttpServiceClient() Get the httpServiceClient.
SignalResponse<String,String>	getNamespaceId() The namespace id is a scope used to resolve extern_id or Third-party ID.
SignalResponse<String,String>	getPartnerAgent() A value that represents the platform that is sending the event.
EventRequest	getServerSideEventRequest() Return Conversion API event request
SignalResponse<String,String>	getTestEventCode() Code used to verify that your server events are received correctly by Facebook.
SignalResponse<String,String>	getUploadId() The upload id is a unique id used to denote the current set being uploaded.
SignalResponse<String,String>	getUploadSource() The upload source is the origin/source of data for the dataset to be uploaded.
SignalResponse<String,String>	getUploadTag() The upload tag is a tag string added to track your Offline event uploads.
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 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.
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, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EventRequest

public EventRequest(String pixelId,
                    String pageId,
                    APIContext context)

Constructor.

Parameters:

pageId - page id

pixelId - Ad pixel id

context - Api context

EventRequest

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

Parameters:

context - Api context

pixelId - Pixel Id to which you are sending the events

pageId - Page Id to which you are sending the events

data - Data for the request Payload for a Server Side Event

partnerAgent - Platform from which the event is sent e.g. wordpress

testEventCode - Test Event Code used to verify that your server events are received correctly by Facebook.

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 - Override the default http request method by setting an object that implements HttpServiceInterface

Method Detail

data

public EventRequest data(List<Event> data)

Set a list of Event objects

Parameters:

data - list of Event

Returns:

EventRequest

getData

public SignalResponse<List<Event>,List<Event>> getData()

A list of Event objects

Returns:

data

setData

public void setData(List<Event> data)

Set a list of Event objects

Parameters:

data - list of Event

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 SignalResponse<String,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

getNamespaceId

public SignalResponse<String,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 SignalResponse<String,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 SignalResponse<String,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 SignalResponse<String,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 SignalResponse<String,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

getHttpServiceClient

public SignalResponse<HttpServiceInterface,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

getBusinessDataEventRequest

public EventRequest getBusinessDataEventRequest()

Return Business Data API event request

Returns:

businessDataEventRequest

getServerSideEventRequest

public EventRequest getServerSideEventRequest()

Return Conversion API event request

Returns:

serverSideEventRequest

execute

public SignalResponse<EventResponse,EventResponse> execute()
                                                    throws APIException

Synchronously send Event to Facebook GraphAPI.

Returns:

event response

Throws:

APIException - Api Exception