com.facebook.ads.sdk

Class Campaign

java.lang.Object

com.facebook.ads.sdk.APINode

com.facebook.ads.sdk.Campaign

All Implemented Interfaces:

APIResponse

public class Campaign
extends APINode

This class is auto-generated. For any issues or feature requests related to this class, please let us know on github and we'll fix in our codegen framework. We'll not be able to accept pull request for this class.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Campaign.APIRequestCreateAdLabel
static class	Campaign.APIRequestCreateCopy
static class	Campaign.APIRequestDelete
static class	Campaign.APIRequestDeleteAdLabels
static class	Campaign.APIRequestGet
static class	Campaign.APIRequestGetAds
static class	Campaign.APIRequestGetAdSets
static class	Campaign.APIRequestGetAdStudies
static class	Campaign.APIRequestGetCopies
static class	Campaign.APIRequestGetInsights
static class	Campaign.APIRequestGetInsightsAsync
static class	Campaign.APIRequestUpdate
static class	Campaign.EnumBidStrategy
static class	Campaign.EnumConfiguredStatus
static class	Campaign.EnumDatePreset
static class	Campaign.EnumEffectiveStatus
static class	Campaign.EnumExecutionOptions
static class	Campaign.EnumObjective
static class	Campaign.EnumOperator
static class	Campaign.EnumStatus
static class	Campaign.EnumStatusOption

Field Summary

Fields

Modifier and Type	Field and Description
protected static com.google.gson.Gson	gson

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

context, rawValue

Constructor Summary

Constructors

Constructor and Description
Campaign(Long id, APIContext context)
Campaign(String id, APIContext context)

Method Summary

Modifier and Type	Method and Description
Campaign	copyFrom(Campaign instance)
Campaign.APIRequestCreateAdLabel	createAdLabel()
Campaign.APIRequestCreateCopy	createCopy()
Campaign.APIRequestDelete	delete()
Campaign.APIRequestDeleteAdLabels	deleteAdLabels()
Campaign	fetch()
static Campaign	fetchById(Long id, APIContext context)
static Campaign	fetchById(String id, APIContext context)
static com.google.common.util.concurrent.ListenableFuture<Campaign>	fetchByIdAsync(Long id, APIContext context)
static com.google.common.util.concurrent.ListenableFuture<Campaign>	fetchByIdAsync(String id, APIContext context)
static APINodeList<Campaign>	fetchByIds(List<String> ids, List<String> fields, APIContext context)
static com.google.common.util.concurrent.ListenableFuture<APINodeList<Campaign>>	fetchByIdsAsync(List<String> ids, List<String> fields, APIContext context)
Campaign.APIRequestGet	get()
Campaign.APIRequestGetAds	getAds()
Campaign.APIRequestGetAdSets	getAdSets()
Campaign.APIRequestGetAdStudies	getAdStudies()
APIContext	getContext()
Campaign.APIRequestGetCopies	getCopies()
String	getFieldAccountId()
List<AdLabel>	getFieldAdlabels()
Campaign.EnumBidStrategy	getFieldBidStrategy()
String	getFieldBoostedObjectId()
List<AdStudy>	getFieldBrandLiftStudies()
Boolean	getFieldBudgetRebalanceFlag()
String	getFieldBudgetRemaining()
String	getFieldBuyingType()
Boolean	getFieldCanCreateBrandLiftStudy()
Boolean	getFieldCanUseSpendCap()
Campaign.EnumConfiguredStatus	getFieldConfiguredStatus()
String	getFieldCreatedTime()
String	getFieldDailyBudget()
Campaign.EnumEffectiveStatus	getFieldEffectiveStatus()
String	getFieldId()
Boolean	getFieldIsAutobid()
Boolean	getFieldIsAveragePricePacing()
String	getFieldKpiCustomConversionId()
String	getFieldKpiType()
String	getFieldLastBudgetTogglingTime()
String	getFieldLifetimeBudget()
String	getFieldName()
String	getFieldObjective()
List<String>	getFieldPacingType()
AdPromotedObject	getFieldPromotedObject()
List<AdRecommendation>	getFieldRecommendations()
Campaign	getFieldSourceCampaign()
String	getFieldSourceCampaignId()
String	getFieldSpendCap()
String	getFieldStartTime()
Campaign.EnumStatus	getFieldStatus()
String	getFieldStopTime()
String	getFieldToplineId()
String	getFieldUpdatedTime()
String	getId()
Campaign.APIRequestGetInsights	getInsights()
Campaign.APIRequestGetInsightsAsync	getInsightsAsync()
static APIRequest.ResponseParser<Campaign>	getParser()
static Campaign	loadJSON(String json, APIContext context)
static APINodeList<Campaign>	parseResponse(String json, APIContext context, APIRequest request)
void	setContext(APIContext context)
String	toString()
Campaign.APIRequestUpdate	update()

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

getException, getRawResponse, getRawResponseAsJsonObject, getRawValue, head, parseResponse

Methods inherited from class java.lang.Object

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

Field Detail

gson

protected static com.google.gson.Gson gson

Constructor Detail

Campaign

public Campaign(Long id,
                APIContext context)

Campaign

public Campaign(String id,
                APIContext context)

Method Detail

fetch

public Campaign fetch()
               throws APIException

Throws:

APIException

fetchById

public static Campaign fetchById(Long id,
                                 APIContext context)
                          throws APIException

Throws:

APIException

fetchByIdAsync

public static com.google.common.util.concurrent.ListenableFuture<Campaign> fetchByIdAsync(Long id,
                                                                                          APIContext context)
                                                                                   throws APIException

Throws:

APIException

fetchById

public static Campaign fetchById(String id,
                                 APIContext context)
                          throws APIException

Throws:

APIException

fetchByIdAsync

public static com.google.common.util.concurrent.ListenableFuture<Campaign> fetchByIdAsync(String id,
                                                                                          APIContext context)
                                                                                   throws APIException

Throws:

APIException

fetchByIds

public static APINodeList<Campaign> fetchByIds(List<String> ids,
                                               List<String> fields,
                                               APIContext context)
                                        throws APIException

Throws:

APIException

fetchByIdsAsync

public static com.google.common.util.concurrent.ListenableFuture<APINodeList<Campaign>> fetchByIdsAsync(List<String> ids,
                                                                                                        List<String> fields,
                                                                                                        APIContext context)
                                                                                                 throws APIException

Throws:

APIException

getId

public String getId()

Overrides:

getId in class APINode

loadJSON

public static Campaign loadJSON(String json,
                                APIContext context)

parseResponse

public static APINodeList<Campaign> parseResponse(String json,
                                                  APIContext context,
                                                  APIRequest request)
                                           throws APIException.MalformedResponseException

Throws:

APIException.MalformedResponseException

getContext

public APIContext getContext()

Overrides:

getContext in class APINode

setContext

public void setContext(APIContext context)

Overrides:

setContext in class APINode

toString

public String toString()

Overrides:

toString in class APINode

getAdStudies

public Campaign.APIRequestGetAdStudies getAdStudies()

deleteAdLabels

public Campaign.APIRequestDeleteAdLabels deleteAdLabels()

createAdLabel

public Campaign.APIRequestCreateAdLabel createAdLabel()

getAds

public Campaign.APIRequestGetAds getAds()

getAdSets

public Campaign.APIRequestGetAdSets getAdSets()

getCopies

public Campaign.APIRequestGetCopies getCopies()

createCopy

public Campaign.APIRequestCreateCopy createCopy()

getInsights

public Campaign.APIRequestGetInsights getInsights()

getInsightsAsync

public Campaign.APIRequestGetInsightsAsync getInsightsAsync()

delete

public Campaign.APIRequestDelete delete()

get

public Campaign.APIRequestGet get()

update

public Campaign.APIRequestUpdate update()

getFieldAccountId

public String getFieldAccountId()

getFieldAdlabels

public List<AdLabel> getFieldAdlabels()

getFieldBidStrategy

public Campaign.EnumBidStrategy getFieldBidStrategy()

getFieldBoostedObjectId

public String getFieldBoostedObjectId()

getFieldBrandLiftStudies

public List<AdStudy> getFieldBrandLiftStudies()

getFieldBudgetRebalanceFlag

public Boolean getFieldBudgetRebalanceFlag()

getFieldBudgetRemaining

public String getFieldBudgetRemaining()

getFieldBuyingType

public String getFieldBuyingType()

getFieldCanCreateBrandLiftStudy

public Boolean getFieldCanCreateBrandLiftStudy()

getFieldCanUseSpendCap

public Boolean getFieldCanUseSpendCap()

getFieldConfiguredStatus

public Campaign.EnumConfiguredStatus getFieldConfiguredStatus()

getFieldCreatedTime

public String getFieldCreatedTime()

getFieldDailyBudget

public String getFieldDailyBudget()

getFieldEffectiveStatus

public Campaign.EnumEffectiveStatus getFieldEffectiveStatus()

getFieldId

public String getFieldId()

getFieldIsAutobid

public Boolean getFieldIsAutobid()

getFieldIsAveragePricePacing

public Boolean getFieldIsAveragePricePacing()

getFieldKpiCustomConversionId

public String getFieldKpiCustomConversionId()

getFieldKpiType

public String getFieldKpiType()

getFieldLastBudgetTogglingTime

public String getFieldLastBudgetTogglingTime()

getFieldLifetimeBudget

public String getFieldLifetimeBudget()

getFieldName

public String getFieldName()

getFieldObjective

public String getFieldObjective()

getFieldPacingType

public List<String> getFieldPacingType()

getFieldPromotedObject

public AdPromotedObject getFieldPromotedObject()

getFieldRecommendations

public List<AdRecommendation> getFieldRecommendations()

getFieldSourceCampaign

public Campaign getFieldSourceCampaign()

getFieldSourceCampaignId

public String getFieldSourceCampaignId()

getFieldSpendCap

public String getFieldSpendCap()

getFieldStartTime

public String getFieldStartTime()

getFieldStatus

public Campaign.EnumStatus getFieldStatus()

getFieldStopTime

public String getFieldStopTime()

getFieldToplineId

public String getFieldToplineId()

getFieldUpdatedTime

public String getFieldUpdatedTime()

copyFrom

public Campaign copyFrom(Campaign instance)

getParser

public static APIRequest.ResponseParser<Campaign> getParser()