com.facebook.ads.sdk

Class Ad.APIRequestGetInsights

java.lang.Object

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

com.facebook.ads.sdk.Ad.APIRequestGetInsights

Enclosing class:

Ad

public static class Ad.APIRequestGetInsights
extends APIRequest<AdsInsights>

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>

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<AdsInsights>	execute()
APINodeList<AdsInsights>	execute(Map<String,Object> extraParams)
com.google.common.util.concurrent.ListenableFuture<APINodeList<AdsInsights>>	executeAsync()
com.google.common.util.concurrent.ListenableFuture<APINodeList<AdsInsights>>	executeAsync(Map<String,Object> extraParams)
APINodeList<AdsInsights>	getLastResponse()
APINodeList<AdsInsights>	parseResponse(String response)
Ad.APIRequestGetInsights	requestAllFields()
Ad.APIRequestGetInsights	requestAllFields(boolean value)
Ad.APIRequestGetInsights	requestField(String field)
Ad.APIRequestGetInsights	requestField(String field, boolean value)
Ad.APIRequestGetInsights	requestFields(List<String> fields)
Ad.APIRequestGetInsights	requestFields(List<String> fields, boolean value)
Ad.APIRequestGetInsights	setActionAttributionWindows(List<AdsInsights.EnumActionAttributionWindows> actionAttributionWindows)
Ad.APIRequestGetInsights	setActionAttributionWindows(String actionAttributionWindows)
Ad.APIRequestGetInsights	setActionBreakdowns(List<AdsInsights.EnumActionBreakdowns> actionBreakdowns)
Ad.APIRequestGetInsights	setActionBreakdowns(String actionBreakdowns)
Ad.APIRequestGetInsights	setActionReportTime(AdsInsights.EnumActionReportTime actionReportTime)
Ad.APIRequestGetInsights	setActionReportTime(String actionReportTime)
Ad.APIRequestGetInsights	setBreakdowns(List<AdsInsights.EnumBreakdowns> breakdowns)
Ad.APIRequestGetInsights	setBreakdowns(String breakdowns)
Ad.APIRequestGetInsights	setDatePreset(AdsInsights.EnumDatePreset datePreset)
Ad.APIRequestGetInsights	setDatePreset(String datePreset)
Ad.APIRequestGetInsights	setDefaultSummary(Boolean defaultSummary)
Ad.APIRequestGetInsights	setDefaultSummary(String defaultSummary)
Ad.APIRequestGetInsights	setExportColumns(List<String> exportColumns)
Ad.APIRequestGetInsights	setExportColumns(String exportColumns)
Ad.APIRequestGetInsights	setExportFormat(String exportFormat)
Ad.APIRequestGetInsights	setExportName(String exportName)
Ad.APIRequestGetInsights	setFields(List<String> fields)
Ad.APIRequestGetInsights	setFields(String fields)
Ad.APIRequestGetInsights	setFiltering(List<Object> filtering)
Ad.APIRequestGetInsights	setFiltering(String filtering)
Ad.APIRequestGetInsights	setLevel(AdsInsights.EnumLevel level)
Ad.APIRequestGetInsights	setLevel(String level)
Ad.APIRequestGetInsights	setParam(String param, Object value)
Ad.APIRequestGetInsights	setParams(Map<String,Object> params)
Ad.APIRequestGetInsights	setProductIdLimit(Long productIdLimit)
Ad.APIRequestGetInsights	setProductIdLimit(String productIdLimit)
Ad.APIRequestGetInsights	setSort(List<String> sort)
Ad.APIRequestGetInsights	setSort(String sort)
Ad.APIRequestGetInsights	setSummary(List<String> summary)
Ad.APIRequestGetInsights	setSummary(String summary)
Ad.APIRequestGetInsights	setSummaryActionBreakdowns(List<AdsInsights.EnumSummaryActionBreakdowns> summaryActionBreakdowns)
Ad.APIRequestGetInsights	setSummaryActionBreakdowns(String summaryActionBreakdowns)
Ad.APIRequestGetInsights	setTimeIncrement(String timeIncrement)
Ad.APIRequestGetInsights	setTimeRange(Object timeRange)
Ad.APIRequestGetInsights	setTimeRange(String timeRange)
Ad.APIRequestGetInsights	setTimeRanges(List<Object> timeRanges)
Ad.APIRequestGetInsights	setTimeRanges(String timeRanges)
Ad.APIRequestGetInsights	setUseAccountAttributionSetting(Boolean useAccountAttributionSetting)
Ad.APIRequestGetInsights	setUseAccountAttributionSetting(String useAccountAttributionSetting)

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

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<AdsInsights> getLastResponse()

Overrides:

getLastResponse in class APIRequest<AdsInsights>

parseResponse

public APINodeList<AdsInsights> parseResponse(String response)
                                       throws APIException

Overrides:

parseResponse in class APIRequest<AdsInsights>

Throws:

APIException

execute

public APINodeList<AdsInsights> execute()
                                 throws APIException

Overrides:

execute in class APIRequest<AdsInsights>

Throws:

APIException

execute

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

Overrides:

execute in class APIRequest<AdsInsights>

Throws:

APIException

executeAsync

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

Throws:

APIException

executeAsync

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

Throws:

APIException

setParam

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

Overrides:

setParam in class APIRequest<AdsInsights>

setParams

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

Overrides:

setParams in class APIRequest<AdsInsights>

setDefaultSummary

public Ad.APIRequestGetInsights setDefaultSummary(Boolean defaultSummary)

setDefaultSummary

public Ad.APIRequestGetInsights setDefaultSummary(String defaultSummary)

setFields

public Ad.APIRequestGetInsights setFields(List<String> fields)

setFields

public Ad.APIRequestGetInsights setFields(String fields)

setFiltering

public Ad.APIRequestGetInsights setFiltering(List<Object> filtering)

setFiltering

public Ad.APIRequestGetInsights setFiltering(String filtering)

setSummary

public Ad.APIRequestGetInsights setSummary(List<String> summary)

setSummary

public Ad.APIRequestGetInsights setSummary(String summary)

setSort

public Ad.APIRequestGetInsights setSort(List<String> sort)

setSort

public Ad.APIRequestGetInsights setSort(String sort)

setActionAttributionWindows

public Ad.APIRequestGetInsights setActionAttributionWindows(List<AdsInsights.EnumActionAttributionWindows> actionAttributionWindows)

setActionAttributionWindows

public Ad.APIRequestGetInsights setActionAttributionWindows(String actionAttributionWindows)

setActionBreakdowns

public Ad.APIRequestGetInsights setActionBreakdowns(List<AdsInsights.EnumActionBreakdowns> actionBreakdowns)

setActionBreakdowns

public Ad.APIRequestGetInsights setActionBreakdowns(String actionBreakdowns)

setActionReportTime

public Ad.APIRequestGetInsights setActionReportTime(AdsInsights.EnumActionReportTime actionReportTime)

setActionReportTime

public Ad.APIRequestGetInsights setActionReportTime(String actionReportTime)

setBreakdowns

public Ad.APIRequestGetInsights setBreakdowns(List<AdsInsights.EnumBreakdowns> breakdowns)

setBreakdowns

public Ad.APIRequestGetInsights setBreakdowns(String breakdowns)

setDatePreset

public Ad.APIRequestGetInsights setDatePreset(AdsInsights.EnumDatePreset datePreset)

setDatePreset

public Ad.APIRequestGetInsights setDatePreset(String datePreset)

setExportColumns

public Ad.APIRequestGetInsights setExportColumns(List<String> exportColumns)

setExportColumns

public Ad.APIRequestGetInsights setExportColumns(String exportColumns)

setExportFormat

public Ad.APIRequestGetInsights setExportFormat(String exportFormat)

setExportName

public Ad.APIRequestGetInsights setExportName(String exportName)

setLevel

public Ad.APIRequestGetInsights setLevel(AdsInsights.EnumLevel level)

setLevel

public Ad.APIRequestGetInsights setLevel(String level)

setProductIdLimit

public Ad.APIRequestGetInsights setProductIdLimit(Long productIdLimit)

setProductIdLimit

public Ad.APIRequestGetInsights setProductIdLimit(String productIdLimit)

setSummaryActionBreakdowns

public Ad.APIRequestGetInsights setSummaryActionBreakdowns(List<AdsInsights.EnumSummaryActionBreakdowns> summaryActionBreakdowns)

setSummaryActionBreakdowns

public Ad.APIRequestGetInsights setSummaryActionBreakdowns(String summaryActionBreakdowns)

setTimeIncrement

public Ad.APIRequestGetInsights setTimeIncrement(String timeIncrement)

setTimeRange

public Ad.APIRequestGetInsights setTimeRange(Object timeRange)

setTimeRange

public Ad.APIRequestGetInsights setTimeRange(String timeRange)

setTimeRanges

public Ad.APIRequestGetInsights setTimeRanges(List<Object> timeRanges)

setTimeRanges

public Ad.APIRequestGetInsights setTimeRanges(String timeRanges)

setUseAccountAttributionSetting

public Ad.APIRequestGetInsights setUseAccountAttributionSetting(Boolean useAccountAttributionSetting)

setUseAccountAttributionSetting

public Ad.APIRequestGetInsights setUseAccountAttributionSetting(String useAccountAttributionSetting)

requestAllFields

public Ad.APIRequestGetInsights requestAllFields()

requestAllFields

public Ad.APIRequestGetInsights requestAllFields(boolean value)

requestFields

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

Overrides:

requestFields in class APIRequest<AdsInsights>

requestFields

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

Overrides:

requestFields in class APIRequest<AdsInsights>

requestField

public Ad.APIRequestGetInsights requestField(String field)

Overrides:

requestField in class APIRequest<AdsInsights>

requestField

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

Overrides:

requestField in class APIRequest<AdsInsights>