com.facebook.ads.sdk.businessdataapi

Class EventRequest

java.lang.Object

com.facebook.ads.sdk.businessdataapi.EventRequest

public class EventRequest
extends Object

Server side pixel event request

Constructor Summary

Constructors

Constructor and Description
EventRequest(String pageId, APIContext context) Constructor.
EventRequest(String pageId, APIContext context, List<Event> data, String partnerAgent) Constructor.

Method Summary

Modifier and Type	Method and Description
EventRequest	data(List<Event> data) Set a list of Business Data Event objects
EventResponse	execute() Synchronously send Event to Facebook GraphAPI.
List<Event>	getData() A list of Business Data Event objects
com.google.gson.Gson	getGson()
String	getPartnerAgent() A value that represents the platform that is sending the event.
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 Business Data Event objects
void	setPartnerAgent(String partnerAgent) Set a value that represents the platform that is sending the event.

Methods inherited from class java.lang.Object

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

Constructor Detail

EventRequest

public EventRequest(String pageId,
                    APIContext context)

Constructor.

Parameters:

pageId - Ad pixel id

context - Api context

EventRequest

public EventRequest(String pageId,
                    APIContext context,
                    List<Event> data,
                    String partnerAgent)

Constructor.

Parameters:

pageId - Page id

context - Api context

data - list of event

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

Method Detail

getGson

public com.google.gson.Gson getGson()

Returns:

Gson

data

public EventRequest data(List<Event> data)

Set a list of Business Data Event objects

Parameters:

data - list of Server Event

Returns:

EventRequest

getData

public List<Event> getData()

A list of Business Data Event objects

Returns:

data

setData

public void setData(List<Event> data)

Set a list of Business Data Event objects

Parameters:

data - list of Business Data 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 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

execute

public EventResponse execute()
                      throws APIException

Synchronously send Event to Facebook GraphAPI.

Returns:

event response

Throws:

APIException - Api Exception