type AdParam (v201809)

Service
AdParamService
Dependencies
AdParamOperation AdParamPage mutate()
▼
AdParam

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
Namespace
https://adwords.google.com/api/adwords/cm/v201809

Field

adGroupId

xsd:long

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.

criterionId

xsd:long

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.

insertionText

xsd:string

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.

paramIndex

xsd:int

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.