AdWords API

AdWords API
Feedback on this document

CampaignAdExtensionService (v201302)

Use this service to manage campaign ad extensions.

Campaign ad extensions attach additional information to a standard text ad (such as a business address, phone number, or additional site links) and apply to all text ads within the specified campaign. For general information about ad extensions, see the AdWords Help Center.

Note: An ad extension can be associated with only one campaign.

Available ad extension types are shown as derived AdExtensions types in the CampaignAdExtension.adExtension documentation.

To override campaign ad extensions on a per-ad basis, use AdExtensionOverrideService.

This is disabled for AdX.
Production WSDL
https://adwords.google.com/api/adwords/cm/v201302/CampaignAdExtensionService?wsdl
Namespace
https://adwords.google.com/api/adwords/cm/v201302
Operations
Errors

get

Returns a list of CampaignAdExtensions.

Parameters

Field Type Description
serviceSelector Selector The selector specifying the CampaignAdExtensions to return.

Response

Field Type Description
rval CampaignAdExtensionPage The page containing the CampaignAdExtensions which meet the criteria specified by the selector.

mutate

Applies the list of mutate operations.

Parameters

Field Type Description
operations CampaignAdExtensionOperation[] The operations to apply. The same CampaignAdExtension cannot be specified in more than one operation.

Response

Field Type Description
rval CampaignAdExtensionReturnValue The changed CampaignAdExtensions.

Errors

Error Reasons
AdExtensionError AdExtension errors.
Enumerations
ACCOUNT_DELETED
Account has been deleted
AD_EXTENSION_NO_LONGER_ACTIVE
Cannot reuse an ad extension that is no longer active
CANNOT_HAVE_MULTIPLE_LOCATION_SYNC_EXTENSIONS_PER_CAMPAIGN
Cannot have multiple location sync extensions per campaign
CANNOT_HAVE_MULTIPLE_MOBILE_EXTENSIONS_PER_CAMPAIGN
Cannot have multiple mobile extensions per campaign
CANNOT_HAVE_MULTIPLE_PRODUCT_EXTENSIONS_PER_CAMPAIGN
Cannot have multiple product extensions per campaign
CANNOT_HAVE_MULTIPLE_SITELINKS_EXTENSIONS_PER_CAMPAIGN
Cannot have multiple sitelinks extensions per campaign
CANNOT_HAVE_MULTIPLE_IN_APP_LINK_EXTENSIONS_PER_CAMPAIGN_PER_APPSTORE
Cannot have multiple in-app link extensions with same app store in a campaign.
INVALID_AUTH_TOKEN_FOR_EMAIL
Invalid auth token for the given email
INVALID_COUNTRY_CODE
Invalid country code specified
INVALID_DOMESTIC_PHONE_NUMBER_FORMAT
Invalid phone number format specified
INVALID_DESTINATION_URL
Invalid destination url specified
INVALID_EMAIL
Invalid email specified
INVALID_ENCODED_LOCATION
The encoded location does not match what should have been returned in GeoLocation.
INVALID_ENUM_CONDITION_OPERATOR
The enum operator in condition is not valid.
INVALID_ICON_DIMENSIONS
The icon has dimensions other than 16x16
INVALID_ID
Invalid id specified
INVALID_IMAGE_DIMENSIONS
The image has width or height exceeding 125
INVALID_INPUT
The input field is invalid
INVALID_LATITUDE
Invalid latitude specified
INVALID_LONGITUDE
Invalid longitude specified
INVALID_PHONE_NUMBER
Invalid phone number specified
INVALID_STRING_CONDITION_OPERATOR
The string operator in condition is not valid.
INVALID_TOLL_PHONE_NUMBER_FORMAT
Invalid toll phone number format specified
MEDIA_DOES_NOT_BELONG_TO_ACCOUNT
Media referenced does not belong to the customer's account
MEDIA_NOT_ICON_TYPE
Media referenced is not an icon
MEDIA_NOT_IMAGE_TYPE
Media referenced is not an image
MISSING_ADVERTISER_NAME
Missing advertiser name
MISSING_AUTH_TOKEN
Missing auth token
MISSING_COUNTRY_CODE
Missing country code
MISSING_CITY_NAME
Missing city name
MISSING_EMAIL
Missing email
MISSING_ENCODED_LOCATION
Missing encoded location
MISSING_CONDITION_OPERAND
Missing operand for condition
MISSING_CONDITION_STRING_VALUE
Missing comparison string value for condition
MISSING_POSTAL_CODE
Missing postal code
MISSING_STREET_ADDRESS
Missing street address
NUM_AND_GROUPS_OVER_LIMIT
Extension or OR clause contains more than 10 AND clauses
NUM_CONDITIONS_OVER_LIMIT
The number of conditions in an extension or AND group (5 max in AND) exceeds limit
NUM_LOCATION_EXTENSIONS_OVER_LIMIT
The number of location extensions exceeds campaign limits
NOT_AUTHORIZED_TO_CREATE_EXTENSION
The client is not authorized to make the specified extension
PHONE_NUMBER_NOT_SUPPORTED_FOR_COUNTRY
Setting phone number is not supported for the specified country currently
DISALLOWED_NUMBER_TYPE
Phone number type is not allowed
PREMIUM_RATE_NUMBER_NOT_ALLOWED
Premium rate numbers e.g. 1-900 numbers not allowed
TOO_LONG
Text is too long
USER_NOT_PERMITTED_TO_CREATE_LBC_SYNC_LOCATION_EXTENSION
The user is not permitted to create location sync extensions
AdxError Errors that are thrown when a non-AdX feature is accessed by an AdX customer.
Enumerations
UNSUPPORTED_FEATURE
Attempt to use non-AdX feature by AdX customer.
AuthenticationError Errors returned when Authentication failed.
Enumerations
AUTHENTICATION_FAILED
Authentication of the request failed.
CLIENT_CUSTOMER_ID_IS_REQUIRED
Client Customer Id is required if CustomerIdMode is set to CLIENT_EXTERNAL_CUSTOMER_ID.
CLIENT_EMAIL_REQUIRED
Client Email is required if CustomerIdMode is set to CLIENT_EXTERNAL_EMAIL_FIELD.
CLIENT_CUSTOMER_ID_INVALID
Client customer Id is not a number.
CLIENT_EMAIL_INVALID
Client customer Id is not a number.
CLIENT_EMAIL_FAILED_TO_AUTHENTICATE
Client email is not a valid customer email.
CUSTOMER_NOT_FOUND
No customer found for the customer id provided in the header.
GOOGLE_ACCOUNT_DELETED
Client's Google Account is deleted.
GOOGLE_ACCOUNT_COOKIE_INVALID
Google account login token in the cookie is invalid.
FAILED_TO_AUTHENTICATE_GOOGLE_ACCOUNT
problem occurred during Google account authentication.
GOOGLE_ACCOUNT_USER_AND_ADS_USER_MISMATCH
The user in the google account login token does not match the UserId in the cookie.
LOGIN_COOKIE_REQUIRED
Login cookie is required for authentication.
NOT_ADS_USER
User in the cookie is not a valid Ads user.
OAUTH_TOKEN_INVALID
Oauth token in the header is not valid.
OAUTH_TOKEN_EXPIRED
Oauth token in the header has expired.
OAUTH_TOKEN_DISABLED
Oauth token in the header has been disabled.
OAUTH_TOKEN_REVOKED
Oauth token in the header has been revoked.
OAUTH_TOKEN_HEADER_INVALID
Oauth token HTTP header is malformed.
LOGIN_COOKIE_INVALID
Login cookie is not valid.
FAILED_TO_RETRIEVE_LOGIN_COOKIE
Failed to decrypt the login cookie.
USER_ID_INVALID
User Id in the header is not a valid id.
AuthorizationError Errors encountered when trying to authorize a user.
Enumerations
UNABLE_TO_AUTHORIZE
Could not complete authorization due to an internal problem.
NO_ADWORDS_ACCOUNT_FOR_CUSTOMER
Customer has no AdWords account.
USER_PERMISSION_DENIED
User doesn't have permission to access customer.
EFFECTIVE_USER_PERMISSION_DENIED
Effective user doesn't have permission to access this customer.
USER_HAS_READONLY_PERMISSION
User has read-only permission cannot mutate.
NO_CUSTOMER_FOUND
No customer found.
SERVICE_ACCESS_DENIED
Developer doesn't have permission to access service.
BetaError Errors that are thrown when a Beta feature is accessed incorrectly.
Enumerations
BETA_FEATURE
Attempt to use beta feature by non-beta account.
CampaignAdExtensionError CampaignAdExtension errors.
Enumerations
ADEXTENSION_NOT_UNDER_CAMPAIGN
Cannot operate on an adextensions under the wrong campaign
CANNOT_ADD_DELETED_CAMPAIGN_ADEXTENSION
Cannot add a CampaignAdExtension with status DELETED
CANNOT_OPERATE_ON_DELETED_CAMPAIGN_ADEXTENSION
Cannot operate on a CampaignAdExtension with status DELETED
INVALID_ADEXTENSION_ID
Invalid adextension id
MISSING_ADEXTENSION_ID
Missing adextension id
MUST_USE_CONCRETE_ADEXTENSION_DURING_ADD
Must use a concrete subtype of AdExtension (eg. LocationExtension)
MUST_USE_CONCRETE_ADEXTENSION
Must use a concrete subtype of AdExtension (eg. LocationExtension)
UNKNOWN_ERROR
ClientTermsError Error due to user not accepting the AdWords terms of service.
Enumerations
INCOMPLETE_SIGNUP_CURRENT_ADWORDS_TNC_NOT_AGREED
Customer has not agreed to the latest AdWords Terms & Conditions
DatabaseError Errors that are thrown due to a database access problem.
Enumerations
CONCURRENT_MODIFICATION
A concurrency problem occurred as two threads were attempting to modify same object.
PERMISSION_DENIED
The permission was denied to access an object.
CAMPAIGN_PRODUCT_NOT_SUPPORTED
Requested campaign belongs to a product that is not supported by the api.
DUPLICATE_KEY
a duplicate key was detected upon insertion
DATABASE_ERROR
a database error has occurred
UNKNOWN
an unknown error has occurred
DistinctError Errors related to distinct ids or content.
Enumerations
DUPLICATE_ELEMENT
DUPLICATE_TYPE
EntityCountLimitExceeded Signals that an entity count limit was exceeded for some level. For example, too many criteria for a campaign.
Enumerations
ACCOUNT_LIMIT
CAMPAIGN_LIMIT
ADGROUP_LIMIT
ADGROUP_TEXT_AD_LIMIT
Specifies max number of ads not intended for Display Network; applies to MobileAd, TextAd, TemplateAd (text templates only).
ADGROUP_DISPLAY_AD_LIMIT
Specifies max number of Display Network ads; applies to ImageAd, MobileImageAd, TemplateAd (except text templates).
MATCHING_FUNCTION_LIMIT
Exceeds a limit related to a matching function.
UNKNOWN
Specific limit that has been exceeded is unknown (the client may be of an older version than the server).
EntityNotFound An id did not correspond to an entity, or it referred to an entity which does not belong to the customer.
Enumerations
INVALID_ID
The specified id refered to an entity which either doesn't exist or is not accessible to the customer. e.g. campaign belongs to another customer.
IdError Errors associated with the ids.
Enumerations
NOT_FOUND
Id not found
InternalApiError Indicates that a server-side error has occured. InternalApiErrors are generally not the result of an invalid request or message sent by the client.
Enumerations
UNEXPECTED_INTERNAL_API_ERROR
API encountered an unexpected internal error.
UNKNOWN
The cause of the error is not known or only defined in newer versions.
DOWNTIME
The API is currently unavailable for a planned downtime.
NewEntityCreationError Error associated with creation of new entities using TempIds.
Enumerations
CANNOT_SET_ID_FOR_ADD
Do not set the id field while creating new entities.
NotEmptyError Errors corresponding with violation of a NOT EMPTY check.
Enumerations
EMPTY_LIST
NotWhitelistedError Indicates that the customer is not whitelisted for accessing the API.
Enumerations
CUSTOMER_NOT_WHITELISTED_FOR_API
Customer is not whitelisted for accessing the API.
NullError Errors associated with violation of a NOT NULL check.
Enumerations
NULL_CONTENT
Specified list/container must not contain any null elements
OperationAccessDenied Operation not permitted due to the invoked service's access policy.
Enumerations
ACTION_NOT_PERMITTED
Unauthorized invocation of a service's method (get, mutate, etc.)
ADD_OPERATION_NOT_PERMITTED
Unauthorized ADD operation in invoking a service's mutate method.
REMOVE_OPERATION_NOT_PERMITTED
Unauthorized REMOVE operation in invoking a service's mutate method.
SET_OPERATION_NOT_PERMITTED
Unauthorized SET operation in invoking a service's mutate method.
MUTATE_ACTION_NOT_PERMITTED_FOR_CLIENT
A mutate action is not allowed on this campaign, from this client.
UNKNOWN
The reason the invoked method or operation is prohibited is not known (the client may be of an older version than the server).
OperatorError Errors due to the use of unsupported operations.
Enumerations
OPERATOR_NOT_SUPPORTED
PagingError Error codes for pagination. See Paging.
Enumerations
START_INDEX_CANNOT_BE_NEGATIVE
NUMBER_OF_RESULTS_CANNOT_BE_NEGATIVE
UNKNOWN
Used for return value only. An enumeration could not be processed, typically due to incompatibility with your WSDL version.
QuotaCheckError Encapsulates the errors thrown during developer quota checks.
Enumerations
INVALID_TOKEN_HEADER
Customer passed in an invalid token in the header.
ACCOUNT_DELINQUENT
Customer is marked delinquent.
ACCOUNT_INACCESSIBLE
Customer is a fraudulent.
ACCOUNT_INACTIVE
Inactive Account.
INCOMPLETE_SIGNUP
Signup not complete
INCOMPLETE_SIGNUP_LATEST_ADWORDS_API_TNC_NOT_AGREED
Latest AdWords API T&C not agreed.
INCOMPLETE_SIGNUP_NO_BILLING_INFO
No Billing Info.
INCOMPLETE_SIGNUP_USER_INFO_MISSING
User Info missing.
INCOMPLETE_SIGNUP_USER_INFO_PENDING
User Info pending.
INCOMPLETE_SIGNUP_USER_INFO_REJECTED
User Info rejected.
MONTHLY_BUDGET_REACHED
Monthly budget quota reached.
QUOTA_EXCEEDED
Monthly budget quota exceeded.
RangeError A list of all errors associated with the Range constraint.
Enumerations
TOO_LOW
TOO_HIGH
RateExceededError Signals that a call failed because a measured rate exceeded.
Enumerations
RATE_EXCEEDED
Rate exceeded.
ReadOnlyError Errors from attempting to write to read-only fields.
Enumerations
READ_ONLY
RegionCodeError A list of all errors associated with the @RegionCode constraints.
Enumerations
INVALID_REGION_CODE
RejectedError Indicates that a field was rejected due to compatibility issues.
Enumerations
UNKNOWN_VALUE
Unknown value encountered
RequestError Encapsulates the generic errors thrown when there's an error with user request.
Enumerations
UNKNOWN
Error reason is unknown.
INVALID_INPUT
Invalid input.
RequiredError Errors due to missing required field.
Enumerations
REQUIRED
Missing required field.
SelectorError Represents possible error codes for Selector.
Enumerations
INVALID_FIELD_NAME
The field name is not valid.
MISSING_FIELDS
The list of fields is null or empty.
MISSING_PREDICATES
The list of predicates is null or empty.
OPERATOR_DOES_NOT_SUPPORT_MULTIPLE_VALUES
Predicate operator does not support multiple values. Multiple values are supported only for Predicate.Operator.IN and Predicate.Operator.NOT_IN.
INVALID_PREDICATE_ENUM_VALUE
The predicate enum value is not valid.
MISSING_PREDICATE_OPERATOR
The predicate operator is empty.
MISSING_PREDICATE_VALUES
The predicate values are empty.
INVALID_PREDICATE_FIELD_NAME
The predicate field name is not valid.
INVALID_PREDICATE_OPERATOR
The predicate operator is not valid.
INVALID_FIELD_SELECTION
Invalid selection of fields.
INVALID_PREDICATE_VALUE
The predicate value is not valid.
INVALID_SORT_FIELD_NAME
The sort field name is not valid or the field is not sortable.
SELECTOR_ERROR
Standard error.
FILTER_BY_DATE_RANGE_NOT_SUPPORTED
Filtering by date range is not supported.
START_INDEX_IS_TOO_HIGH
Selector paging start index is too high.
UNKNOWN_ERROR
Used for return value only. An enumeration could not be processed, typically due to incompatibility with your WSDL version.
SizeLimitError Indicates that the number of entries in the request or response exceeds the system limit.
Enumerations
REQUEST_SIZE_LIMIT_EXCEEDED
The number of entries in the request exceeds the system limit.
RESPONSE_SIZE_LIMIT_EXCEEDED
The number of entries in the response exceeds the system limit.
UNKNOWN
Used for return value only. An enumeration could not be processed, typically due to incompatibility with your WSDL version.
StringLengthError Errors associated with the length of the given string being out of bounds.
Enumerations
TOO_SHORT
TOO_LONG

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 3.0 License, and code samples are licensed under the Apache 2.0 License. For details, see our Site Policies.

Authentication required

You need to be signed in with Google+ to do that.

Signing you in...

Google Developers needs your permission to do that.