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

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

All Implemented Interfaces:

Serializable

public class AdParam
extends Object
implements Serializable

Represents an ad parameter. Use ad parameters to update numeric values (such as prices or inventory levels) in any line of a text ad, including the destination URL. You can set two AdParam objects (one for each value of paramIndex) per ad group Keyword criterion.

When setting or removing an AdParam, it is uniquely identified by the combination of these three fields:

• adGroupId
• criterionId
• paramIndex

See Also:

Serialized Form

Constructor Summary

AdParam()

AdParam(Long adGroupId, Long criterionId, String insertionText, Integer paramIndex)

Method Summary

boolean	equals(Object obj)
Long	getAdGroupId() Gets the adGroupId value for this AdParam.
Long	getCriterionId() Gets the criterionId value for this AdParam.
static org.apache.axis.encoding.Deserializer	getDeserializer(String mechType, Class _javaType, QName _xmlType) Get Custom Deserializer
String	getInsertionText() Gets the insertionText value for this AdParam.
Integer	getParamIndex() Gets the paramIndex value for this AdParam.
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 AdParam.
void	setCriterionId(Long criterionId) Sets the criterionId value for this AdParam.
void	setInsertionText(String insertionText) Sets the insertionText value for this AdParam.
void	setParamIndex(Integer paramIndex) Sets the paramIndex value for this AdParam.

Methods inherited from class java.lang.Object

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

Constructor Detail

AdParam

public AdParam()

AdParam

public AdParam(Long adGroupId,
               Long criterionId,
               String insertionText,
               Integer paramIndex)

Method Detail

getAdGroupId

public Long getAdGroupId()

Gets the adGroupId value for this AdParam.

Returns:

adGroupId * ID of the associated ad group. Text ads in this ad group will be candidates for parameterized text replacement. This field can be selected using the value "AdGroupId".This field can be filtered on. This field is required and should not be null.

setAdGroupId

public void setAdGroupId(Long adGroupId)

Sets the adGroupId value for this AdParam.

Parameters:

adGroupId - * ID of the associated ad group. Text ads in this ad group will be candidates for parameterized text replacement. This field can be selected using the value "AdGroupId".This field can be filtered on. This field is required and should not be null.

getCriterionId

public Long getCriterionId()

Gets the criterionId value for this AdParam.

Returns:

criterionId * ID of the associated Keyword criterion. The keyword must be in the same ad group as this AdParam. Text ads triggered by this keyword will have their {paramN:default-value} snippet replaced by the contents of insertionText. This field can be selected using the value "CriterionId".This field can be filtered on. This field is required and should not be null.

setCriterionId

public void setCriterionId(Long criterionId)

Sets the criterionId value for this AdParam.

Parameters:

criterionId - * ID of the associated Keyword criterion. The keyword must be in the same ad group as this AdParam. Text ads triggered by this keyword will have their {paramN:default-value} snippet replaced by the contents of insertionText. This field can be selected using the value "CriterionId".This field can be filtered on. This field is required and should not be null.

getInsertionText

public String getInsertionText()

Gets the insertionText value for this AdParam.

Returns:

insertionText * Numeric value to insert into the ad text. The following restrictions apply:

• Can use , or . as a separator, with an optional . or , (respectively) for fractional values. For example, 1,000,000.00 and 2.000.000,10 are valid.
• Can be prepended or appended with a currency symbol. For example, $99.99 and 200£ are valid.
• Can be prepended or appended with a currency code. For example, 99.99USD and EUR200 are valid.
• Can use %. For example, 1.0% and 1,0% are valid.
• Can use + or -. For example, -10.99 and 25+ are valid.
• Can use / between two numbers. For example 4/1 and 0.95/0.45 are valid.

This field can be selected using the value "InsertionText". This field is required and should not be null when it is contained within Operators : SET. The length of this string should be between 1 and 25, inclusive.

setInsertionText

public void setInsertionText(String insertionText)

Sets the insertionText value for this AdParam.

Parameters:

insertionText - * Numeric value to insert into the ad text. The following restrictions apply:

• Can use , or . as a separator, with an optional . or , (respectively) for fractional values. For example, 1,000,000.00 and 2.000.000,10 are valid.
• Can be prepended or appended with a currency symbol. For example, $99.99 and 200£ are valid.
• Can be prepended or appended with a currency code. For example, 99.99USD and EUR200 are valid.
• Can use %. For example, 1.0% and 1,0% are valid.
• Can use + or -. For example, -10.99 and 25+ are valid.
• Can use / between two numbers. For example 4/1 and 0.95/0.45 are valid.

This field can be selected using the value "InsertionText". This field is required and should not be null when it is contained within Operators : SET. The length of this string should be between 1 and 25, inclusive.

getParamIndex

public Integer getParamIndex()

Gets the paramIndex value for this AdParam.

Returns:

paramIndex * Defines which parameterized snippet of ad text to replace. For example, a value of 1 indicates a replacement for the {param1:default-value} token. This field can be selected using the value "ParamIndex". This field must be between 1 and 2, inclusive. This field is required and should not be null.

setParamIndex

public void setParamIndex(Integer paramIndex)

Sets the paramIndex value for this AdParam.

Parameters:

paramIndex - * Defines which parameterized snippet of ad text to replace. For example, a value of 1 indicates a replacement for the {param1:default-value} token. This field can be selected using the value "ParamIndex". This field must be between 1 and 2, inclusive. This field is required and should not be null.

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