com.facebook.ads.sdk

Class User.APIRequestGetInsights

java.lang.Object

com.facebook.ads.sdk.APIRequest<InsightsResult>

com.facebook.ads.sdk.User.APIRequestGetInsights

Enclosing class:

User

public static class User.APIRequestGetInsights
extends APIRequest<InsightsResult>

Nested Class Summary

Nested classes/interfaces inherited from class com.facebook.ads.sdk.APIRequest

APIRequest.DefaultAsyncRequestExecutor, APIRequest.DefaultRequestExecutor, APIRequest.IAsyncRequestExecutor, APIRequest.IRequestExecutor, APIRequest.RequestHelper, APIRequest.ResponseParser<T extends APINode>, APIRequest.ResponseWrapper

Field Summary

Fields

Modifier and Type	Field and Description
static String[]	FIELDS
static String[]	PARAMS

Fields inherited from class com.facebook.ads.sdk.APIRequest

context, endpoint, method, nodeId, paramNames, params, parser, returnFields, USER_AGENT, useVideoEndpoint

Constructor Summary

Constructors

Constructor and Description
APIRequestGetInsights(String nodeId, APIContext context)

Method Summary

Modifier and Type	Method and Description
APINodeList<InsightsResult>	execute()
APINodeList<InsightsResult>	execute(Map<String,Object> extraParams)
com.google.common.util.concurrent.ListenableFuture<APINodeList<InsightsResult>>	executeAsync()
com.google.common.util.concurrent.ListenableFuture<APINodeList<InsightsResult>>	executeAsync(Map<String,Object> extraParams)
APINodeList<InsightsResult>	getLastResponse()
APINodeList<InsightsResult>	parseResponse(String response, String header)
User.APIRequestGetInsights	requestAllFields()
User.APIRequestGetInsights	requestAllFields(boolean value)
User.APIRequestGetInsights	requestDescriptionField()
User.APIRequestGetInsights	requestDescriptionField(boolean value)
User.APIRequestGetInsights	requestDescriptionFromApiDocField()
User.APIRequestGetInsights	requestDescriptionFromApiDocField(boolean value)
User.APIRequestGetInsights	requestField(String field)
User.APIRequestGetInsights	requestField(String field, boolean value)
User.APIRequestGetInsights	requestFields(List<String> fields)
User.APIRequestGetInsights	requestFields(List<String> fields, boolean value)
User.APIRequestGetInsights	requestIdField()
User.APIRequestGetInsights	requestIdField(boolean value)
User.APIRequestGetInsights	requestNameField()
User.APIRequestGetInsights	requestNameField(boolean value)
User.APIRequestGetInsights	requestPeriodField()
User.APIRequestGetInsights	requestPeriodField(boolean value)
User.APIRequestGetInsights	requestTitleField()
User.APIRequestGetInsights	requestTitleField(boolean value)
User.APIRequestGetInsights	requestValuesField()
User.APIRequestGetInsights	requestValuesField(boolean value)
User.APIRequestGetInsights	setDatePreset(InsightsResult.EnumDatePreset datePreset)
User.APIRequestGetInsights	setDatePreset(String datePreset)
User.APIRequestGetInsights	setMetric(List<Object> metric)
User.APIRequestGetInsights	setMetric(String metric)
User.APIRequestGetInsights	setParam(String param, Object value)
User.APIRequestGetInsights	setParams(Map<String,Object> params)
User.APIRequestGetInsights	setPeriod(InsightsResult.EnumPeriod period)
User.APIRequestGetInsights	setPeriod(String period)
User.APIRequestGetInsights	setShowDescriptionFromApiDoc(Boolean showDescriptionFromApiDoc)
User.APIRequestGetInsights	setShowDescriptionFromApiDoc(String showDescriptionFromApiDoc)
User.APIRequestGetInsights	setSince(String since)
User.APIRequestGetInsights	setUntil(String until)

Methods inherited from class com.facebook.ads.sdk.APIRequest

addToBatch, addToBatch, addToBatch, changeAsyncRequestExecutor, changeRequestExecutor, executeAsyncBase, executeAsyncBase, executeAsyncInternal, executeAsyncInternal, executeInternal, executeInternal, getAsyncExecutor, getContext, getExecutor, joinStringList, requestFieldInternal, setContext, setOverrideUrl, setParamInternal, setParamsInternal, setUseVideoEndpoint

Methods inherited from class java.lang.Object

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

Field Detail

PARAMS

public static final String[] PARAMS

FIELDS

public static final String[] FIELDS

Constructor Detail

APIRequestGetInsights

public APIRequestGetInsights(String nodeId,
                             APIContext context)

Method Detail

getLastResponse

public APINodeList<InsightsResult> getLastResponse()

Overrides:

getLastResponse in class APIRequest<InsightsResult>

parseResponse

public APINodeList<InsightsResult> parseResponse(String response,
                                                 String header)
                                          throws APIException

Overrides:

parseResponse in class APIRequest<InsightsResult>

Throws:

APIException

execute

public APINodeList<InsightsResult> execute()
                                    throws APIException

Overrides:

execute in class APIRequest<InsightsResult>

Throws:

APIException

execute

public APINodeList<InsightsResult> execute(Map<String,Object> extraParams)
                                    throws APIException

Overrides:

execute in class APIRequest<InsightsResult>

Throws:

APIException

executeAsync

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

Throws:

APIException

executeAsync

public com.google.common.util.concurrent.ListenableFuture<APINodeList<InsightsResult>> executeAsync(Map<String,Object> extraParams)
                                                                                             throws APIException

Throws:

APIException

setParam

public User.APIRequestGetInsights setParam(String param,
                                           Object value)

Overrides:

setParam in class APIRequest<InsightsResult>

setParams

public User.APIRequestGetInsights setParams(Map<String,Object> params)

Overrides:

setParams in class APIRequest<InsightsResult>

setDatePreset

public User.APIRequestGetInsights setDatePreset(InsightsResult.EnumDatePreset datePreset)

setDatePreset

public User.APIRequestGetInsights setDatePreset(String datePreset)

setMetric

public User.APIRequestGetInsights setMetric(List<Object> metric)

setMetric

public User.APIRequestGetInsights setMetric(String metric)

setPeriod

public User.APIRequestGetInsights setPeriod(InsightsResult.EnumPeriod period)

setPeriod

public User.APIRequestGetInsights setPeriod(String period)

setShowDescriptionFromApiDoc

public User.APIRequestGetInsights setShowDescriptionFromApiDoc(Boolean showDescriptionFromApiDoc)

setShowDescriptionFromApiDoc

public User.APIRequestGetInsights setShowDescriptionFromApiDoc(String showDescriptionFromApiDoc)

setSince

public User.APIRequestGetInsights setSince(String since)

setUntil

public User.APIRequestGetInsights setUntil(String until)

requestAllFields

public User.APIRequestGetInsights requestAllFields()

requestAllFields

public User.APIRequestGetInsights requestAllFields(boolean value)

requestFields

public User.APIRequestGetInsights requestFields(List<String> fields)

Overrides:

requestFields in class APIRequest<InsightsResult>

requestFields

public User.APIRequestGetInsights requestFields(List<String> fields,
                                                boolean value)

Overrides:

requestFields in class APIRequest<InsightsResult>

requestField

public User.APIRequestGetInsights requestField(String field)

Overrides:

requestField in class APIRequest<InsightsResult>

requestField

public User.APIRequestGetInsights requestField(String field,
                                               boolean value)

Overrides:

requestField in class APIRequest<InsightsResult>

requestDescriptionField

public User.APIRequestGetInsights requestDescriptionField()

requestDescriptionField

public User.APIRequestGetInsights requestDescriptionField(boolean value)

requestDescriptionFromApiDocField

public User.APIRequestGetInsights requestDescriptionFromApiDocField()

requestDescriptionFromApiDocField

public User.APIRequestGetInsights requestDescriptionFromApiDocField(boolean value)

requestIdField

public User.APIRequestGetInsights requestIdField()

requestIdField

public User.APIRequestGetInsights requestIdField(boolean value)

requestNameField

public User.APIRequestGetInsights requestNameField()

requestNameField

public User.APIRequestGetInsights requestNameField(boolean value)

requestPeriodField

public User.APIRequestGetInsights requestPeriodField()

requestPeriodField

public User.APIRequestGetInsights requestPeriodField(boolean value)

requestTitleField

public User.APIRequestGetInsights requestTitleField()

requestTitleField

public User.APIRequestGetInsights requestTitleField(boolean value)

requestValuesField

public User.APIRequestGetInsights requestValuesField()

requestValuesField

public User.APIRequestGetInsights requestValuesField(boolean value)