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

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

All Implemented Interfaces:

Serializable

public class AdGroupEstimateRequest
extends EstimateRequest
implements Serializable

Represents an ad group that will be estimated. Ad groups may be all new or all existing, or a mixture of new and existing. Only existing campaigns can contain estimates for existing ad groups.

To make a keyword estimates request in which estimates do not consider existing account information (e.g. historical ad group performance), set both adGroupId and the enclosing CampaignEstimateRequest's campaignId to null.

For more details on usage, refer to document at CampaignEstimateRequest.

See Also:

Serialized Form

Constructor Summary

AdGroupEstimateRequest()

AdGroupEstimateRequest(String estimateRequestType, Long adGroupId, KeywordEstimateRequest[] keywordEstimateRequests, Money maxCpc)

Method Summary

boolean	equals(Object obj)
Long	getAdGroupId() Gets the adGroupId value for this AdGroupEstimateRequest.
static org.apache.axis.encoding.Deserializer	getDeserializer(String mechType, Class _javaType, QName _xmlType) Get Custom Deserializer
KeywordEstimateRequest[]	getKeywordEstimateRequests() Gets the keywordEstimateRequests value for this AdGroupEstimateRequest.
KeywordEstimateRequest	getKeywordEstimateRequests(int i)
Money	getMaxCpc() Gets the maxCpc value for this AdGroupEstimateRequest.
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	setAdGroupId(Long adGroupId) Sets the adGroupId value for this AdGroupEstimateRequest.
void	setKeywordEstimateRequests(int i, KeywordEstimateRequest _value)
void	setKeywordEstimateRequests(KeywordEstimateRequest[] keywordEstimateRequests) Sets the keywordEstimateRequests value for this AdGroupEstimateRequest.
void	setMaxCpc(Money maxCpc) Sets the maxCpc value for this AdGroupEstimateRequest.

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

AdGroupEstimateRequest

public AdGroupEstimateRequest()

AdGroupEstimateRequest

public AdGroupEstimateRequest(String estimateRequestType,
                              Long adGroupId,
                              KeywordEstimateRequest[] keywordEstimateRequests,
                              Money maxCpc)

Method Detail

getAdGroupId

public Long getAdGroupId()

Gets the adGroupId value for this AdGroupEstimateRequest.

Returns:

adGroupId * The adGroupId for an ad group that belongs to the containing campaign from CampaignEstimateRequest or null.

For usage, refer to document from CampaignEstimateRequest.

setAdGroupId

public void setAdGroupId(Long adGroupId)

Sets the adGroupId value for this AdGroupEstimateRequest.

Parameters:

adGroupId - * The adGroupId for an ad group that belongs to the containing campaign from CampaignEstimateRequest or null.

For usage, refer to document from CampaignEstimateRequest.

getKeywordEstimateRequests

public KeywordEstimateRequest[] getKeywordEstimateRequests()

Gets the keywordEstimateRequests value for this AdGroupEstimateRequest.

Returns:

keywordEstimateRequests * The keywords to estimate. This field must contain distinct elements. This field must not contain null elements. This field is required and should not be null.

setKeywordEstimateRequests

public void setKeywordEstimateRequests(KeywordEstimateRequest[] keywordEstimateRequests)

Sets the keywordEstimateRequests value for this AdGroupEstimateRequest.

Parameters:

keywordEstimateRequests - * The keywords to estimate. This field must contain distinct elements. This field must not contain null elements. This field is required and should not be null.

getKeywordEstimateRequests

public KeywordEstimateRequest getKeywordEstimateRequests(int i)

setKeywordEstimateRequests

public void setKeywordEstimateRequests(int i,
                                       KeywordEstimateRequest _value)

getMaxCpc

public Money getMaxCpc()

Gets the maxCpc value for this AdGroupEstimateRequest.

Returns:

maxCpc * The max CPC bid to use for estimates for this ad group.

This value overrides the max CPC of AdGroup specified by adGroupId.

setMaxCpc

public void setMaxCpc(Money maxCpc)

Sets the maxCpc value for this AdGroupEstimateRequest.

Parameters:

maxCpc - * The max CPC bid to use for estimates for this ad group.

This value overrides the max CPC of AdGroup specified by adGroupId.

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