com.facebook.ads.sdk

Class Campaign.APIRequestGetInsights

java.lang.Object

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

com.facebook.ads.sdk.Campaign.APIRequestGetInsights

Enclosing class:

Campaign

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

Overrides:

setParam in class APIRequest<AdsInsights>

setParams

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

Overrides:

setParams in class APIRequest<AdsInsights>

setDefaultSummary

public Campaign.APIRequestGetInsights setDefaultSummary(Boolean defaultSummary)

setDefaultSummary

public Campaign.APIRequestGetInsights setDefaultSummary(String defaultSummary)

setFields

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

setFields

public Campaign.APIRequestGetInsights setFields(String fields)

setFiltering

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

setFiltering

public Campaign.APIRequestGetInsights setFiltering(String filtering)

setSummary

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

setSummary

public Campaign.APIRequestGetInsights setSummary(String summary)

setSort

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

setSort

public Campaign.APIRequestGetInsights setSort(String sort)

setActionAttributionWindows

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

setActionAttributionWindows

public Campaign.APIRequestGetInsights setActionAttributionWindows(String actionAttributionWindows)

setActionBreakdowns

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

setActionBreakdowns

public Campaign.APIRequestGetInsights setActionBreakdowns(String actionBreakdowns)

setActionReportTime

public Campaign.APIRequestGetInsights setActionReportTime(AdsInsights.EnumActionReportTime actionReportTime)

setActionReportTime

public Campaign.APIRequestGetInsights setActionReportTime(String actionReportTime)

setBreakdowns

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

setBreakdowns

public Campaign.APIRequestGetInsights setBreakdowns(String breakdowns)

setDatePreset

public Campaign.APIRequestGetInsights setDatePreset(AdsInsights.EnumDatePreset datePreset)

setDatePreset

public Campaign.APIRequestGetInsights setDatePreset(String datePreset)

setExportColumns

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

setExportColumns

public Campaign.APIRequestGetInsights setExportColumns(String exportColumns)

setExportFormat

public Campaign.APIRequestGetInsights setExportFormat(String exportFormat)

setExportName

public Campaign.APIRequestGetInsights setExportName(String exportName)

setLevel

public Campaign.APIRequestGetInsights setLevel(AdsInsights.EnumLevel level)

setLevel

public Campaign.APIRequestGetInsights setLevel(String level)

setProductIdLimit

public Campaign.APIRequestGetInsights setProductIdLimit(Long productIdLimit)

setProductIdLimit

public Campaign.APIRequestGetInsights setProductIdLimit(String productIdLimit)

setSummaryActionBreakdowns

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

setSummaryActionBreakdowns

public Campaign.APIRequestGetInsights setSummaryActionBreakdowns(String summaryActionBreakdowns)

setTimeIncrement

public Campaign.APIRequestGetInsights setTimeIncrement(String timeIncrement)

setTimeRange

public Campaign.APIRequestGetInsights setTimeRange(Object timeRange)

setTimeRange

public Campaign.APIRequestGetInsights setTimeRange(String timeRange)

setTimeRanges

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

setTimeRanges

public Campaign.APIRequestGetInsights setTimeRanges(String timeRanges)

setUseAccountAttributionSetting

public Campaign.APIRequestGetInsights setUseAccountAttributionSetting(Boolean useAccountAttributionSetting)

setUseAccountAttributionSetting

public Campaign.APIRequestGetInsights setUseAccountAttributionSetting(String useAccountAttributionSetting)

requestAllFields

public Campaign.APIRequestGetInsights requestAllFields()

requestAllFields

public Campaign.APIRequestGetInsights requestAllFields(boolean value)

requestFields

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

Overrides:

requestFields in class APIRequest<AdsInsights>

requestFields

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

Overrides:

requestFields in class APIRequest<AdsInsights>

requestField

public Campaign.APIRequestGetInsights requestField(String field)

Overrides:

requestField in class APIRequest<AdsInsights>

requestField

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

Overrides:

requestField in class APIRequest<AdsInsights>