java.lang.Object
- com.restfb.types.AbstractFacebookType
- - com.restfb.types.ads.BaseAdsObject
  - - com.restfb.types.ads.NamedAdsObject
    - - com.restfb.types.ads.Campaign

All Implemented Interfaces:

HasCreatedTime, Serializable
```
public class Campaign
extends NamedAdsObject
implements HasCreatedTime
```
Represents the Campaign Marketing API type

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor Description

Campaign()

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`String`	`getAccountId()`
`List<AdLabel>`	`getAdlabels()`
`String`	`getBidStrategy()`	Bid strategy for this campaign
`String`	`getBoostedObjectId()`	The Boosted Object this campaign has associated, if any
`List<AdStudy>`	`getBrandLiftStudies()`	Automated Brand Lift V2 studies for this ad set.
`Boolean`	`getBudgetRebalanceFlag()`	Whether to automatically rebalance budgets daily for all the adsets under this campaign.
`String`	`getBudgetRemaining()`	Remaining budget
`String`	`getBuyingType()`
`Boolean`	`getCanCreateBrandLiftStudy()`	If we can create a new automated brand lift study for the ad set.
`Boolean`	`getCanUseSpendCap()`
`String`	`getConfiguredStatus()`
`Date`	`getCreatedTime()`
`String`	`getDailyBudget()`	The daily budget of the campaign
`String`	`getEffectiveStatus()`
`List<AdCampaignIssuesInfo>`	`getIssuesInfo()`
`Date`	`getLastBudgetTogglingTime()`	Last budget toggling time
`String`	`getLifetimeBudget()`	The lifetime budget of the campaign
`String`	`getObjective()`
`List<AdRecommendation>`	`getRecommendations()`
`Campaign`	`getSourceCampaign()`	The source campaign that this campaign is copied from
`String`	`getSourceCampaignId()`	The source campaign id that this campaign is copied from
`List<String>`	`getSpecialAdCategories()`
`String`	`getSpecialAdCategory()`	Deprecated.
`String`	`getSpendCap()`
`Date`	`getStartTime()`
`String`	`getStatus()`
`Date`	`getStopTime()`
`String`	`getToplineId()`	Topline ID
`Date`	`getUpdatedTime()`
`void`	`setAccountId(String accountId)`	ID of the ad account that owns this campaign
`void`	`setAdlabels(List<AdLabel> adlabels)`	Ad Labels associated with this campaign
`void`	`setBidStrategy(String bidStrategy)`	Bid strategy for this campaign
`void`	`setBoostedObjectId(String boostedObjectId)`	The Boosted Object this campaign has associated, if any
`void`	`setBrandLiftStudies(List<AdStudy> brandLiftStudies)`	Automated Brand Lift V2 studies for this ad set.
`void`	`setBudgetRebalanceFlag(Boolean budgetRebalanceFlag)`	Whether to automatically rebalance budgets daily for all the adsets under this campaign.
`void`	`setBudgetRemaining(String budgetRemaining)`	Remaining budget
`void`	`setBuyingType(String buyingType)`	Buying type, possible values are: AUCTION: default RESERVED: for reach and frequency ads
`void`	`setCanCreateBrandLiftStudy(Boolean canCreateBrandLiftStudy)`	If we can create a new automated brand lift study for the ad set.
`void`	`setCanUseSpendCap(Boolean canUseSpendCap)`	Whether the campaign can set the spend cap
`void`	`setConfiguredStatus(String configuredStatus)`	If this status is PAUSED, all its active ad sets and ads will be paused and have an effective status CAMPAIGN_PAUSED.
`void`	`setCreatedTime(Date createdTime)`	Created Time
`void`	`setDailyBudget(String dailyBudget)`	The daily budget of the campaign
`void`	`setEffectiveStatus(String effectiveStatus)`	The effective status of this campaign.
`void`	`setIssuesInfo(List<AdCampaignIssuesInfo> issuesInfo)`	Issues for this campaign that prevented it from deliverying.
`void`	`setLastBudgetTogglingTime(Date lastBudgetTogglingTime)`	Last budget toggling time
`void`	`setLifetimeBudget(String lifetimeBudget)`	The lifetime budget of the campaign
`void`	`setObjective(String objective)`	Campaign's objective
`void`	`setRecommendations(List<AdRecommendation> recommendations)`	If there are recommendations for this campaign, this field includes them.
`void`	`setSourceCampaign(Campaign sourceCampaign)`	The source campaign that this campaign is copied from
`void`	`setSourceCampaignId(String sourceCampaignId)`	The source campaign id that this campaign is copied from
`void`	`setSpecialAdCategories(List<String> specialAdCategories)`
`void`	`setSpecialAdCategory(String specialAdCategory)`	Deprecated.
`void`	`setSpendCap(String spendCap)`	A spend cap for the campaign, such that it will not spend more than this cap.
`void`	`setStartTime(Date startTime)`	Start Time
`void`	`setStatus(String status)`	If this status is PAUSED, all its active ad sets and ads will be paused and have an effective status CAMPAIGN_PAUSED.
`void`	`setStopTime(Date stopTime)`	Stop Time
`void`	`setToplineId(String toplineId)`	Topline ID
`void`	`setUpdatedTime(Date updatedTime)`	Updated Time

Methods inherited from class com.restfb.types.ads.NamedAdsObject
getName, setName

Methods inherited from class com.restfb.types.ads.BaseAdsObject
getId, setId

Methods inherited from class com.restfb.types.AbstractFacebookType
equals, hashCode, toString

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Campaign
```
public Campaign()
```
- Method Detail
  - getAccountId
```
public String getAccountId()
```
    Returns:
    
    ID of the ad account that owns this campaign
  - setAccountId
```
public void setAccountId(String accountId)
```
    ID of the ad account that owns this campaign
  - getAdlabels
```
public List<AdLabel> getAdlabels()
```
    Returns:
    
    Ad Labels associated with this campaign
  - setAdlabels
```
public void setAdlabels(List<AdLabel> adlabels)
```
    Ad Labels associated with this campaign
  - getBidStrategy
```
public String getBidStrategy()
```
    Bid strategy for this campaign
  - setBidStrategy
```
public void setBidStrategy(String bidStrategy)
```
    Bid strategy for this campaign
  - getBoostedObjectId
```
public String getBoostedObjectId()
```
    The Boosted Object this campaign has associated, if any
  - setBoostedObjectId
```
public void setBoostedObjectId(String boostedObjectId)
```
    The Boosted Object this campaign has associated, if any
  - getBrandLiftStudies
```
public List<AdStudy> getBrandLiftStudies()
```
    Automated Brand Lift V2 studies for this ad set.
  - setBrandLiftStudies
```
public void setBrandLiftStudies(List<AdStudy> brandLiftStudies)
```
    Automated Brand Lift V2 studies for this ad set.
  - getBudgetRebalanceFlag
```
public Boolean getBudgetRebalanceFlag()
```
    Whether to automatically rebalance budgets daily for all the adsets under this campaign.
  - setBudgetRebalanceFlag
```
public void setBudgetRebalanceFlag(Boolean budgetRebalanceFlag)
```
    Whether to automatically rebalance budgets daily for all the adsets under this campaign.
  - getBudgetRemaining
```
public String getBudgetRemaining()
```
    Remaining budget
  - setBudgetRemaining
```
public void setBudgetRemaining(String budgetRemaining)
```
    Remaining budget
  - getBuyingType
```
public String getBuyingType()
```
    Returns:
    
    Buying type
  - setBuyingType
```
public void setBuyingType(String buyingType)
```
    Buying type, possible values are:
    
    AUCTION: default
    
    RESERVED: for reach and frequency ads
  - getCanCreateBrandLiftStudy
```
public Boolean getCanCreateBrandLiftStudy()
```
    If we can create a new automated brand lift study for the ad set.
  - setCanCreateBrandLiftStudy
```
public void setCanCreateBrandLiftStudy(Boolean canCreateBrandLiftStudy)
```
    If we can create a new automated brand lift study for the ad set.
  - getCanUseSpendCap
```
public Boolean getCanUseSpendCap()
```
    Returns:
    
    Whether the campaign can set the spend cap
  - setCanUseSpendCap
```
public void setCanUseSpendCap(Boolean canUseSpendCap)
```
    Whether the campaign can set the spend cap
  - getConfiguredStatus
```
public String getConfiguredStatus()
```
    Returns:
    
    the configured status
  - setConfiguredStatus
```
public void setConfiguredStatus(String configuredStatus)
```
    If this status is PAUSED, all its active ad sets and ads will be paused and have an effective status CAMPAIGN_PAUSED. Prefer using 'status' instead of this. possible values: ACTIVE, PAUSED, DELETED, ARCHIVED
  - getCreatedTime
```
public Date getCreatedTime()
```
    Specified by:
    
    getCreatedTime in interface HasCreatedTime
    
    Returns:
    
    Created Time
  - setCreatedTime
```
public void setCreatedTime(Date createdTime)
```
    Created Time
  - getDailyBudget
```
public String getDailyBudget()
```
    The daily budget of the campaign
  - setDailyBudget
```
public void setDailyBudget(String dailyBudget)
```
    The daily budget of the campaign
  - getEffectiveStatus
```
public String getEffectiveStatus()
```
    Returns:
    
    The effective status of this campaign
  - setEffectiveStatus
```
public void setEffectiveStatus(String effectiveStatus)
```
    The effective status of this campaign. possible values: ACTIVE, PAUSED, DELETED, PENDING_REVIEW, DISAPPROVED, PREAPPROVED, PENDING_BILLING_INFO, CAMPAIGN_PAUSED, ARCHIVED, ADSET_PAUSED
  - getIssuesInfo
```
@GraphAPI(since="3.2")
public List<AdCampaignIssuesInfo> getIssuesInfo()
```
    Returns:
    
    List of issues for this campaign that prevented it from deliverying.
  - setIssuesInfo
```
public void setIssuesInfo(List<AdCampaignIssuesInfo> issuesInfo)
```
    Issues for this campaign that prevented it from deliverying.
  - getLastBudgetTogglingTime
```
public Date getLastBudgetTogglingTime()
```
    Last budget toggling time
  - setLastBudgetTogglingTime
```
public void setLastBudgetTogglingTime(Date lastBudgetTogglingTime)
```
    Last budget toggling time
  - getLifetimeBudget
```
public String getLifetimeBudget()
```
    The lifetime budget of the campaign
  - setLifetimeBudget
```
public void setLifetimeBudget(String lifetimeBudget)
```
    The lifetime budget of the campaign
  - getObjective
```
public String getObjective()
```
    Returns:
    
    Campaign's objective
  - setObjective
```
public void setObjective(String objective)
```
    Campaign's objective
  - getRecommendations
```
public List<AdRecommendation> getRecommendations()
```
    Returns:
    
    If there are recommendations for this campaign, this field includes them.
  - setRecommendations
```
public void setRecommendations(List<AdRecommendation> recommendations)
```
    If there are recommendations for this campaign, this field includes them.
  - getSourceCampaign
```
public Campaign getSourceCampaign()
```
    The source campaign that this campaign is copied from
  - setSourceCampaign
```
public void setSourceCampaign(Campaign sourceCampaign)
```
    The source campaign that this campaign is copied from
  - getSourceCampaignId
```
public String getSourceCampaignId()
```
    The source campaign id that this campaign is copied from
  - setSourceCampaignId
```
public void setSourceCampaignId(String sourceCampaignId)
```
    The source campaign id that this campaign is copied from
  - getSpecialAdCategory
```
@Deprecated
public String getSpecialAdCategory()
```
    Deprecated.
    
    The campaign's Special Ad Category. One of HOUSING, EMPLOYMENT, CREDIT, or NONE.
  - setSpecialAdCategory
```
@Deprecated
public void setSpecialAdCategory(String specialAdCategory)
```
    Deprecated.
    
    The campaign's Special Ad Category. One of HOUSING, EMPLOYMENT, CREDIT, or NONE.
  - getSpecialAdCategories
```
public List<String> getSpecialAdCategories()
```
  - setSpecialAdCategories
```
public void setSpecialAdCategories(List<String> specialAdCategories)
```
  - getSpendCap
```
public String getSpendCap()
```
    Returns:
    
    A spend cap for the campaign, such that it will not spend more than this cap.
  - setSpendCap
```
public void setSpendCap(String spendCap)
```
    A spend cap for the campaign, such that it will not spend more than this cap. Expressed as integer value of the subunit in your currency.
  - getStartTime
```
public Date getStartTime()
```
    Returns:
    
    Start Time
  - setStartTime
```
public void setStartTime(Date startTime)
```
    Start Time
  - getStatus
```
public String getStatus()
```
    Returns:
    
    the status
  - setStatus
```
public void setStatus(String status)
```
    If this status is PAUSED, all its active ad sets and ads will be paused and have an effective status CAMPAIGN_PAUSED. The field returns the same value as 'configured_status', and is the suggested one to use.
  - getStopTime
```
public Date getStopTime()
```
    Returns:
    
    Stop Time
  - setStopTime
```
public void setStopTime(Date stopTime)
```
    Stop Time
  - getToplineId
```
public String getToplineId()
```
    Topline ID
  - setToplineId
```
public void setToplineId(String toplineId)
```
    Topline ID
  - getUpdatedTime
```
public Date getUpdatedTime()
```
    Returns:
    
    Updated Time
  - setUpdatedTime
```
public void setUpdatedTime(Date updatedTime)
```
    Updated Time

Class Campaign

Constructor Summary

Method Summary

Methods inherited from class com.restfb.types.ads.NamedAdsObject

Methods inherited from class com.restfb.types.ads.BaseAdsObject

Methods inherited from class com.restfb.types.AbstractFacebookType

Methods inherited from class java.lang.Object

Constructor Detail

Campaign

Method Detail

getAccountId

setAccountId

getAdlabels

setAdlabels

getBidStrategy

setBidStrategy

getBoostedObjectId

setBoostedObjectId

getBrandLiftStudies

setBrandLiftStudies

getBudgetRebalanceFlag

setBudgetRebalanceFlag

getBudgetRemaining

setBudgetRemaining

getBuyingType

setBuyingType

getCanCreateBrandLiftStudy

setCanCreateBrandLiftStudy

getCanUseSpendCap

setCanUseSpendCap

getConfiguredStatus

setConfiguredStatus

getCreatedTime

setCreatedTime

getDailyBudget

setDailyBudget

getEffectiveStatus

setEffectiveStatus

getIssuesInfo

setIssuesInfo

getLastBudgetTogglingTime

setLastBudgetTogglingTime

getLifetimeBudget

setLifetimeBudget

getObjective

setObjective

getRecommendations

setRecommendations

getSourceCampaign

setSourceCampaign

getSourceCampaignId

setSourceCampaignId

getSpecialAdCategory

setSpecialAdCategory

getSpecialAdCategories

setSpecialAdCategories

getSpendCap

setSpendCap

getStartTime

setStartTime

getStatus

setStatus

getStopTime

setStopTime

getToplineId

setToplineId

getUpdatedTime

setUpdatedTime