com.facebook.ads.sdk

Class Campaign.APIRequestUpdate

java.lang.Object

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

com.facebook.ads.sdk.Campaign.APIRequestUpdate

Enclosing class:

Campaign

public static class Campaign.APIRequestUpdate
extends APIRequest<Campaign>

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

Method Summary

Modifier and Type	Method and Description
Campaign	execute()
Campaign	execute(Map<String,Object> extraParams)
com.google.common.util.concurrent.ListenableFuture<Campaign>	executeAsync()
com.google.common.util.concurrent.ListenableFuture<Campaign>	executeAsync(Map<String,Object> extraParams)
Campaign	getLastResponse()
Campaign	parseResponse(String response, String header)
Campaign.APIRequestUpdate	requestAllFields()
Campaign.APIRequestUpdate	requestAllFields(boolean value)
Campaign.APIRequestUpdate	requestField(String field)
Campaign.APIRequestUpdate	requestField(String field, boolean value)
Campaign.APIRequestUpdate	requestFields(List<String> fields)
Campaign.APIRequestUpdate	requestFields(List<String> fields, boolean value)
Campaign.APIRequestUpdate	setAdlabels(List<Object> adlabels)
Campaign.APIRequestUpdate	setAdlabels(String adlabels)
Campaign.APIRequestUpdate	setAdsetBidAmounts(Map<String,String> adsetBidAmounts)
Campaign.APIRequestUpdate	setAdsetBidAmounts(String adsetBidAmounts)
Campaign.APIRequestUpdate	setAdsetBudgets(List<Map<String,String>> adsetBudgets)
Campaign.APIRequestUpdate	setAdsetBudgets(String adsetBudgets)
Campaign.APIRequestUpdate	setBidStrategy(Campaign.EnumBidStrategy bidStrategy)
Campaign.APIRequestUpdate	setBidStrategy(String bidStrategy)
Campaign.APIRequestUpdate	setBudgetRebalanceFlag(Boolean budgetRebalanceFlag)
Campaign.APIRequestUpdate	setBudgetRebalanceFlag(String budgetRebalanceFlag)
Campaign.APIRequestUpdate	setBudgetScheduleSpecs(List<Object> budgetScheduleSpecs)
Campaign.APIRequestUpdate	setBudgetScheduleSpecs(String budgetScheduleSpecs)
Campaign.APIRequestUpdate	setDailyBudget(Long dailyBudget)
Campaign.APIRequestUpdate	setDailyBudget(String dailyBudget)
Campaign.APIRequestUpdate	setExecutionOptions(List<Campaign.EnumExecutionOptions> executionOptions)
Campaign.APIRequestUpdate	setExecutionOptions(String executionOptions)
Campaign.APIRequestUpdate	setIsAdsetBudgetSharingEnabled(Boolean isAdsetBudgetSharingEnabled)
Campaign.APIRequestUpdate	setIsAdsetBudgetSharingEnabled(String isAdsetBudgetSharingEnabled)
Campaign.APIRequestUpdate	setIsBudgetScheduleEnabled(Boolean isBudgetScheduleEnabled)
Campaign.APIRequestUpdate	setIsBudgetScheduleEnabled(String isBudgetScheduleEnabled)
Campaign.APIRequestUpdate	setIsDirectSendCampaign(Boolean isDirectSendCampaign)
Campaign.APIRequestUpdate	setIsDirectSendCampaign(String isDirectSendCampaign)
Campaign.APIRequestUpdate	setIsMessageCampaign(Boolean isMessageCampaign)
Campaign.APIRequestUpdate	setIsMessageCampaign(String isMessageCampaign)
Campaign.APIRequestUpdate	setIsSkadnetworkAttribution(Boolean isSkadnetworkAttribution)
Campaign.APIRequestUpdate	setIsSkadnetworkAttribution(String isSkadnetworkAttribution)
Campaign.APIRequestUpdate	setIterativeSplitTestConfigs(List<Object> iterativeSplitTestConfigs)
Campaign.APIRequestUpdate	setIterativeSplitTestConfigs(String iterativeSplitTestConfigs)
Campaign.APIRequestUpdate	setLifetimeBudget(Long lifetimeBudget)
Campaign.APIRequestUpdate	setLifetimeBudget(String lifetimeBudget)
Campaign.APIRequestUpdate	setMigrateToAdvantagePlus(Boolean migrateToAdvantagePlus)
Campaign.APIRequestUpdate	setMigrateToAdvantagePlus(String migrateToAdvantagePlus)
Campaign.APIRequestUpdate	setName(String name)
Campaign.APIRequestUpdate	setObjective(Campaign.EnumObjective objective)
Campaign.APIRequestUpdate	setObjective(String objective)
Campaign.APIRequestUpdate	setPacingType(List<String> pacingType)
Campaign.APIRequestUpdate	setPacingType(String pacingType)
Campaign.APIRequestUpdate	setParam(String param, Object value)
Campaign.APIRequestUpdate	setParams(Map<String,Object> params)
Campaign.APIRequestUpdate	setPromotedObject(Object promotedObject)
Campaign.APIRequestUpdate	setPromotedObject(String promotedObject)
Campaign.APIRequestUpdate	setSmartPromotionType(Campaign.EnumSmartPromotionType smartPromotionType)
Campaign.APIRequestUpdate	setSmartPromotionType(String smartPromotionType)
Campaign.APIRequestUpdate	setSpecialAdCategories(List<Campaign.EnumSpecialAdCategories> specialAdCategories)
Campaign.APIRequestUpdate	setSpecialAdCategories(String specialAdCategories)
Campaign.APIRequestUpdate	setSpecialAdCategory(Campaign.EnumSpecialAdCategory specialAdCategory)
Campaign.APIRequestUpdate	setSpecialAdCategory(String specialAdCategory)
Campaign.APIRequestUpdate	setSpecialAdCategoryCountry(List<Campaign.EnumSpecialAdCategoryCountry> specialAdCategoryCountry)
Campaign.APIRequestUpdate	setSpecialAdCategoryCountry(String specialAdCategoryCountry)
Campaign.APIRequestUpdate	setSpendCap(Long spendCap)
Campaign.APIRequestUpdate	setSpendCap(String spendCap)
Campaign.APIRequestUpdate	setStartTime(String startTime)
Campaign.APIRequestUpdate	setStatus(Campaign.EnumStatus status)
Campaign.APIRequestUpdate	setStatus(String status)
Campaign.APIRequestUpdate	setStopTime(String stopTime)

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

APIRequestUpdate

public APIRequestUpdate(String nodeId,
                        APIContext context)

Method Detail

getLastResponse

public Campaign getLastResponse()

Overrides:

getLastResponse in class APIRequest<Campaign>

parseResponse

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

Overrides:

parseResponse in class APIRequest<Campaign>

Throws:

APIException

execute

public Campaign execute()
                 throws APIException

Overrides:

execute in class APIRequest<Campaign>

Throws:

APIException

execute

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

Overrides:

execute in class APIRequest<Campaign>

Throws:

APIException

executeAsync

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

Throws:

APIException

executeAsync

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

Throws:

APIException

setParam

public Campaign.APIRequestUpdate setParam(String param,
                                          Object value)

Overrides:

setParam in class APIRequest<Campaign>

setParams

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

Overrides:

setParams in class APIRequest<Campaign>

setAdlabels

public Campaign.APIRequestUpdate setAdlabels(List<Object> adlabels)

setAdlabels

public Campaign.APIRequestUpdate setAdlabels(String adlabels)

setAdsetBidAmounts

public Campaign.APIRequestUpdate setAdsetBidAmounts(Map<String,String> adsetBidAmounts)

setAdsetBidAmounts

public Campaign.APIRequestUpdate setAdsetBidAmounts(String adsetBidAmounts)

setAdsetBudgets

public Campaign.APIRequestUpdate setAdsetBudgets(List<Map<String,String>> adsetBudgets)

setAdsetBudgets

public Campaign.APIRequestUpdate setAdsetBudgets(String adsetBudgets)

setBidStrategy

public Campaign.APIRequestUpdate setBidStrategy(Campaign.EnumBidStrategy bidStrategy)

setBidStrategy

public Campaign.APIRequestUpdate setBidStrategy(String bidStrategy)

setBudgetRebalanceFlag

public Campaign.APIRequestUpdate setBudgetRebalanceFlag(Boolean budgetRebalanceFlag)

setBudgetRebalanceFlag

public Campaign.APIRequestUpdate setBudgetRebalanceFlag(String budgetRebalanceFlag)

setBudgetScheduleSpecs

public Campaign.APIRequestUpdate setBudgetScheduleSpecs(List<Object> budgetScheduleSpecs)

setBudgetScheduleSpecs

public Campaign.APIRequestUpdate setBudgetScheduleSpecs(String budgetScheduleSpecs)

setDailyBudget

public Campaign.APIRequestUpdate setDailyBudget(Long dailyBudget)

setDailyBudget

public Campaign.APIRequestUpdate setDailyBudget(String dailyBudget)

setExecutionOptions

public Campaign.APIRequestUpdate setExecutionOptions(List<Campaign.EnumExecutionOptions> executionOptions)

setExecutionOptions

public Campaign.APIRequestUpdate setExecutionOptions(String executionOptions)

setIsAdsetBudgetSharingEnabled

public Campaign.APIRequestUpdate setIsAdsetBudgetSharingEnabled(Boolean isAdsetBudgetSharingEnabled)

setIsAdsetBudgetSharingEnabled

public Campaign.APIRequestUpdate setIsAdsetBudgetSharingEnabled(String isAdsetBudgetSharingEnabled)

setIsBudgetScheduleEnabled

public Campaign.APIRequestUpdate setIsBudgetScheduleEnabled(Boolean isBudgetScheduleEnabled)

setIsBudgetScheduleEnabled

public Campaign.APIRequestUpdate setIsBudgetScheduleEnabled(String isBudgetScheduleEnabled)

setIsDirectSendCampaign

public Campaign.APIRequestUpdate setIsDirectSendCampaign(Boolean isDirectSendCampaign)

setIsDirectSendCampaign

public Campaign.APIRequestUpdate setIsDirectSendCampaign(String isDirectSendCampaign)

setIsMessageCampaign

public Campaign.APIRequestUpdate setIsMessageCampaign(Boolean isMessageCampaign)

setIsMessageCampaign

public Campaign.APIRequestUpdate setIsMessageCampaign(String isMessageCampaign)

setIsSkadnetworkAttribution

public Campaign.APIRequestUpdate setIsSkadnetworkAttribution(Boolean isSkadnetworkAttribution)

setIsSkadnetworkAttribution

public Campaign.APIRequestUpdate setIsSkadnetworkAttribution(String isSkadnetworkAttribution)

setIterativeSplitTestConfigs

public Campaign.APIRequestUpdate setIterativeSplitTestConfigs(List<Object> iterativeSplitTestConfigs)

setIterativeSplitTestConfigs

public Campaign.APIRequestUpdate setIterativeSplitTestConfigs(String iterativeSplitTestConfigs)

setLifetimeBudget

public Campaign.APIRequestUpdate setLifetimeBudget(Long lifetimeBudget)

setLifetimeBudget

public Campaign.APIRequestUpdate setLifetimeBudget(String lifetimeBudget)

setMigrateToAdvantagePlus

public Campaign.APIRequestUpdate setMigrateToAdvantagePlus(Boolean migrateToAdvantagePlus)

setMigrateToAdvantagePlus

public Campaign.APIRequestUpdate setMigrateToAdvantagePlus(String migrateToAdvantagePlus)

setName

public Campaign.APIRequestUpdate setName(String name)

setObjective

public Campaign.APIRequestUpdate setObjective(Campaign.EnumObjective objective)

setObjective

public Campaign.APIRequestUpdate setObjective(String objective)

setPacingType

public Campaign.APIRequestUpdate setPacingType(List<String> pacingType)

setPacingType

public Campaign.APIRequestUpdate setPacingType(String pacingType)

setPromotedObject

public Campaign.APIRequestUpdate setPromotedObject(Object promotedObject)

setPromotedObject

public Campaign.APIRequestUpdate setPromotedObject(String promotedObject)

setSmartPromotionType

public Campaign.APIRequestUpdate setSmartPromotionType(Campaign.EnumSmartPromotionType smartPromotionType)

setSmartPromotionType

public Campaign.APIRequestUpdate setSmartPromotionType(String smartPromotionType)

setSpecialAdCategories

public Campaign.APIRequestUpdate setSpecialAdCategories(List<Campaign.EnumSpecialAdCategories> specialAdCategories)

setSpecialAdCategories

public Campaign.APIRequestUpdate setSpecialAdCategories(String specialAdCategories)

setSpecialAdCategory

public Campaign.APIRequestUpdate setSpecialAdCategory(Campaign.EnumSpecialAdCategory specialAdCategory)

setSpecialAdCategory

public Campaign.APIRequestUpdate setSpecialAdCategory(String specialAdCategory)

setSpecialAdCategoryCountry

public Campaign.APIRequestUpdate setSpecialAdCategoryCountry(List<Campaign.EnumSpecialAdCategoryCountry> specialAdCategoryCountry)

setSpecialAdCategoryCountry

public Campaign.APIRequestUpdate setSpecialAdCategoryCountry(String specialAdCategoryCountry)

setSpendCap

public Campaign.APIRequestUpdate setSpendCap(Long spendCap)

setSpendCap

public Campaign.APIRequestUpdate setSpendCap(String spendCap)

setStartTime

public Campaign.APIRequestUpdate setStartTime(String startTime)

setStatus

public Campaign.APIRequestUpdate setStatus(Campaign.EnumStatus status)

setStatus

public Campaign.APIRequestUpdate setStatus(String status)

setStopTime

public Campaign.APIRequestUpdate setStopTime(String stopTime)

requestAllFields

public Campaign.APIRequestUpdate requestAllFields()

requestAllFields

public Campaign.APIRequestUpdate requestAllFields(boolean value)

requestFields

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

Overrides:

requestFields in class APIRequest<Campaign>

requestFields

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

Overrides:

requestFields in class APIRequest<Campaign>

requestField

public Campaign.APIRequestUpdate requestField(String field)

Overrides:

requestField in class APIRequest<Campaign>

requestField

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

Overrides:

requestField in class APIRequest<Campaign>