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

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

All Implemented Interfaces:

Serializable

public class KeywordEstimateRequest
extends EstimateRequest
implements Serializable

Represents a keyword to be estimated.

See Also:

Serialized Form

Constructor Summary

KeywordEstimateRequest()

KeywordEstimateRequest(String estimateRequestType, Keyword keyword, Money maxCpc, Boolean isNegative)

Method Summary

boolean	equals(Object obj)
static org.apache.axis.encoding.Deserializer	getDeserializer(String mechType, Class _javaType, QName _xmlType) Get Custom Deserializer
Boolean	getIsNegative() Gets the isNegative value for this KeywordEstimateRequest.
Keyword	getKeyword() Gets the keyword value for this KeywordEstimateRequest.
Money	getMaxCpc() Gets the maxCpc value for this KeywordEstimateRequest.
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	setIsNegative(Boolean isNegative) Sets the isNegative value for this KeywordEstimateRequest.
void	setKeyword(Keyword keyword) Sets the keyword value for this KeywordEstimateRequest.
void	setMaxCpc(Money maxCpc) Sets the maxCpc value for this KeywordEstimateRequest.

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

KeywordEstimateRequest

public KeywordEstimateRequest()

KeywordEstimateRequest

public KeywordEstimateRequest(String estimateRequestType,
                              Keyword keyword,
                              Money maxCpc,
                              Boolean isNegative)

Method Detail

getKeyword

public Keyword getKeyword()

Gets the keyword value for this KeywordEstimateRequest.

Returns:

keyword * The Keyword to estimate. The keyword text is required regardless of whether the keyword ID is included. The keyword ID is optional and has the following characteristics:

• When omitted, the ID indicates a new keyword to be estimated.
• When present with a campaign and ad group also specified, the ID should be for an existing keyword in the ad group. This can improve the estimates since historical performance is known.
• When present without a campaign and ad group specified, the ID is ignored.

This field is required and should not be null.

setKeyword

public void setKeyword(Keyword keyword)

Sets the keyword value for this KeywordEstimateRequest.

Parameters:

keyword - * The Keyword to estimate. The keyword text is required regardless of whether the keyword ID is included. The keyword ID is optional and has the following characteristics:

• When omitted, the ID indicates a new keyword to be estimated.
• When present with a campaign and ad group also specified, the ID should be for an existing keyword in the ad group. This can improve the estimates since historical performance is known.
• When present without a campaign and ad group specified, the ID is ignored.

This field is required and should not be null.

getMaxCpc

public Money getMaxCpc()

Gets the maxCpc value for this KeywordEstimateRequest.

Returns:

maxCpc * The max CPC bid for this keyword. In general, the maxCpc of a KeywordEstimateRequest is optional, since there is usually another maxCpc that can be used, such as the maxCpc on an existing keyword, an existing or overriding maxCpc of containing AdGroupEstimateRequest. However, if there is no backup value of maxCpc anywhere along the line, you must provide a value for maxCpc in KeywordEstimateRequest. This would happen, for example, if the KeywordEstimateRequest is for a new keyword.

setMaxCpc

public void setMaxCpc(Money maxCpc)

Sets the maxCpc value for this KeywordEstimateRequest.

Parameters:

maxCpc - * The max CPC bid for this keyword. In general, the maxCpc of a KeywordEstimateRequest is optional, since there is usually another maxCpc that can be used, such as the maxCpc on an existing keyword, an existing or overriding maxCpc of containing AdGroupEstimateRequest. However, if there is no backup value of maxCpc anywhere along the line, you must provide a value for maxCpc in KeywordEstimateRequest. This would happen, for example, if the KeywordEstimateRequest is for a new keyword.

getIsNegative

public Boolean getIsNegative()

Gets the isNegative value for this KeywordEstimateRequest.

Returns:

isNegative * Whether the keyword is negative or not. The default value is false. If negative, no current ad group ads will appear for searches containing this keyword.

The estimate for negative keywords should reflect no traffic and zero CPC, but including a negative keyword will affect the other estimates in the request.

setIsNegative

public void setIsNegative(Boolean isNegative)

Sets the isNegative value for this KeywordEstimateRequest.

Parameters:

isNegative - * Whether the keyword is negative or not. The default value is false. If negative, no current ad group ads will appear for searches containing this keyword.

The estimate for negative keywords should reflect no traffic and zero CPC, but including a negative keyword will affect the other estimates in the request.

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