com.google.api.ads.adwords.v201109.cm
Class Campaign

java.lang.Object
  com.google.api.ads.adwords.v201109.cm.Campaign

All Implemented Interfaces:

Serializable

public class Campaign
extends Object
implements Serializable

Data representing an AdWords campaign.

See Also:

Serialized Form

Constructor Summary

Campaign()

Campaign(Long id, String name, CampaignStatus status, ServingStatus servingStatus, String startDate, String endDate, Budget budget, BiddingStrategy biddingStrategy, ConversionOptimizerEligibility conversionOptimizerEligibility, CampaignStats campaignStats, AdServingOptimizationStatus adServingOptimizationStatus, FrequencyCap frequencyCap, Setting[] settings, NetworkSetting networkSetting)

Method Summary

boolean	equals(Object obj)
AdServingOptimizationStatus	getAdServingOptimizationStatus() Gets the adServingOptimizationStatus value for this Campaign.
BiddingStrategy	getBiddingStrategy() Gets the biddingStrategy value for this Campaign.
Budget	getBudget() Gets the budget value for this Campaign.
CampaignStats	getCampaignStats() Gets the campaignStats value for this Campaign.
ConversionOptimizerEligibility	getConversionOptimizerEligibility() Gets the conversionOptimizerEligibility value for this Campaign.
static org.apache.axis.encoding.Deserializer	getDeserializer(String mechType, Class _javaType, QName _xmlType) Get Custom Deserializer
String	getEndDate() Gets the endDate value for this Campaign.
FrequencyCap	getFrequencyCap() Gets the frequencyCap value for this Campaign.
Long	getId() Gets the id value for this Campaign.
String	getName() Gets the name value for this Campaign.
NetworkSetting	getNetworkSetting() Gets the networkSetting value for this Campaign.
static org.apache.axis.encoding.Serializer	getSerializer(String mechType, Class _javaType, QName _xmlType) Get Custom Serializer
ServingStatus	getServingStatus() Gets the servingStatus value for this Campaign.
Setting[]	getSettings() Gets the settings value for this Campaign.
Setting	getSettings(int i)
String	getStartDate() Gets the startDate value for this Campaign.
CampaignStatus	getStatus() Gets the status value for this Campaign.
static org.apache.axis.description.TypeDesc	getTypeDesc() Return type metadata object
int	hashCode()
void	setAdServingOptimizationStatus(AdServingOptimizationStatus adServingOptimizationStatus) Sets the adServingOptimizationStatus value for this Campaign.
void	setBiddingStrategy(BiddingStrategy biddingStrategy) Sets the biddingStrategy value for this Campaign.
void	setBudget(Budget budget) Sets the budget value for this Campaign.
void	setCampaignStats(CampaignStats campaignStats) Sets the campaignStats value for this Campaign.
void	setConversionOptimizerEligibility(ConversionOptimizerEligibility conversionOptimizerEligibility) Sets the conversionOptimizerEligibility value for this Campaign.
void	setEndDate(String endDate) Sets the endDate value for this Campaign.
void	setFrequencyCap(FrequencyCap frequencyCap) Sets the frequencyCap value for this Campaign.
void	setId(Long id) Sets the id value for this Campaign.
void	setName(String name) Sets the name value for this Campaign.
void	setNetworkSetting(NetworkSetting networkSetting) Sets the networkSetting value for this Campaign.
void	setServingStatus(ServingStatus servingStatus) Sets the servingStatus value for this Campaign.
void	setSettings(int i, Setting _value)
void	setSettings(Setting[] settings) Sets the settings value for this Campaign.
void	setStartDate(String startDate) Sets the startDate value for this Campaign.
void	setStatus(CampaignStatus status) Sets the status value for this Campaign.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Campaign

public Campaign()

Campaign

public Campaign(Long id,
                String name,
                CampaignStatus status,
                ServingStatus servingStatus,
                String startDate,
                String endDate,
                Budget budget,
                BiddingStrategy biddingStrategy,
                ConversionOptimizerEligibility conversionOptimizerEligibility,
                CampaignStats campaignStats,
                AdServingOptimizationStatus adServingOptimizationStatus,
                FrequencyCap frequencyCap,
                Setting[] settings,
                NetworkSetting networkSetting)

Method Detail

getId

public Long getId()

Gets the id value for this Campaign.

Returns:

id * ID of this campaign. This field can be selected using the value "Id".This field can be filtered on. This field is read only and should not be set for following Operators : ADD. If this field is sent to the API, it will be ignored. This field is required and should not be null when it is contained within Operators : SET.

setId

public void setId(Long id)

Sets the id value for this Campaign.

Parameters:

id - * ID of this campaign. This field can be selected using the value "Id".This field can be filtered on. This field is read only and should not be set for following Operators : ADD. If this field is sent to the API, it will be ignored. This field is required and should not be null when it is contained within Operators : SET.

getName

public String getName()

Gets the name value for this Campaign.

Returns:

name * Name of this campaign. On add, defaults to Campaign #N. This field can be selected using the value "Name".This field can be filtered on. This string must not be empty.

setName

public void setName(String name)

Sets the name value for this Campaign.

Parameters:

name - * Name of this campaign. On add, defaults to Campaign #N. This field can be selected using the value "Name".This field can be filtered on. This string must not be empty.

getStatus

public CampaignStatus getStatus()

Gets the status value for this Campaign.

Returns:

status * Status of this campaign. On add, defaults to ACTIVE. This field can be selected using the value "Status".This field can be filtered on.

setStatus

public void setStatus(CampaignStatus status)

Sets the status value for this Campaign.

Parameters:

status - * Status of this campaign. On add, defaults to ACTIVE. This field can be selected using the value "Status".This field can be filtered on.

getServingStatus

public ServingStatus getServingStatus()

Gets the servingStatus value for this Campaign.

Returns:

servingStatus * Serving status. This field can be selected using the value "ServingStatus".This field can be filtered on. This field is read only and should not be set. If this field is sent to the API, it will be ignored.

setServingStatus

public void setServingStatus(ServingStatus servingStatus)

Sets the servingStatus value for this Campaign.

Parameters:

servingStatus - * Serving status. This field can be selected using the value "ServingStatus".This field can be filtered on. This field is read only and should not be set. If this field is sent to the API, it will be ignored.

getStartDate

public String getStartDate()

Gets the startDate value for this Campaign.

Returns:

startDate * Date the campaign begins. On add, defaults to the current day in the parent account's local timezone. The date's format should be YYYYMMDD. This field can be selected using the value "StartDate".This field can be filtered on.

setStartDate

public void setStartDate(String startDate)

Sets the startDate value for this Campaign.

Parameters:

startDate - * Date the campaign begins. On add, defaults to the current day in the parent account's local timezone. The date's format should be YYYYMMDD. This field can be selected using the value "StartDate".This field can be filtered on.

getEndDate

public String getEndDate()

Gets the endDate value for this Campaign.

Returns:

endDate * Date the campaign ends. On add, defaults to 20371231, which means the campaign will run indefinitely. To set an existing campaign to run indefinitely, set this field to 20371230. The date's format should be YYYYMMDD. This field can be selected using the value "EndDate".This field can be filtered on.

setEndDate

public void setEndDate(String endDate)

Sets the endDate value for this Campaign.

Parameters:

endDate - * Date the campaign ends. On add, defaults to 20371231, which means the campaign will run indefinitely. To set an existing campaign to run indefinitely, set this field to 20371230. The date's format should be YYYYMMDD. This field can be selected using the value "EndDate".This field can be filtered on.

getBudget

public Budget getBudget()

Gets the budget value for this Campaign.

Returns:

budget * Current base budget of campaign; default if no custom budgets are active.

setBudget

public void setBudget(Budget budget)

Sets the budget value for this Campaign.

Parameters:

budget - * Current base budget of campaign; default if no custom budgets are active.

getBiddingStrategy

public BiddingStrategy getBiddingStrategy()

Gets the biddingStrategy value for this Campaign.

Returns:

biddingStrategy * Bidding strategy for this campaign. This field is required when adding a new campaign. To modify an existing campaign's bidding strategy, use CampaignOperation.biddingTransition. Note that campaigns must meet specific eligibility requirements before they can use the ConversionOptimizier bidding strategy. This field is required and should not be null when it is contained within Operators : ADD.

setBiddingStrategy

public void setBiddingStrategy(BiddingStrategy biddingStrategy)

Sets the biddingStrategy value for this Campaign.

Parameters:

biddingStrategy - * Bidding strategy for this campaign. This field is required when adding a new campaign. To modify an existing campaign's bidding strategy, use CampaignOperation.biddingTransition. Note that campaigns must meet specific eligibility requirements before they can use the ConversionOptimizier bidding strategy. This field is required and should not be null when it is contained within Operators : ADD.

getConversionOptimizerEligibility

public ConversionOptimizerEligibility getConversionOptimizerEligibility()

Gets the conversionOptimizerEligibility value for this Campaign.

Returns:

conversionOptimizerEligibility * This field is read only and should not be set. If this field is sent to the API, it will be ignored.

setConversionOptimizerEligibility

public void setConversionOptimizerEligibility(ConversionOptimizerEligibility conversionOptimizerEligibility)

Sets the conversionOptimizerEligibility value for this Campaign.

Parameters:

conversionOptimizerEligibility - * This field is read only and should not be set. If this field is sent to the API, it will be ignored.

getCampaignStats

public CampaignStats getCampaignStats()

Gets the campaignStats value for this Campaign.

Returns:

campaignStats * Statistics for this campaign, returned by get() only if requested in the selector. This field is read only and should not be set. If this field is sent to the API, it will be ignored.

setCampaignStats

public void setCampaignStats(CampaignStats campaignStats)

Sets the campaignStats value for this Campaign.

Parameters:

campaignStats - * Statistics for this campaign, returned by get() only if requested in the selector. This field is read only and should not be set. If this field is sent to the API, it will be ignored.

getAdServingOptimizationStatus

public AdServingOptimizationStatus getAdServingOptimizationStatus()

Gets the adServingOptimizationStatus value for this Campaign.

Returns:

adServingOptimizationStatus * Ad serving optimization status. This field can be selected using the value "AdServingOptimizationStatus".

setAdServingOptimizationStatus

public void setAdServingOptimizationStatus(AdServingOptimizationStatus adServingOptimizationStatus)

Sets the adServingOptimizationStatus value for this Campaign.

Parameters:

adServingOptimizationStatus - * Ad serving optimization status. This field can be selected using the value "AdServingOptimizationStatus".

getFrequencyCap

public FrequencyCap getFrequencyCap()

Gets the frequencyCap value for this Campaign.

Returns:

frequencyCap * Frequency cap for this campaign.

setFrequencyCap

public void setFrequencyCap(FrequencyCap frequencyCap)

Sets the frequencyCap value for this Campaign.

Parameters:

frequencyCap - * Frequency cap for this campaign.

getSettings

public Setting[] getSettings()

Gets the settings value for this Campaign.

Returns:

settings * List of settings for the Campaign. This field can be selected using the value "Settings".

setSettings

public void setSettings(Setting[] settings)

Sets the settings value for this Campaign.

Parameters:

settings - * List of settings for the Campaign. This field can be selected using the value "Settings".

getSettings

public Setting getSettings(int i)

setSettings

public void setSettings(int i,
                        Setting _value)

getNetworkSetting

public NetworkSetting getNetworkSetting()

Gets the networkSetting value for this Campaign.

Returns:

networkSetting * The network settings for the campaign, to indicate where the campaign will serve.

setNetworkSetting

public void setNetworkSetting(NetworkSetting networkSetting)

Sets the networkSetting value for this Campaign.

Parameters:

networkSetting - * The network settings for the campaign, to indicate where the campaign will serve.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getTypeDesc

public static org.apache.axis.description.TypeDesc getTypeDesc()

Return type metadata object

getSerializer

public static org.apache.axis.encoding.Serializer getSerializer(String mechType,
                                                                Class _javaType,
                                                                QName _xmlType)

Get Custom Serializer

getDeserializer

public static org.apache.axis.encoding.Deserializer getDeserializer(String mechType,
                                                                    Class _javaType,
                                                                    QName _xmlType)

Get Custom Deserializer