com.google.api.ads.adwords.v201109.o
Class CampaignEstimateRequest

java.lang.Object
  com.google.api.ads.adwords.v201109.o.EstimateRequest
      com.google.api.ads.adwords.v201109.o.CampaignEstimateRequest

All Implemented Interfaces:

Serializable

public class CampaignEstimateRequest
extends EstimateRequest
implements Serializable

Represents a campaign that will be estimated.

Returns traffic estimates for the requested set of campaigns. The campaigns can be all new or all existing, or a mixture of new and existing. Only existing campaigns may contain estimates for existing ad groups.

For existing campaigns, the campaign and optionally the ad group will be used as context to produce more accurate estimates. Traffic estimates may only be requested on keywords, so regardless of whether campaign and ad group IDs are provided or left blank, at least one keyword is required to estimate traffic.

To make a keyword estimates request in which estimates do not consider existing account information (e.g. historical ad group performance), set campaignId to null.

See Also:

Serialized Form

Constructor Summary

CampaignEstimateRequest()

CampaignEstimateRequest(String estimateRequestType, Long campaignId, AdGroupEstimateRequest[] adGroupEstimateRequests, Criterion[] criteria, NetworkSetting networkSetting, Money dailyBudget)

Method Summary

boolean	equals(Object obj)
AdGroupEstimateRequest[]	getAdGroupEstimateRequests() Gets the adGroupEstimateRequests value for this CampaignEstimateRequest.
AdGroupEstimateRequest	getAdGroupEstimateRequests(int i)
Long	getCampaignId() Gets the campaignId value for this CampaignEstimateRequest.
Criterion[]	getCriteria() Gets the criteria value for this CampaignEstimateRequest.
Criterion	getCriteria(int i)
Money	getDailyBudget() Gets the dailyBudget value for this CampaignEstimateRequest.
static org.apache.axis.encoding.Deserializer	getDeserializer(String mechType, Class _javaType, QName _xmlType) Get Custom Deserializer
NetworkSetting	getNetworkSetting() Gets the networkSetting value for this CampaignEstimateRequest.
static org.apache.axis.encoding.Serializer	getSerializer(String mechType, Class _javaType, QName _xmlType) Get Custom Serializer
static org.apache.axis.description.TypeDesc	getTypeDesc() Return type metadata object
int	hashCode()
void	setAdGroupEstimateRequests(AdGroupEstimateRequest[] adGroupEstimateRequests) Sets the adGroupEstimateRequests value for this CampaignEstimateRequest.
void	setAdGroupEstimateRequests(int i, AdGroupEstimateRequest _value)
void	setCampaignId(Long campaignId) Sets the campaignId value for this CampaignEstimateRequest.
void	setCriteria(Criterion[] criteria) Sets the criteria value for this CampaignEstimateRequest.
void	setCriteria(int i, Criterion _value)
void	setDailyBudget(Money dailyBudget) Sets the dailyBudget value for this CampaignEstimateRequest.
void	setNetworkSetting(NetworkSetting networkSetting) Sets the networkSetting value for this CampaignEstimateRequest.

Methods inherited from class com.google.api.ads.adwords.v201109.o.EstimateRequest

getEstimateRequestType, setEstimateRequestType

Methods inherited from class java.lang.Object

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

Constructor Detail

CampaignEstimateRequest

public CampaignEstimateRequest()

CampaignEstimateRequest

public CampaignEstimateRequest(String estimateRequestType,
                               Long campaignId,
                               AdGroupEstimateRequest[] adGroupEstimateRequests,
                               Criterion[] criteria,
                               NetworkSetting networkSetting,
                               Money dailyBudget)

Method Detail

getCampaignId

public Long getCampaignId()

Gets the campaignId value for this CampaignEstimateRequest.

Returns:

campaignId * The campaignId of an existing campaign or null.

Refer to the CampaignEstimateRequest documentation for detailed usage.

setCampaignId

public void setCampaignId(Long campaignId)

Sets the campaignId value for this CampaignEstimateRequest.

Parameters:

campaignId - * The campaignId of an existing campaign or null.

Refer to the CampaignEstimateRequest documentation for detailed usage.

getAdGroupEstimateRequests

public AdGroupEstimateRequest[] getAdGroupEstimateRequests()

Gets the adGroupEstimateRequests value for this CampaignEstimateRequest.

Returns:

adGroupEstimateRequests * The list of ad groups to estimate. At least one ad group is required.

New campaigns may only contain new ad groups. If an AdGroupEstimateRequest has an adGroupId but the campaign is new, the API will return an error. This field must contain distinct elements. This field must not contain null elements. This field must contain at least one element. This field is required and should not be null.

setAdGroupEstimateRequests

public void setAdGroupEstimateRequests(AdGroupEstimateRequest[] adGroupEstimateRequests)

Sets the adGroupEstimateRequests value for this CampaignEstimateRequest.

Parameters:

adGroupEstimateRequests - * The list of ad groups to estimate. At least one ad group is required.

New campaigns may only contain new ad groups. If an AdGroupEstimateRequest has an adGroupId but the campaign is new, the API will return an error. This field must contain distinct elements. This field must not contain null elements. This field must contain at least one element. This field is required and should not be null.

getAdGroupEstimateRequests

public AdGroupEstimateRequest getAdGroupEstimateRequests(int i)

setAdGroupEstimateRequests

public void setAdGroupEstimateRequests(int i,
                                       AdGroupEstimateRequest _value)

getCriteria

public Criterion[] getCriteria()

Gets the criteria value for this CampaignEstimateRequest.

Returns:

criteria * A list of Criterions to be used for this Campaign. Criteria provide information about geographical and language targeting.

Values in this field override the current targets in the Campaign specified by campaignId by the following mechanism:

This field accepts two types of Criterions: Location, which should contain all geographic targeting and Language, which should contain all language targeting. If Locations are passed in, all geographic targeting in the campaign will be overridden. If any Languages are passed in, all language targeting in the campaign will be overridden.

If multiple Locations are specified, the traffic estimate will be the sum of the estimates for each targeted area. This means that if criteria are chosen which overlap each other (for example, targeting both a country and a city within that country), the traffic estimate will be be larger than if no overlap were present - i. e., the overlap region will be double-counted in the estimate.

If no criteria are specified and this is for a new campaign then it will default to all languages in all countries and territories, and Google search.

If no criteria are specified and this is for an existing campaign then the current targeting on that campaign will be used.

While there's no solid limit on number of criteria, TrafficEstimatorService may return error with TOO_MANY_TARGETS if the request contains too many criteria across all CampaignEstimateRequests in a TrafficEstimatorSelector.

Supported Criteria : Language and Location This field must contain distinct elements. This field must not contain null elements.

setCriteria

public void setCriteria(Criterion[] criteria)

Sets the criteria value for this CampaignEstimateRequest.

Parameters:

criteria - * A list of Criterions to be used for this Campaign. Criteria provide information about geographical and language targeting.

Values in this field override the current targets in the Campaign specified by campaignId by the following mechanism:

This field accepts two types of Criterions: Location, which should contain all geographic targeting and Language, which should contain all language targeting. If Locations are passed in, all geographic targeting in the campaign will be overridden. If any Languages are passed in, all language targeting in the campaign will be overridden.

If multiple Locations are specified, the traffic estimate will be the sum of the estimates for each targeted area. This means that if criteria are chosen which overlap each other (for example, targeting both a country and a city within that country), the traffic estimate will be be larger than if no overlap were present - i. e., the overlap region will be double-counted in the estimate.

If no criteria are specified and this is for a new campaign then it will default to all languages in all countries and territories, and Google search.

If no criteria are specified and this is for an existing campaign then the current targeting on that campaign will be used.

While there's no solid limit on number of criteria, TrafficEstimatorService may return error with TOO_MANY_TARGETS if the request contains too many criteria across all CampaignEstimateRequests in a TrafficEstimatorSelector.

Supported Criteria : Language and Location This field must contain distinct elements. This field must not contain null elements.

getCriteria

public Criterion getCriteria(int i)

setCriteria

public void setCriteria(int i,
                        Criterion _value)

getNetworkSetting

public NetworkSetting getNetworkSetting()

Gets the networkSetting value for this CampaignEstimateRequest.

Returns:

networkSetting * A NetworkSetting to be used for this Campaign. The value of this field overrides the current targets in the Campaign specified by campaignId.

Only NetworkSetting#targetGoogleSearch and NetworkSetting#targetSearchNetwork are supported, they may be combined to sum the estimates.

If both request network setting and Campaign's network setting are empty, the default is NetworkSetting#targetGoogleSearch.

setNetworkSetting

public void setNetworkSetting(NetworkSetting networkSetting)

Sets the networkSetting value for this CampaignEstimateRequest.

Parameters:

networkSetting - * A NetworkSetting to be used for this Campaign. The value of this field overrides the current targets in the Campaign specified by campaignId.

Only NetworkSetting#targetGoogleSearch and NetworkSetting#targetSearchNetwork are supported, they may be combined to sum the estimates.

If both request network setting and Campaign's network setting are empty, the default is NetworkSetting#targetGoogleSearch.

getDailyBudget

public Money getDailyBudget()

Gets the dailyBudget value for this CampaignEstimateRequest.

Returns:

dailyBudget * Daily campaign budget to use in traffic estimation. If not specified, the daily budget is unlimited.

setDailyBudget

public void setDailyBudget(Money dailyBudget)

Sets the dailyBudget value for this CampaignEstimateRequest.

Parameters:

dailyBudget - * Daily campaign budget to use in traffic estimation. If not specified, the daily budget is unlimited.

equals

public boolean equals(Object obj)

Overrides:

equals in class EstimateRequest

hashCode

public int hashCode()

Overrides:

hashCode in class EstimateRequest

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