Use this service to manage ad parameters, which let you quickly update parameterized values (such as prices or inventory levels) in a text ad. Whereas updates to regular ad text can take hours to go live, updates to parameterized values go live in minutes.
To define where parameterized values appear in an ad, you insert
{param#:default-value}
tags in your ad text. You
can use these tags in any line of display text, and also in the
destination URL. When the text ad is displayed, values in these tags are
replaced by the ad parameter's insertion text. default-value
specifies the string to display
if one of the following conditions is true:
- The parameter has not been set.
- The parameter's insertion text is too long for the display line.
- The ad is being shown on the
Google Display Network
.
- Production WSDL
-
https://adwords.google.com/api/adwords/cm/v201809/AdParamService?wsdl
- Namespace
-
https://adwords.google.com/api/adwords/cm/v201809
- Operations
- Errors
-
- AdParamError
- AdxError
- AuthenticationError
- AuthorizationError
- ClientTermsError
- DatabaseError
- DistinctError
- IdError
- InternalApiError
- NotEmptyError
- NullError
- OperationAccessDenied
- OperatorError
- PolicyViolationError
- QuotaCheckError
- RangeError
- RateExceededError
- ReadOnlyError
- RejectedError
- RequestError
- RequiredError
- SelectorError
- SizeLimitError
- StringFormatError
- StringLengthError
get
Returns the ad parameters that match the criteria specified in the selector.
Parameters
Field | Type | Description |
---|---|---|
serviceSelector
|
|
Specifies which ad parameters to return. |
Response
Field | Type | Description |
---|---|---|
rval
|
|
A list of ad parameters. |
mutate
Sets and removes ad parameters.
Note:
ADD
is not supported. Use SET
for
new ad parameters.
-
SET
: Creates or updates an ad parameter, setting the new parameterized value for the given ad group / keyword pair. -
REMOVE
: Removes an ad parameter. Thedefault-value
specified in the ad text will be used.
Parameters
Field | Type | Description |
---|---|---|
operations
|
|
The operations to perform. |
Response
Field | Type | Description |
---|---|---|
rval
|
|
A list of ad parameters, where each entry
in the list is the result of applying the operation in the input
list with the same index. For a SET operation, the returned ad parameter will
contain the updated values. For a REMOVE operation, the returned ad parameter will
simply be the ad parameter that was removed. |
Errors
Error | Reasons |
---|---|
AdParamError
|
Errors for AdParamService.
Enumerations
|
AdxError
|
Errors that are thrown when a non-AdX feature is accessed by an AdX customer.
Enumerations
|
AuthenticationError
|
Errors returned when Authentication failed.
Enumerations
|
AuthorizationError
|
Errors encountered when trying to authorize a user.
Enumerations
|
ClientTermsError
|
Error due to user not accepting the AdWords terms of service.
Enumerations
|
DatabaseError
|
Errors that are thrown due to a database access problem.
Enumerations
|
DistinctError
|
Errors related to distinct ids or content.
Enumerations
|
IdError
|
Errors associated with the ids.
Enumerations
|
InternalApiError
|
Indicates that a server-side error has occured. InternalApiError s
are generally not the result of an invalid request or message sent by the
client.
Enumerations
|
NotEmptyError
|
Errors corresponding with violation of a NOT EMPTY check.
Enumerations
|
NullError
|
Errors associated with violation of a NOT NULL check.
Enumerations
|
OperationAccessDenied
|
Operation not permitted due to the invoked service's access policy.
Enumerations
|
OperatorError
|
Errors due to the use of unsupported operations.
Enumerations
|
PolicyViolationError
|
Represents violations of a single policy by some text in a field. Violations of a single policy by the same string in multiple places within a field is reported in one instance of this class and only one exemption needs to be filed. Violations of a single policy by two different strings is reported as two separate instances of this class. e.g. If 'ACME' violates 'capitalization' and occurs twice in a text ad it would be represented by one instance. If the ad also contains 'INC' which also violates 'capitalization' it would be represented in a separate instance. |
QuotaCheckError
|
Encapsulates the errors thrown during developer quota checks.
Enumerations
|
RangeError
|
A list of all errors associated with the Range constraint.
Enumerations
|
RateExceededError
|
Signals that a call failed because a measured rate exceeded.
Enumerations
|
ReadOnlyError
|
Errors from attempting to write to read-only fields.
Enumerations
|
RejectedError
|
Indicates that a field was rejected due to compatibility issues.
Enumerations
|
RequestError
|
Encapsulates the generic errors thrown when there's an error with user
request.
Enumerations
|
RequiredError
|
Errors due to missing required field.
Enumerations
|
SelectorError
|
Represents possible error codes for Selector.
Enumerations
|
SizeLimitError
|
Indicates that the number of entries in the request or response exceeds the system limit.
Enumerations
|
StringFormatError
|
A list of error code for reporting invalid content of input strings.
Enumerations
|
StringLengthError
|
Errors associated with the length of the given string being
out of bounds.
Enumerations
|