Campaign (AdWords AppEngine components 4.21.0 API)

java.lang.Object
- com.google.api.ads.adwords.jaxws.v201809.cm.Campaign

public class Campaign
extends Object

Data representing an AdWords campaign.

Java class for Campaign complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="Campaign">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="id" type="{http://www.w3.org/2001/XMLSchema}long" minOccurs="0"/>
         <element name="campaignGroupId" type="{http://www.w3.org/2001/XMLSchema}long" minOccurs="0"/>
         <element name="name" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="status" type="{https://adwords.google.com/api/adwords/cm/v201809}CampaignStatus" minOccurs="0"/>
         <element name="servingStatus" type="{https://adwords.google.com/api/adwords/cm/v201809}ServingStatus" minOccurs="0"/>
         <element name="startDate" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="endDate" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="budget" type="{https://adwords.google.com/api/adwords/cm/v201809}Budget" minOccurs="0"/>
         <element name="conversionOptimizerEligibility" type="{https://adwords.google.com/api/adwords/cm/v201809}ConversionOptimizerEligibility" minOccurs="0"/>
         <element name="adServingOptimizationStatus" type="{https://adwords.google.com/api/adwords/cm/v201809}AdServingOptimizationStatus" minOccurs="0"/>
         <element name="frequencyCap" type="{https://adwords.google.com/api/adwords/cm/v201809}FrequencyCap" minOccurs="0"/>
         <element name="settings" type="{https://adwords.google.com/api/adwords/cm/v201809}Setting" maxOccurs="unbounded" minOccurs="0"/>
         <element name="advertisingChannelType" type="{https://adwords.google.com/api/adwords/cm/v201809}AdvertisingChannelType" minOccurs="0"/>
         <element name="advertisingChannelSubType" type="{https://adwords.google.com/api/adwords/cm/v201809}AdvertisingChannelSubType" minOccurs="0"/>
         <element name="networkSetting" type="{https://adwords.google.com/api/adwords/cm/v201809}NetworkSetting" minOccurs="0"/>
         <element name="labels" type="{https://adwords.google.com/api/adwords/cm/v201809}Label" maxOccurs="unbounded" minOccurs="0"/>
         <element name="biddingStrategyConfiguration" type="{https://adwords.google.com/api/adwords/cm/v201809}BiddingStrategyConfiguration" minOccurs="0"/>
         <element name="campaignTrialType" type="{https://adwords.google.com/api/adwords/cm/v201809}CampaignTrialType" minOccurs="0"/>
         <element name="baseCampaignId" type="{http://www.w3.org/2001/XMLSchema}long" minOccurs="0"/>
         <element name="forwardCompatibilityMap" type="{https://adwords.google.com/api/adwords/cm/v201809}String_StringMapEntry" maxOccurs="unbounded" minOccurs="0"/>
         <element name="trackingUrlTemplate" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="finalUrlSuffix" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="urlCustomParameters" type="{https://adwords.google.com/api/adwords/cm/v201809}CustomParameters" minOccurs="0"/>
         <element name="vanityPharma" type="{https://adwords.google.com/api/adwords/cm/v201809}VanityPharma" minOccurs="0"/>
         <element name="universalAppCampaignInfo" type="{https://adwords.google.com/api/adwords/cm/v201809}UniversalAppCampaignInfo" minOccurs="0"/>
         <element name="selectiveOptimization" type="{https://adwords.google.com/api/adwords/cm/v201809}SelectiveOptimization" minOccurs="0"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>

Field Summary

Fields
Modifier and Type	Field and Description
`protected AdServingOptimizationStatus`	`adServingOptimizationStatus`
`protected AdvertisingChannelSubType`	`advertisingChannelSubType`
`protected AdvertisingChannelType`	`advertisingChannelType`
`protected Long`	`baseCampaignId`
`protected BiddingStrategyConfiguration`	`biddingStrategyConfiguration`
`protected Budget`	`budget`
`protected Long`	`campaignGroupId`
`protected CampaignTrialType`	`campaignTrialType`
`protected ConversionOptimizerEligibility`	`conversionOptimizerEligibility`
`protected String`	`endDate`
`protected String`	`finalUrlSuffix`
`protected List<StringStringMapEntry>`	`forwardCompatibilityMap`
`protected FrequencyCap`	`frequencyCap`
`protected Long`	`id`
`protected List<Label>`	`labels`
`protected String`	`name`
`protected NetworkSetting`	`networkSetting`
`protected SelectiveOptimization`	`selectiveOptimization`
`protected ServingStatus`	`servingStatus`
`protected List<Setting>`	`settings`
`protected String`	`startDate`
`protected CampaignStatus`	`status`
`protected String`	`trackingUrlTemplate`
`protected UniversalAppCampaignInfo`	`universalAppCampaignInfo`
`protected CustomParameters`	`urlCustomParameters`
`protected VanityPharma`	`vanityPharma`

Constructor Summary

Constructors
Constructor and Description

Campaign()

Constructors
Constructor and Description
`Campaign()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AdServingOptimizationStatus`	`getAdServingOptimizationStatus()` Gets the value of the adServingOptimizationStatus property.
`AdvertisingChannelSubType`	`getAdvertisingChannelSubType()` Gets the value of the advertisingChannelSubType property.
`AdvertisingChannelType`	`getAdvertisingChannelType()` Gets the value of the advertisingChannelType property.
`Long`	`getBaseCampaignId()` Gets the value of the baseCampaignId property.
`BiddingStrategyConfiguration`	`getBiddingStrategyConfiguration()` Gets the value of the biddingStrategyConfiguration property.
`Budget`	`getBudget()` Gets the value of the budget property.
`Long`	`getCampaignGroupId()` Gets the value of the campaignGroupId property.
`CampaignTrialType`	`getCampaignTrialType()` Gets the value of the campaignTrialType property.
`ConversionOptimizerEligibility`	`getConversionOptimizerEligibility()` Gets the value of the conversionOptimizerEligibility property.
`String`	`getEndDate()` Gets the value of the endDate property.
`String`	`getFinalUrlSuffix()` Gets the value of the finalUrlSuffix property.
`List<StringStringMapEntry>`	`getForwardCompatibilityMap()` Gets the value of the forwardCompatibilityMap property.
`FrequencyCap`	`getFrequencyCap()` Gets the value of the frequencyCap property.
`Long`	`getId()` Gets the value of the id property.
`List<Label>`	`getLabels()` Gets the value of the labels property.
`String`	`getName()` Gets the value of the name property.
`NetworkSetting`	`getNetworkSetting()` Gets the value of the networkSetting property.
`SelectiveOptimization`	`getSelectiveOptimization()` Gets the value of the selectiveOptimization property.
`ServingStatus`	`getServingStatus()` Gets the value of the servingStatus property.
`List<Setting>`	`getSettings()` Gets the value of the settings property.
`String`	`getStartDate()` Gets the value of the startDate property.
`CampaignStatus`	`getStatus()` Gets the value of the status property.
`String`	`getTrackingUrlTemplate()` Gets the value of the trackingUrlTemplate property.
`UniversalAppCampaignInfo`	`getUniversalAppCampaignInfo()` Gets the value of the universalAppCampaignInfo property.
`CustomParameters`	`getUrlCustomParameters()` Gets the value of the urlCustomParameters property.
`VanityPharma`	`getVanityPharma()` Gets the value of the vanityPharma property.
`void`	`setAdServingOptimizationStatus(AdServingOptimizationStatus value)` Sets the value of the adServingOptimizationStatus property.
`void`	`setAdvertisingChannelSubType(AdvertisingChannelSubType value)` Sets the value of the advertisingChannelSubType property.
`void`	`setAdvertisingChannelType(AdvertisingChannelType value)` Sets the value of the advertisingChannelType property.
`void`	`setBaseCampaignId(Long value)` Sets the value of the baseCampaignId property.
`void`	`setBiddingStrategyConfiguration(BiddingStrategyConfiguration value)` Sets the value of the biddingStrategyConfiguration property.
`void`	`setBudget(Budget value)` Sets the value of the budget property.
`void`	`setCampaignGroupId(Long value)` Sets the value of the campaignGroupId property.
`void`	`setCampaignTrialType(CampaignTrialType value)` Sets the value of the campaignTrialType property.
`void`	`setConversionOptimizerEligibility(ConversionOptimizerEligibility value)` Sets the value of the conversionOptimizerEligibility property.
`void`	`setEndDate(String value)` Sets the value of the endDate property.
`void`	`setFinalUrlSuffix(String value)` Sets the value of the finalUrlSuffix property.
`void`	`setFrequencyCap(FrequencyCap value)` Sets the value of the frequencyCap property.
`void`	`setId(Long value)` Sets the value of the id property.
`void`	`setName(String value)` Sets the value of the name property.
`void`	`setNetworkSetting(NetworkSetting value)` Sets the value of the networkSetting property.
`void`	`setSelectiveOptimization(SelectiveOptimization value)` Sets the value of the selectiveOptimization property.
`void`	`setServingStatus(ServingStatus value)` Sets the value of the servingStatus property.
`void`	`setStartDate(String value)` Sets the value of the startDate property.
`void`	`setStatus(CampaignStatus value)` Sets the value of the status property.
`void`	`setTrackingUrlTemplate(String value)` Sets the value of the trackingUrlTemplate property.
`void`	`setUniversalAppCampaignInfo(UniversalAppCampaignInfo value)` Sets the value of the universalAppCampaignInfo property.
`void`	`setUrlCustomParameters(CustomParameters value)` Sets the value of the urlCustomParameters property.
`void`	`setVanityPharma(VanityPharma value)` Sets the value of the vanityPharma property.

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

- Field Detail
  - id
```
protected Long id
```
  - campaignGroupId
```
protected Long campaignGroupId
```
  - name
```
protected String name
```
  - status
```
protected CampaignStatus status
```
  - servingStatus
```
protected ServingStatus servingStatus
```
  - startDate
```
protected String startDate
```
  - endDate
```
protected String endDate
```
  - budget
```
protected Budget budget
```
  - conversionOptimizerEligibility
```
protected ConversionOptimizerEligibility conversionOptimizerEligibility
```
  - adServingOptimizationStatus
```
protected AdServingOptimizationStatus adServingOptimizationStatus
```
  - frequencyCap
```
protected FrequencyCap frequencyCap
```
  - settings
```
protected List<Setting> settings
```
  - advertisingChannelType
```
protected AdvertisingChannelType advertisingChannelType
```
  - advertisingChannelSubType
```
protected AdvertisingChannelSubType advertisingChannelSubType
```
  - networkSetting
```
protected NetworkSetting networkSetting
```
  - labels
```
protected List<Label> labels
```
  - biddingStrategyConfiguration
```
protected BiddingStrategyConfiguration biddingStrategyConfiguration
```
  - campaignTrialType
```
protected CampaignTrialType campaignTrialType
```
  - baseCampaignId
```
protected Long baseCampaignId
```
  - forwardCompatibilityMap
```
protected List<StringStringMapEntry> forwardCompatibilityMap
```
  - trackingUrlTemplate
```
protected String trackingUrlTemplate
```
  - finalUrlSuffix
```
protected String finalUrlSuffix
```
  - urlCustomParameters
```
protected CustomParameters urlCustomParameters
```
  - vanityPharma
```
protected VanityPharma vanityPharma
```
  - universalAppCampaignInfo
```
protected UniversalAppCampaignInfo universalAppCampaignInfo
```
  - selectiveOptimization
```
protected SelectiveOptimization selectiveOptimization
```
- Constructor Detail
  - Campaign
```
public Campaign()
```
- Method Detail
  - getId
```
public Long getId()
```
    Gets the value of the id property.
    
    Returns:
    
    possible object is Long
  - setId
```
public void setId(Long value)
```
    Sets the value of the id property.
    
    Parameters:
    
    value - allowed object is Long
  - getCampaignGroupId
```
public Long getCampaignGroupId()
```
    Gets the value of the campaignGroupId property.
    
    Returns:
    
    possible object is Long
  - setCampaignGroupId
```
public void setCampaignGroupId(Long value)
```
    Sets the value of the campaignGroupId property.
    
    Parameters:
    
    value - allowed object is Long
  - getName
```
public String getName()
```
    Gets the value of the name property.
    
    Returns:
    
    possible object is String
  - setName
```
public void setName(String value)
```
    Sets the value of the name property.
    
    Parameters:
    
    value - allowed object is String
  - getStatus
```
public CampaignStatus getStatus()
```
    Gets the value of the status property.
    
    Returns:
    
    possible object is CampaignStatus
  - setStatus
```
public void setStatus(CampaignStatus value)
```
    Sets the value of the status property.
    
    Parameters:
    
    value - allowed object is CampaignStatus
  - getServingStatus
```
public ServingStatus getServingStatus()
```
    Gets the value of the servingStatus property.
    
    Returns:
    
    possible object is ServingStatus
  - setServingStatus
```
public void setServingStatus(ServingStatus value)
```
    Sets the value of the servingStatus property.
    
    Parameters:
    
    value - allowed object is ServingStatus
  - getStartDate
```
public String getStartDate()
```
    Gets the value of the startDate property.
    
    Returns:
    
    possible object is String
  - setStartDate
```
public void setStartDate(String value)
```
    Sets the value of the startDate property.
    
    Parameters:
    
    value - allowed object is String
  - getEndDate
```
public String getEndDate()
```
    Gets the value of the endDate property.
    
    Returns:
    
    possible object is String
  - setEndDate
```
public void setEndDate(String value)
```
    Sets the value of the endDate property.
    
    Parameters:
    
    value - allowed object is String
  - getBudget
```
public Budget getBudget()
```
    Gets the value of the budget property.
    
    Returns:
    
    possible object is Budget
  - setBudget
```
public void setBudget(Budget value)
```
    Sets the value of the budget property.
    
    Parameters:
    
    value - allowed object is Budget
  - getConversionOptimizerEligibility
```
public ConversionOptimizerEligibility getConversionOptimizerEligibility()
```
    Gets the value of the conversionOptimizerEligibility property.
    
    Returns:
    
    possible object is ConversionOptimizerEligibility
  - setConversionOptimizerEligibility
```
public void setConversionOptimizerEligibility(ConversionOptimizerEligibility value)
```
    Sets the value of the conversionOptimizerEligibility property.
    
    Parameters:
    
    value - allowed object is ConversionOptimizerEligibility
  - getAdServingOptimizationStatus
```
public AdServingOptimizationStatus getAdServingOptimizationStatus()
```
    Gets the value of the adServingOptimizationStatus property.
    
    Returns:
    
    possible object is AdServingOptimizationStatus
  - setAdServingOptimizationStatus
```
public void setAdServingOptimizationStatus(AdServingOptimizationStatus value)
```
    Sets the value of the adServingOptimizationStatus property.
    
    Parameters:
    
    value - allowed object is AdServingOptimizationStatus
  - getFrequencyCap
```
public FrequencyCap getFrequencyCap()
```
    Gets the value of the frequencyCap property.
    
    Returns:
    
    possible object is FrequencyCap
  - setFrequencyCap
```
public void setFrequencyCap(FrequencyCap value)
```
    Sets the value of the frequencyCap property.
    
    Parameters:
    
    value - allowed object is FrequencyCap
  - getSettings
```
public List<Setting> getSettings()
```
    Gets the value of the settings property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the settings property.
    For example, to add a new item, do as follows:
```
    getSettings().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list Setting
  - getAdvertisingChannelType
```
public AdvertisingChannelType getAdvertisingChannelType()
```
    Gets the value of the advertisingChannelType property.
    
    Returns:
    
    possible object is AdvertisingChannelType
  - setAdvertisingChannelType
```
public void setAdvertisingChannelType(AdvertisingChannelType value)
```
    Sets the value of the advertisingChannelType property.
    
    Parameters:
    
    value - allowed object is AdvertisingChannelType
  - getAdvertisingChannelSubType
```
public AdvertisingChannelSubType getAdvertisingChannelSubType()
```
    Gets the value of the advertisingChannelSubType property.
    
    Returns:
    
    possible object is AdvertisingChannelSubType
  - setAdvertisingChannelSubType
```
public void setAdvertisingChannelSubType(AdvertisingChannelSubType value)
```
    Sets the value of the advertisingChannelSubType property.
    
    Parameters:
    
    value - allowed object is AdvertisingChannelSubType
  - getNetworkSetting
```
public NetworkSetting getNetworkSetting()
```
    Gets the value of the networkSetting property.
    
    Returns:
    
    possible object is NetworkSetting
  - setNetworkSetting
```
public void setNetworkSetting(NetworkSetting value)
```
    Sets the value of the networkSetting property.
    
    Parameters:
    
    value - allowed object is NetworkSetting
  - getLabels
```
public List<Label> getLabels()
```
    Gets the value of the labels property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the labels property.
    For example, to add a new item, do as follows:
```
    getLabels().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list Label
  - getBiddingStrategyConfiguration
```
public BiddingStrategyConfiguration getBiddingStrategyConfiguration()
```
    Gets the value of the biddingStrategyConfiguration property.
    
    Returns:
    
    possible object is BiddingStrategyConfiguration
  - setBiddingStrategyConfiguration
```
public void setBiddingStrategyConfiguration(BiddingStrategyConfiguration value)
```
    Sets the value of the biddingStrategyConfiguration property.
    
    Parameters:
    
    value - allowed object is BiddingStrategyConfiguration
  - getCampaignTrialType
```
public CampaignTrialType getCampaignTrialType()
```
    Gets the value of the campaignTrialType property.
    
    Returns:
    
    possible object is CampaignTrialType
  - setCampaignTrialType
```
public void setCampaignTrialType(CampaignTrialType value)
```
    Sets the value of the campaignTrialType property.
    
    Parameters:
    
    value - allowed object is CampaignTrialType
  - getBaseCampaignId
```
public Long getBaseCampaignId()
```
    Gets the value of the baseCampaignId property.
    
    Returns:
    
    possible object is Long
  - setBaseCampaignId
```
public void setBaseCampaignId(Long value)
```
    Sets the value of the baseCampaignId property.
    
    Parameters:
    
    value - allowed object is Long
  - getForwardCompatibilityMap
```
public List<StringStringMapEntry> getForwardCompatibilityMap()
```
    Gets the value of the forwardCompatibilityMap property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the forwardCompatibilityMap property.
    For example, to add a new item, do as follows:
```
    getForwardCompatibilityMap().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list StringStringMapEntry
  - getTrackingUrlTemplate
```
public String getTrackingUrlTemplate()
```
    Gets the value of the trackingUrlTemplate property.
    
    Returns:
    
    possible object is String
  - setTrackingUrlTemplate
```
public void setTrackingUrlTemplate(String value)
```
    Sets the value of the trackingUrlTemplate property.
    
    Parameters:
    
    value - allowed object is String
  - getFinalUrlSuffix
```
public String getFinalUrlSuffix()
```
    Gets the value of the finalUrlSuffix property.
    
    Returns:
    
    possible object is String
  - setFinalUrlSuffix
```
public void setFinalUrlSuffix(String value)
```
    Sets the value of the finalUrlSuffix property.
    
    Parameters:
    
    value - allowed object is String
  - getUrlCustomParameters
```
public CustomParameters getUrlCustomParameters()
```
    Gets the value of the urlCustomParameters property.
    
    Returns:
    
    possible object is CustomParameters
  - setUrlCustomParameters
```
public void setUrlCustomParameters(CustomParameters value)
```
    Sets the value of the urlCustomParameters property.
    
    Parameters:
    
    value - allowed object is CustomParameters
  - getVanityPharma
```
public VanityPharma getVanityPharma()
```
    Gets the value of the vanityPharma property.
    
    Returns:
    
    possible object is VanityPharma
  - setVanityPharma
```
public void setVanityPharma(VanityPharma value)
```
    Sets the value of the vanityPharma property.
    
    Parameters:
    
    value - allowed object is VanityPharma
  - getUniversalAppCampaignInfo
```
public UniversalAppCampaignInfo getUniversalAppCampaignInfo()
```
    Gets the value of the universalAppCampaignInfo property.
    
    Returns:
    
    possible object is UniversalAppCampaignInfo
  - setUniversalAppCampaignInfo
```
public void setUniversalAppCampaignInfo(UniversalAppCampaignInfo value)
```
    Sets the value of the universalAppCampaignInfo property.
    
    Parameters:
    
    value - allowed object is UniversalAppCampaignInfo
  - getSelectiveOptimization
```
public SelectiveOptimization getSelectiveOptimization()
```
    Gets the value of the selectiveOptimization property.
    
    Returns:
    
    possible object is SelectiveOptimization
  - setSelectiveOptimization
```
public void setSelectiveOptimization(SelectiveOptimization value)
```
    Sets the value of the selectiveOptimization property.
    
    Parameters:
    
    value - allowed object is SelectiveOptimization

Class Campaign

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

id

campaignGroupId

name

status

servingStatus

startDate

endDate

budget

conversionOptimizerEligibility

adServingOptimizationStatus

frequencyCap

settings

advertisingChannelType

advertisingChannelSubType

networkSetting

labels

biddingStrategyConfiguration

campaignTrialType

baseCampaignId

forwardCompatibilityMap

trackingUrlTemplate

finalUrlSuffix

urlCustomParameters

vanityPharma

universalAppCampaignInfo

selectiveOptimization

Constructor Detail

Campaign

Method Detail

getId

setId

getCampaignGroupId

setCampaignGroupId

getName

setName

getStatus

setStatus

getServingStatus

setServingStatus

getStartDate

setStartDate

getEndDate

setEndDate

getBudget

setBudget

getConversionOptimizerEligibility

setConversionOptimizerEligibility

getAdServingOptimizationStatus

setAdServingOptimizationStatus

getFrequencyCap

setFrequencyCap

getSettings

getAdvertisingChannelType

setAdvertisingChannelType

getAdvertisingChannelSubType

setAdvertisingChannelSubType

getNetworkSetting

setNetworkSetting

getLabels

getBiddingStrategyConfiguration

setBiddingStrategyConfiguration

getCampaignTrialType

setCampaignTrialType

getBaseCampaignId

setBaseCampaignId

getForwardCompatibilityMap

getTrackingUrlTemplate

setTrackingUrlTemplate

getFinalUrlSuffix

setFinalUrlSuffix

getUrlCustomParameters

setUrlCustomParameters

getVanityPharma

setVanityPharma