com.facebook.ads.sdk

Class Ad.APIRequestGetInsightsAsync

java.lang.Object

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

com.facebook.ads.sdk.Ad.APIRequestGetInsightsAsync

Enclosing class:

Ad

public static class Ad.APIRequestGetInsightsAsync
extends APIRequest<AdReportRun>

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
APIRequestGetInsightsAsync(String nodeId, APIContext context)

Method Summary

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

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

APIRequestGetInsightsAsync

public APIRequestGetInsightsAsync(String nodeId,
                                  APIContext context)

Method Detail

getLastResponse

public AdReportRun getLastResponse()

Overrides:

getLastResponse in class APIRequest<AdReportRun>

parseResponse

public AdReportRun parseResponse(String response,
                                 String header)
                          throws APIException

Overrides:

parseResponse in class APIRequest<AdReportRun>

Throws:

APIException

execute

public AdReportRun execute()
                    throws APIException

Overrides:

execute in class APIRequest<AdReportRun>

Throws:

APIException

execute

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

Overrides:

execute in class APIRequest<AdReportRun>

Throws:

APIException

executeAsync

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

Throws:

APIException

executeAsync

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

Throws:

APIException

setParam

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

Overrides:

setParam in class APIRequest<AdReportRun>

setParams

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

Overrides:

setParams in class APIRequest<AdReportRun>

setActionAttributionWindows

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

setActionAttributionWindows

public Ad.APIRequestGetInsightsAsync setActionAttributionWindows(String actionAttributionWindows)

setActionBreakdowns

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

setActionBreakdowns

public Ad.APIRequestGetInsightsAsync setActionBreakdowns(String actionBreakdowns)

setActionReportTime

public Ad.APIRequestGetInsightsAsync setActionReportTime(AdsInsights.EnumActionReportTime actionReportTime)

setActionReportTime

public Ad.APIRequestGetInsightsAsync setActionReportTime(String actionReportTime)

setBreakdowns

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

setBreakdowns

public Ad.APIRequestGetInsightsAsync setBreakdowns(String breakdowns)

setDatePreset

public Ad.APIRequestGetInsightsAsync setDatePreset(AdsInsights.EnumDatePreset datePreset)

setDatePreset

public Ad.APIRequestGetInsightsAsync setDatePreset(String datePreset)

setDefaultSummary

public Ad.APIRequestGetInsightsAsync setDefaultSummary(Boolean defaultSummary)

setDefaultSummary

public Ad.APIRequestGetInsightsAsync setDefaultSummary(String defaultSummary)

setExportColumns

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

setExportColumns

public Ad.APIRequestGetInsightsAsync setExportColumns(String exportColumns)

setExportFormat

public Ad.APIRequestGetInsightsAsync setExportFormat(String exportFormat)

setExportName

public Ad.APIRequestGetInsightsAsync setExportName(String exportName)

setFields

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

setFields

public Ad.APIRequestGetInsightsAsync setFields(String fields)

setFiltering

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

setFiltering

public Ad.APIRequestGetInsightsAsync setFiltering(String filtering)

setLevel

public Ad.APIRequestGetInsightsAsync setLevel(AdsInsights.EnumLevel level)

setLevel

public Ad.APIRequestGetInsightsAsync setLevel(String level)

setProductIdLimit

public Ad.APIRequestGetInsightsAsync setProductIdLimit(Long productIdLimit)

setProductIdLimit

public Ad.APIRequestGetInsightsAsync setProductIdLimit(String productIdLimit)

setSort

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

setSort

public Ad.APIRequestGetInsightsAsync setSort(String sort)

setSummary

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

setSummary

public Ad.APIRequestGetInsightsAsync setSummary(String summary)

setSummaryActionBreakdowns

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

setSummaryActionBreakdowns

public Ad.APIRequestGetInsightsAsync setSummaryActionBreakdowns(String summaryActionBreakdowns)

setTimeIncrement

public Ad.APIRequestGetInsightsAsync setTimeIncrement(String timeIncrement)

setTimeRange

public Ad.APIRequestGetInsightsAsync setTimeRange(Object timeRange)

setTimeRange

public Ad.APIRequestGetInsightsAsync setTimeRange(String timeRange)

setTimeRanges

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

setTimeRanges

public Ad.APIRequestGetInsightsAsync setTimeRanges(String timeRanges)

setUseAccountAttributionSetting

public Ad.APIRequestGetInsightsAsync setUseAccountAttributionSetting(Boolean useAccountAttributionSetting)

setUseAccountAttributionSetting

public Ad.APIRequestGetInsightsAsync setUseAccountAttributionSetting(String useAccountAttributionSetting)

requestAllFields

public Ad.APIRequestGetInsightsAsync requestAllFields()

requestAllFields

public Ad.APIRequestGetInsightsAsync requestAllFields(boolean value)

requestFields

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

Overrides:

requestFields in class APIRequest<AdReportRun>

requestFields

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

Overrides:

requestFields in class APIRequest<AdReportRun>

requestField

public Ad.APIRequestGetInsightsAsync requestField(String field)

Overrides:

requestField in class APIRequest<AdReportRun>

requestField

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

Overrides:

requestField in class APIRequest<AdReportRun>