Share your feedback about the AdWords API! Take our annual survey.

AdGroupCriterionService (v201809)

Use this service to manage criteria (such as keywords or placements). A criterion describes the conditions that determine if an ad should display. Two classes of criteria are available:

  • A biddable criterion defines conditions that will cause the parent ad group's ads to display. A biddable criterion can also specify a bid amount that overrides the parent ad group's default bid.
  • A negative criterion defines conditions that will prevent the parent ad group's ads from displaying.


Production WSDL
https://adwords.google.com/api/adwords/cm/v201809/AdGroupCriterionService?wsdl
Namespace
https://adwords.google.com/api/adwords/cm/v201809
Operations
Errors

get

Gets adgroup criteria.

Parameters

Field Type Description
serviceSelector Selector filters the adgroup criteria to be returned.

Response

Field Type Description
rval AdGroupCriterionPage a page (subset) view of the criteria selected

mutate

Adds, removes or updates adgroup criteria.

Parameters

Field Type Description
operations AdGroupCriterionOperation[] operations to do during checks on keywords to be added.

Response

Field Type Description
rval AdGroupCriterionReturnValue added and updated adgroup criteria (without optional parts)

mutateLabel

Adds labels to the AdGroupCriterion or removes labels from the AdGroupCriterion

Add - Apply an existing label to an existing ad group criterion. The adGroupId and criterionId must reference an existing ad group criterion. The labelId must reference an existing label.

Remove - Removes the link between the specified ad group criterion and label.

Parameters

Field Type Description
operations AdGroupCriterionLabelOperation[] the operations to apply

Response

Field Type Description
rval AdGroupCriterionLabelReturn... a list of AdGroupCriterionLabel where each entry in the list is the result of applying the operation in the input list with the same index. For an add operation, the returned AdGroupCriterionLabel contains the AdGroupId, CriterionId and the LabelId. In the case of a remove operation, the returned AdGroupCriterionLabel will only have AdGroupId and CriterionId.

query

Returns the list of AdGroupCriterion that match the query.

Parameters

Field Type Description
query xsd:string The SQL-like AWQL query string

Response

Field Type Description
rval AdGroupCriterionPage

Errors

Error Reasons
AdGroupCriterionError Base error class for Ad Group Criterion Service.
Enumerations
AD_GROUP_CRITERION_LABEL_DOES_NOT_EXIST
No link found between the AdGroupCriterion and the label.
AD_GROUP_CRITERION_LABEL_ALREADY_EXISTS
The label has already been attached to the AdGroupCriterion.
CANNOT_ADD_LABEL_TO_NEGATIVE_CRITERION
Negative AdGroupCriterion cannot have labels.
TOO_MANY_OPERATIONS
Too many operations for a single call.
CANT_UPDATE_NEGATIVE
Negative ad group criteria are not updateable.
CONCRETE_TYPE_REQUIRED
Concrete type of criterion (keyword v.s. placement) is required for ADD and SET operations.
BID_INCOMPATIBLE_WITH_ADGROUP
Bid is incompatible with ad group's bidding settings.
CANNOT_TARGET_AND_EXCLUDE
Cannot target and exclude the same criterion at once.
ILLEGAL_URL
The URL of a placement is invalid.
INVALID_KEYWORD_TEXT
Keyword text was invalid.
INVALID_DESTINATION_URL
Destination URL was invalid.
MISSING_DESTINATION_URL_TAG
The destination url must contain at least one tag (e.g. {lpurl})
KEYWORD_LEVEL_BID_NOT_SUPPORTED_FOR_MANUALCPM
Keyword-level cpm bid is not supported
INVALID_USER_STATUS
For example, cannot add a biddable ad group criterion that had been removed.
CANNOT_ADD_CRITERIA_TYPE
Criteria type cannot be targeted for the ad group. Either the account is restricted to keywords only, the criteria type is incompatible with the campaign's bidding strategy, or the criteria type can only be applied to campaigns.
CANNOT_EXCLUDE_CRITERIA_TYPE
Criteria type cannot be excluded for the ad group. Refer to the documentation for a specific criterion to check if it is excludable.
INVALID_PRODUCT_PARTITION_HIERARCHY
Ad group is invalid due to the product partitions it contains.
PRODUCT_PARTITION_UNIT_CANNOT_HAVE_CHILDREN
Product partition unit cannot have children.
PRODUCT_PARTITION_SUBDIVISION_REQUIRES_OTHERS_CASE
Subdivided product partitions must have an "others" case.
PRODUCT_PARTITION_REQUIRES_SAME_DIMENSION_TYPE_AS_SIBLINGS
Dimension type of product partition must be the same as that of its siblings.
PRODUCT_PARTITION_ALREADY_EXISTS
Product partition cannot be added to the ad group because it already exists.
PRODUCT_PARTITION_DOES_NOT_EXIST
Product partition referenced in the operation was not found in the ad group.
PRODUCT_PARTITION_CANNOT_BE_REMOVED
Recursive removal failed because product partition subdivision is being created or modified in this request.
INVALID_PRODUCT_PARTITION_TYPE
Product partition type is not allowed for specified AdGroupCriterion type.
PRODUCT_PARTITION_ADD_MAY_ONLY_USE_TEMP_ID
Product partition in an ADD operation specifies a non temporary CriterionId.
CAMPAIGN_TYPE_NOT_COMPATIBLE_WITH_PARTIAL_FAILURE
Partial failure is not supported for shopping campaign mutate operations.
OPERATIONS_FOR_TOO_MANY_SHOPPING_ADGROUPS
Operations in the mutate request changes too many shopping ad groups. Please split requests for multiple shopping ad groups across multiple requests.
CANNOT_MODIFY_URL_FIELDS_WITH_DUPLICATE_ELEMENTS
Not allowed to modify url fields of an ad group criterion if there are duplicate elements for that ad group criterion in the request.
CANNOT_SET_WITHOUT_FINAL_URLS
Cannot set url fields without also setting final urls.
CANNOT_CLEAR_FINAL_URLS_IF_FINAL_MOBILE_URLS_EXIST
Cannot clear final urls if final mobile urls exist.
CANNOT_CLEAR_FINAL_URLS_IF_FINAL_APP_URLS_EXIST
Cannot clear final urls if final app urls exist.
CANNOT_CLEAR_FINAL_URLS_IF_TRACKING_URL_TEMPLATE_EXISTS
Cannot clear final urls if tracking url template exists.
CANNOT_CLEAR_FINAL_URLS_IF_URL_CUSTOM_PARAMETERS_EXIST
Cannot clear final urls if url custom parameters exist.
CANNOT_SET_BOTH_DESTINATION_URL_AND_FINAL_URLS
Cannot set both destination url and final urls.
CANNOT_SET_BOTH_DESTINATION_URL_AND_TRACKING_URL_TEMPLATE
Cannot set both destination url and tracking url template.
FINAL_URLS_NOT_SUPPORTED_FOR_CRITERION_TYPE
Final urls are not supported for this criterion type.
FINAL_MOBILE_URLS_NOT_SUPPORTED_FOR_CRITERION_TYPE
Final mobile urls are not supported for this criterion type.
UNKNOWN
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. Starting version V201409 ClientCustomerId will be required for all requests except for CustomerService.get
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.
CUSTOMER_NOT_ACTIVE
Access denied since the customer is not active.
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.
TWO_STEP_VERIFICATION_NOT_ENROLLED
The customer has a policy to enforce 2-Step Verification, but the user is not enrolled.
ADVANCED_PROTECTION_NOT_ENROLLED
The customer has a policy to enforce enrollment in the Advanced Protection Program, but the user is not enrolled.
BiddingErrors Represents error codes for bidding strategy entities.
Enumerations
BIDDING_STRATEGY_TRANSITION_NOT_ALLOWED
Cannot transition to new bidding strategy.
BIDDING_STRATEGY_NOT_COMPATIBLE_WITH_ADGROUP_OVERRIDES
Bidding strategy cannot be overridden by current ad group bidding strategy.
BIDDING_STRATEGY_NOT_COMPATIBLE_WITH_ADGROUP_CRITERIA_OVERRIDES
Bidding strategy cannot be overridden by current criteria bidding strategy.
CAMPAIGN_BIDDING_STRATEGY_CANNOT_BE_OVERRIDDEN
Cannot override campaign bidding strategy.
ADGROUP_BIDDING_STRATEGY_CANNOT_BE_OVERRIDDEN
Cannot override ad group bidding strategy.
CANNOT_ATTACH_BIDDING_STRATEGY_TO_CAMPAIGN
Cannot attach bidding strategy to campaign.
CANNOT_ATTACH_BIDDING_STRATEGY_TO_ADGROUP
Cannot attach bidding strategy to ad group.
CANNOT_ATTACH_BIDDING_STRATEGY_TO_ADGROUP_CRITERIA
Cannot attach bidding strategy to criteria.
INVALID_ANONYMOUS_BIDDING_STRATEGY_TYPE
Bidding strategy is not supported or cannot be used as anonymous.
BIDS_NOT_ALLLOWED
No bids may be set. The bid list must be null or empty.
DUPLICATE_BIDS
The bid list contains two or more bids of the same type.
INVALID_BIDDING_SCHEME
The bidding scheme does not match the bidding strategy type.
INVALID_BIDDING_STRATEGY_TYPE
The type does not match the named strategy's type.
MISSING_BIDDING_STRATEGY_TYPE
The bidding strategy type is missing.
NULL_BID
The bid list contains a null entry.
INVALID_BID
The bid is invalid.
BIDDING_STRATEGY_NOT_AVAILABLE_FOR_ACCOUNT_TYPE
Bidding strategy is not available for the account type.
CONVERSION_TRACKING_NOT_ENABLED
Conversion tracking is not enabled for the campaign for VBB transition.
NOT_ENOUGH_CONVERSIONS
Not enough conversions tracked for VBB transitions.
CANNOT_CREATE_CAMPAIGN_WITH_BIDDING_STRATEGY
Campaign can not be created with given bidding strategy. It can be transitioned to the strategy, once eligible.
CANNOT_TARGET_CONTENT_NETWORK_ONLY_WITH_AD_GROUP_LEVEL_POP_BIDDING_STRATEGY
Cannot target content network only as ad group uses Page One Promoted bidding strategy.
CANNOT_TARGET_CONTENT_NETWORK_ONLY_WITH_CAMPAIGN_LEVEL_POP_BIDDING_STRATEGY
Cannot target content network only as campaign uses Page One Promoted bidding strategy.
BIDDING_STRATEGY_NOT_SUPPORTED_WITH_AD_SCHEDULE
Budget Optimizer and Target Spend bidding strategies are not supported for campaigns with AdSchedule targeting.
PAY_PER_CONVERSION_NOT_AVAILABLE_FOR_CUSTOMER
Pay per conversion is not available to all the customer, only few whitelisted customers can use this.
PAY_PER_CONVERSION_NOT_ALLOWED_WITH_TARGET_CPA
Pay per conversion is not allowed with Target CPA.
BIDDING_STRATEGY_NOT_ALLOWED_FOR_SEARCH_ONLY_CAMPAIGNS
Cannot set bidding strategy to Manual CPM for search network only campaigns.
BIDDING_STRATEGY_NOT_SUPPORTED_IN_DRAFTS_OR_EXPERIMENTS
The bidding strategy is not supported for use in drafts or experiments.
BIDDING_STRATEGY_TYPE_DOES_NOT_SUPPORT_PRODUCT_TYPE_ADGROUP_CRITERION
Bidding strategy type does not support product type ad group criterion.
BID_TOO_SMALL
Bid amount is too small.
BID_TOO_BIG
Bid amount is too big.
BID_TOO_MANY_FRACTIONAL_DIGITS
Bid has too many fractional digit precision.
ENHANCED_CPC_ENABLED_NOT_SUPPORTED_ON_PORTFOLIO_TARGET_SPEND_STRATEGY
EnhancedCpcEnabled cannot be set on portfolio Target Spend strategies.
BIDDING_STRATEGY_TYPE_NOT_ALLOWED_FOR_UNIVERSAL_APP_BIDDING_STRATEGY_GOAL_TYPE
The bidding strategy is not allowed for the universal app bidding strategy goal type.
UNKNOWN
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
CollectionSizeError Errors associated with the size of the given collection being out of bounds.
Enumerations
TOO_FEW
TOO_MANY
CriterionError Error class used for reporting criteria related errors.
Enumerations
CONCRETE_TYPE_REQUIRED
Concrete type of criterion is required for ADD and SET operations.
INVALID_EXCLUDED_CATEGORY
The category requested for exclusion is invalid.
INVALID_KEYWORD_TEXT
Invalid keyword criteria text.
KEYWORD_TEXT_TOO_LONG
Keyword text should be less than 80 chars.
KEYWORD_HAS_TOO_MANY_WORDS
Keyword text has too many words.
KEYWORD_HAS_INVALID_CHARS
Keyword text has invalid characters or symbols.
INVALID_PLACEMENT_URL
Invalid placement URL.
INVALID_USER_LIST
Invalid user list criterion.
INVALID_USER_INTEREST
Invalid user interest criterion.
INVALID_FORMAT_FOR_PLACEMENT_URL
Placement URL has wrong format.
PLACEMENT_URL_IS_TOO_LONG
Placement URL is too long.
PLACEMENT_URL_HAS_ILLEGAL_CHAR
Indicates the URL contains an illegal character.
PLACEMENT_URL_HAS_MULTIPLE_SITES_IN_LINE
Indicates the URL contains multiple comma separated URLs.
PLACEMENT_IS_NOT_AVAILABLE_FOR_TARGETING_OR_EXCLUSION
Indicates the domain is blacklisted.
INVALID_VERTICAL_PATH
Invalid vertical path.
INVALID_YOUTUBE_CHANNEL_ID
The YouTube Channel Id is invalid.
INVALID_YOUTUBE_VIDEO_ID
The YouTube Video Id is invalid.
YOUTUBE_VERTICAL_CHANNEL_DEPRECATED
Indicates the placement is a YouTube vertical channel, which is no longer supported.
YOUTUBE_DEMOGRAPHIC_CHANNEL_DEPRECATED
Indicates the placement is a YouTube demographic channel, which is no longer supported.
YOUTUBE_URL_UNSUPPORTED
YouTube urls are not supported in Placement criterion. Use YouTubeChannel and YouTubeVideo criterion instead.
CANNOT_EXCLUDE_CRITERIA_TYPE
Criteria type can not be excluded by the customer, like AOL account type cannot target site type criteria.
CANNOT_ADD_CRITERIA_TYPE
Criteria type can not be targeted.
INVALID_PRODUCT_FILTER
Product filter in the product criteria has invalid characters. Operand and the argument in the filter can not have "==" or "&+".
PRODUCT_FILTER_TOO_LONG
Product filter in the product criteria is translated to a string as operand1==argument1&+operand2==argument2, maximum allowed length for the string is 255 chars.
CANNOT_EXCLUDE_SIMILAR_USER_LIST
Not allowed to exclude similar user list.
CANNOT_ADD_CLOSED_USER_LIST
Not allowed to target a closed user list.
CANNOT_ADD_DISPLAY_ONLY_LISTS_TO_SEARCH_ONLY_CAMPAIGNS
Not allowed to add display only UserLists to search only campaigns.
CANNOT_ADD_DISPLAY_ONLY_LISTS_TO_SEARCH_CAMPAIGNS
Not allowed to add display only UserLists to search plus campaigns.
CANNOT_ADD_DISPLAY_ONLY_LISTS_TO_SHOPPING_CAMPAIGNS
Not allowed to add display only UserLists to shopping campaigns.
CANNOT_ADD_USER_INTERESTS_TO_SEARCH_CAMPAIGNS
Not allowed to add User interests to search only campaigns.
CANNOT_SET_BIDS_ON_CRITERION_TYPE_IN_SEARCH_CAMPAIGNS
Not allowed to set bids for this criterion type in search campaigns
CANNOT_ADD_URLS_TO_CRITERION_TYPE_FOR_CAMPAIGN_TYPE
Final URLs, URL Templates and CustomParameters cannot be set for the criterion types of Gender, AgeRange, UserList, Placement, MobileApp, and MobileAppCategory in search campaigns and shopping campaigns.
CANNOT_ADD_POSITIVE_PLACEMENTS_TO_SEARCH_CAMPAIGNS
Positive (targeted) criteria in the Placement targeting dimension (aka CriterionTypeGroup) are not allowed in Search campaigns. They can only be excluded. The Placement targeting dimension includes Placements, MobileApps, MobileAppCategories, YouTubeChannels, YouTubeVideos, etc.
INVALID_IP_ADDRESS
IP address is not valid.
INVALID_IP_FORMAT
IP format is not valid.
INVALID_MOBILE_APP
Mobile application is not valid.
INVALID_MOBILE_APP_CATEGORY
Mobile application category is not valid.
INVALID_CRITERION_ID
The CriterionId does not exist or is of the incorrect type.
CANNOT_TARGET_CRITERION
The Criterion is not allowed to be targeted.
CANNOT_TARGET_OBSOLETE_CRITERION
The criterion is not allowed to be targeted as it is deprecated.
CRITERION_ID_AND_TYPE_MISMATCH
The CriterionId is not valid for the type.
INVALID_PROXIMITY_RADIUS
Distance for the radius for the proximity criterion is invalid.
INVALID_PROXIMITY_RADIUS_UNITS
Units for the distance for the radius for the proximity criterion is invalid.
INVALID_STREETADDRESS_LENGTH
Street address is too short.
INVALID_CITYNAME_LENGTH
City name in the address is too short.
INVALID_REGIONCODE_LENGTH
Region code in the address is too short.
INVALID_REGIONNAME_LENGTH
Region name in the address is not valid.
INVALID_POSTALCODE_LENGTH
Postal code in the address is not valid.
INVALID_COUNTRY_CODE
Country code in the address is not valid.
INVALID_LATITUDE
Latitude for the GeoPoint is not valid.
INVALID_LONGITUDE
Longitude for the GeoPoint is not valid.
PROXIMITY_GEOPOINT_AND_ADDRESS_BOTH_CANNOT_BE_NULL
The Proximity input is not valid. Both address and geoPoint cannot be null.
INVALID_PROXIMITY_ADDRESS
The Proximity address cannot be geocoded to a valid lat/long.
INVALID_USER_DOMAIN_NAME
User domain name is not valid.
INVALID_WEBPAGE_CONDITION
The combination of operand and operator in webpage condition is invalid.
INVALID_WEBPAGE_CONDITION_URL
The URL of webpage condition is invalid.
WEBPAGE_CONDITION_URL_CANNOT_BE_EMPTY
The URL of webpage condition cannot be empty or contain white space.
WEBPAGE_CONDITION_URL_UNSUPPORTED_PROTOCOL
The URL of webpage condition contains unsupported protocol.
WEBPAGE_CONDITION_URL_CANNOT_BE_IP_ADDRESS
The URL of webpage condition cannot be an IP address.
WEBPAGE_CONDITION_URL_DOMAIN_NOT_CONSISTENT_WITH_CAMPAIGN_SETTING
The domain of the URL is not consistent with the domain in campaign setting.
WEBPAGE_CONDITION_URL_CANNOT_BE_PUBLIC_SUFFIX
The URL of webpage condition cannot be a public suffix itself.
WEBPAGE_CONDITION_URL_INVALID_PUBLIC_SUFFIX
The URL of webpage condition has an invalid public suffix.
WEBPAGE_CONDITION_URL_VALUE_TRACK_VALUE_NOT_SUPPORTED
Value track parameter is not supported in webpage condition URL.
WEBPAGE_CRITERION_URL_EQUALS_CAN_HAVE_ONLY_ONE_CONDITION
Only one URL-EQUALS webpage condition is allowed in a webpage criterion and it cannot be combined with other conditions.
WEBPAGE_CRITERION_CANNOT_ADD_NON_SMART_TARGETING_TO_NON_DSA_AD_GROUP
Only allow smart targeting on non-DSA ad groups.
CRITERION_PARAMETER_TOO_LONG
Length of serialized criterion parameter exceeded size limit.
AD_SCHEDULE_TIME_INTERVALS_OVERLAP
Time interval in the AdSchedule overlaps with another AdSchedule.
AD_SCHEDULE_INTERVAL_CANNOT_SPAN_MULTIPLE_DAYS
AdSchedule time interval cannot span multiple days.
AD_SCHEDULE_INVALID_TIME_INTERVAL
AdSchedule time interval specified is invalid, endTime cannot be earlier than startTime.
AD_SCHEDULE_EXCEEDED_INTERVALS_PER_DAY_LIMIT
The number of AdSchedule entries in a day exceeds the limit.
AD_SCHEDULE_CRITERION_ID_MISMATCHING_FIELDS
CriteriaId does not match the interval of the AdSchedule specified.
CANNOT_BID_MODIFY_CRITERION_TYPE
Cannot set bid modifier for this criterion type.
CANNOT_BID_MODIFY_CRITERION_CAMPAIGN_OPTED_OUT
Cannot bid modify criterion, since it is opted out of the campaign.
CANNOT_BID_MODIFY_NEGATIVE_CRITERION
Cannot set bid modifier for a negative criterion.
BID_MODIFIER_ALREADY_EXISTS
Bid Modifier already exists. Use SET operation to update.
FEED_ID_NOT_ALLOWED
Feed Id is not allowed in these Location Groups.
ACCOUNT_INELIGIBLE_FOR_CRITERIA_TYPE
The account may not use the requested criteria type. For example, some accounts are restricted to keywords only.
CRITERIA_TYPE_INVALID_FOR_BIDDING_STRATEGY
The requested criteria type cannot be used with campaign or ad group bidding strategy.
CANNOT_EXCLUDE_CRITERION
The Criterion is not allowed to be excluded.
CANNOT_REMOVE_CRITERION
The criterion is not allowed to be removed. For example, we cannot remove any of the platform criterion.
PRODUCT_SCOPE_TOO_LONG
The combined length of product dimension values of the product scope criterion is too long.
PRODUCT_SCOPE_TOO_MANY_DIMENSIONS
Product scope contains too many dimensions.
PRODUCT_PARTITION_TOO_LONG
The combined length of product dimension values of the product partition criterion is too long.
PRODUCT_PARTITION_TOO_MANY_DIMENSIONS
Product partition contains too many dimensions.
INVALID_PRODUCT_DIMENSION
The product dimension is invalid (e.g. dimension contains illegal value, dimension type is represented with wrong class, etc). Product dimension value can not contain "==" or "&+".
INVALID_PRODUCT_DIMENSION_TYPE
Product dimension type is either invalid for campaigns of this type or cannot be used in the current context. BIDDING_CATEGORY_Lx and PRODUCT_TYPE_Lx product dimensions must be used in ascending order of their levels: L1, L2, L3, L4, L5... The levels must be specified sequentially and start from L1. Furthermore, an "others" product partition cannot be subdivided with a dimension of the same type but of a higher level ("others" BIDDING_CATEGORY_L3 can be subdivided with BRAND but not with BIDDING_CATEGORY_L4).
INVALID_PRODUCT_BIDDING_CATEGORY
Bidding categories do not form a valid path in the Shopping bidding category taxonomy.
MISSING_SHOPPING_SETTING
ShoppingSetting must be added to the campaign before ProductScope criteria can be added.
INVALID_MATCHING_FUNCTION
Matching function is invalid.
LOCATION_FILTER_NOT_ALLOWED
Filter parameters not allowed for location groups targeting.
LOCATION_FILTER_INVALID
Given location filter parameter is invalid for location groups targeting.
CANNOT_ATTACH_CRITERIA_AT_CAMPAIGN_AND_ADGROUP
Criteria type cannot be associated with a campaign and its ad group(s) simultaneously.
ADSENSE_FOR_MOBILE_APPS_PLACEMENT_DEPRECATED
adsenseformobileapps.com placement is no longer supported.
UNKNOWN
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.
ACCESS_PROHIBITED
The user's access to an object has been prohibited.
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
DateError Errors associated with invalid dates and date ranges.
Enumerations
INVALID_FIELD_VALUES_IN_DATE
Given field values do not correspond to a valid date.
INVALID_FIELD_VALUES_IN_DATE_TIME
Given field values do not correspond to a valid date time.
INVALID_STRING_DATE
The string date's format should be yyyymmdd.
INVALID_STRING_DATE_RANGE
The string date range's format should be yyyymmdd yyyymmdd.
INVALID_STRING_DATE_TIME
The string date time's format should be yyyymmdd hhmmss [tz].
EARLIER_THAN_MINIMUM_DATE
Date is before allowed minimum.
LATER_THAN_MAXIMUM_DATE
Date is after allowed maximum.
DATE_RANGE_MINIMUM_DATE_LATER_THAN_MAXIMUM_DATE
Date range bounds are not in order.
DATE_RANGE_MINIMUM_AND_MAXIMUM_DATES_BOTH_NULL
Both dates in range are null.
DistinctError Errors related to distinct ids or content.
Enumerations
DUPLICATE_ELEMENT
DUPLICATE_TYPE
EntityAccessDenied Reports permission problems trying to access an entity.
Enumerations
READ_ACCESS_DENIED
User did not have read access.
WRITE_ACCESS_DENIED
User did not have write access.
EntityCountLimitExceeded Signals that an entity count limit was exceeded for some level. For example, too many criteria for a campaign.
Enumerations
ACCOUNT_LIMIT
Indicates that this request would exceed the number of allowed entities for the AdWords account. The exact entity type and limit being checked can be inferred from accountLimitType.
CAMPAIGN_LIMIT
Indicates that this request would exceed the number of allowed entities in a Campaign. The exact entity type and limit being checked can be inferred from accountLimitType, and the numeric id of the Campaign involved is given by enclosingId.
ADGROUP_LIMIT
Indicates that this request would exceed the number of allowed entities in an ad group. The exact entity type and limit being checked can be inferred from accountLimitType, and the numeric id of the ad group involved is given by enclosingId.
AD_GROUP_AD_LIMIT
Indicates that this request would exceed the number of allowed entities in an ad group ad. The exact entity type and limit being checked can be inferred from accountLimitType, and the enclosingId contains the ad group id followed by the ad id, separated by a single comma (,).
AD_GROUP_CRITERION_LIMIT
Indicates that this request would exceed the number of allowed entities in an ad group criterion. The exact entity type and limit being checked can be inferred from accountLimitType, and the enclosingId contains the ad group id followed by the criterion id, separated by a single comma (,).
SHARED_SET_LIMIT
Indicates that this request would exceed the number of allowed entities in this shared set. The exact entity type and limit being checked can be inferred from accountLimitType, and the numeric id of the shared set involved is given by enclosingId.
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.
ForwardCompatibilityError A ForwardComptibilityError represents possible errors when using the forwardCompatibilityMap in some of the common services.
Enumerations
INVALID_FORWARD_COMPATIBILITY_MAP_VALUE
Invalid value specified for a key in the forward compatibility map.
UNKNOWN
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.
TRANSIENT_ERROR
A temporary error occurred during the request. Please retry.
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.
ERROR_GENERATING_RESPONSE
Mutate succeeded but server was unable to build response. Client should not retry mutate.
MultiplierError Represents errors in bid multipliers.
Enumerations
MULTIPLIER_TOO_HIGH
Multiplier value is too high
MULTIPLIER_TOO_LOW
Multiplier value is too low
TOO_MANY_FRACTIONAL_DIGITS
Too many fractional digits
MULTIPLIER_NOT_ALLOWED_FOR_BIDDING_STRATEGY
A multiplier cannot be set for this bidding strategy
MULTIPLIER_NOT_ALLOWED_WHEN_BASE_BID_IS_MISSING
A multiplier cannot be set when there is no base bid (e.g., content max cpc)
NO_MULTIPLIER_SPECIFIED
A bid multiplier must be specified
MULTIPLIER_CAUSES_BID_TO_EXCEED_DAILY_BUDGET
Multiplier causes bid to exceed daily budget
MULTIPLIER_CAUSES_BID_TO_EXCEED_MONTHLY_BUDGET
Multiplier causes bid to exceed monthly budget
MULTIPLIER_CAUSES_BID_TO_EXCEED_CUSTOM_BUDGET
Multiplier causes bid to exceed custom budget
MULTIPLIER_CAUSES_BID_TO_EXCEED_MAX_ALLOWED_BID
Multiplier causes bid to exceed maximum allowed bid
BID_LESS_THAN_MIN_ALLOWED_BID_WITH_MULTIPLIER
Multiplier causes bid to become less than the minimum bid allowed
MULTIPLIER_AND_BIDDING_STRATEGY_TYPE_MISMATCH
Multiplier type (cpc vs. cpm) needs to match campaign's bidding strategy
MULTIPLIER_ERROR
NewEntityCreationError Error associated with creation of new entities.
Enumerations
CANNOT_SET_ID_FOR_ADD
Do not set the id field while creating new entities.
DUPLICATE_TEMP_IDS
Creating more than one entity with the same temp ID is not allowed.
TEMP_ID_ENTITY_HAD_ERRORS
Parent object with specified temp id failed validation, so no deep validation will be done for this child entity.
NotEmptyError Errors corresponding with violation of a NOT EMPTY check.
Enumerations
EMPTY_LIST
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.
OPERATION_NOT_PERMITTED_FOR_CAMPAIGN_TYPE
This operation is not permitted on this campaign type
ADD_AS_REMOVED_NOT_PERMITTED
An ADD operation may not set status to REMOVED.
OPERATION_NOT_PERMITTED_FOR_REMOVED_ENTITY
This operation is not allowed because the campaign or adgroup is removed.
OPERATION_NOT_PERMITTED_FOR_AD_GROUP_TYPE
This operation is not permitted on this ad group type.
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.
Enumerations
START_INDEX_CANNOT_BE_NEGATIVE
The start index value cannot be a negative number.
NUMBER_OF_RESULTS_CANNOT_BE_NEGATIVE
The number of results cannot be a negative number.
UNKNOWN
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.
QueryError A QueryError represents possible errors for query parsing and execution.
Enumerations
PARSING_FAILED
Exception that happens when trying to parse a query that doesn't match the AWQL grammar.
MISSING_QUERY
The provided query is an empty string.
MISSING_SELECT_CLAUSE
The query does not contain the required SELECT clause or it is not in the correct location.
MISSING_FROM_CLAUSE
The query does not contain the required FROM clause or it is not in the correct location.
INVALID_SELECT_CLAUSE
The SELECT clause could not be parsed.
INVALID_FROM_CLAUSE
The FROM clause could not be parsed.
INVALID_WHERE_CLAUSE
The WHERE clause could not be parsed.
INVALID_ORDER_BY_CLAUSE
The ORDER BY clause could not be parsed.
INVALID_LIMIT_CLAUSE
The LIMIT clause could not be parsed.
INVALID_START_INDEX_IN_LIMIT_CLAUSE
The startIndex in the LIMIT clause does not contain a valid integer.
INVALID_PAGE_SIZE_IN_LIMIT_CLAUSE
The pageSize in the LIMIT clause does not contain a valid integer.
INVALID_DURING_CLAUSE
The DURING clause could not be parsed.
INVALID_MIN_DATE_IN_DURING_CLAUSE
The minimum date in the DURING clause is not a valid date in YYYYMMDD format.
INVALID_MAX_DATE_IN_DURING_CLAUSE
The maximum date in the DURING clause is not a valid date in YYYYMMDD format.
MAX_LESS_THAN_MIN_IN_DURING_CLAUSE
The minimum date in the DURING is after the maximum date.
VALIDATION_FAILED
The query matched the grammar, but is invalid in some way such as using a service that isn't supported.
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
DEVELOPER_TOKEN_NOT_APPROVED
Developer token is not approved for production access, and the customer is attempting to access a production account.
TERMS_AND_CONDITIONS_NOT_SIGNED
Terms and conditions are not signed.
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
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.
UNSUPPORTED_VERSION
The api version in the request has been discontinued. Please update to the new AdWords API version.
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.
TOO_MANY_PREDICATE_VALUES
The values list in a predicate was too long.
UNKNOWN_ERROR
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.
INTERNAL_STORAGE_ERROR
The account is too large to load.
UNKNOWN
StatsQueryError Represents possible error codes when querying for stats.
Enumerations
DATE_NOT_IN_VALID_RANGE
Date is outside of allowed range.
StringFormatError A list of error code for reporting invalid content of input strings.
Enumerations
UNKNOWN
ILLEGAL_CHARS
The input string value contains disallowed characters.
INVALID_FORMAT
The input string value is invalid for the associated field.
StringLengthError Errors associated with the length of the given string being out of bounds.
Enumerations
TOO_SHORT
TOO_LONG
UrlError Url Validation errors.
Enumerations
INVALID_TRACKING_URL_TEMPLATE
The tracking url template is invalid.
INVALID_TAG_IN_TRACKING_URL_TEMPLATE
The tracking url template contains invalid tag.
MISSING_TRACKING_URL_TEMPLATE_TAG
The tracking url template must contain at least one tag (e.g. {lpurl}), This applies only to tracking url template associated with website ads or product ads.
MISSING_PROTOCOL_IN_TRACKING_URL_TEMPLATE
The tracking url template must start with a valid protocol (or lpurl tag).
INVALID_PROTOCOL_IN_TRACKING_URL_TEMPLATE
The tracking url template starts with an invalid protocol.
MALFORMED_TRACKING_URL_TEMPLATE
The tracking url template contains illegal characters.
MISSING_HOST_IN_TRACKING_URL_TEMPLATE
The tracking url template must contain a host name (or lpurl tag).
INVALID_TLD_IN_TRACKING_URL_TEMPLATE
The tracking url template has an invalid or missing top level domain extension.
REDUNDANT_NESTED_TRACKING_URL_TEMPLATE_TAG
The tracking url template contains nested occurrences of the same conditional tag (i.e. {ifmobile:{ifmobile:x}}).
INVALID_FINAL_URL
The final url is invalid.
INVALID_TAG_IN_FINAL_URL
The final url contains invalid tag.
REDUNDANT_NESTED_FINAL_URL_TAG
The final url contains nested occurrences of the same conditional tag (i.e. {ifmobile:{ifmobile:x}}).
MISSING_PROTOCOL_IN_FINAL_URL
The final url must start with a valid protocol.
INVALID_PROTOCOL_IN_FINAL_URL
The final url starts with an invalid protocol.
MALFORMED_FINAL_URL
The final url contains illegal characters.
MISSING_HOST_IN_FINAL_URL
The final url must contain a host name.
INVALID_TLD_IN_FINAL_URL
The tracking url template has an invalid or missing top level domain extension.
INVALID_FINAL_MOBILE_URL
The final mobile url is invalid.
INVALID_TAG_IN_FINAL_MOBILE_URL
The final mobile url contains invalid tag.
REDUNDANT_NESTED_FINAL_MOBILE_URL_TAG
The final mobile url contains nested occurrences of the same conditional tag (i.e. {ifmobile:{ifmobile:x}}).
MISSING_PROTOCOL_IN_FINAL_MOBILE_URL
The final mobile url must start with a valid protocol.
INVALID_PROTOCOL_IN_FINAL_MOBILE_URL
The final mobile url starts with an invalid protocol.
MALFORMED_FINAL_MOBILE_URL
The final mobile url contains illegal characters.
MISSING_HOST_IN_FINAL_MOBILE_URL
The final mobile url must contain a host name.
INVALID_TLD_IN_FINAL_MOBILE_URL
The tracking url template has an invalid or missing top level domain extension.
INVALID_FINAL_APP_URL
The final app url is invalid.
INVALID_TAG_IN_FINAL_APP_URL
The final app url contains invalid tag.
REDUNDANT_NESTED_FINAL_APP_URL_TAG
The final app url contains nested occurrences of the same conditional tag (i.e. {ifmobile:{ifmobile:x}}).
MULTIPLE_APP_URLS_FOR_OSTYPE
More than one app url found for the same OS type.
INVALID_OSTYPE
The OS type given for an app url is not valid.
INVALID_PROTOCOL_FOR_APP_URL
The protocol given for an app url is not valid. (E.g. "android-app://")
INVALID_PACKAGE_ID_FOR_APP_URL
The package id (app id) given for an app url is not valid.
URL_CUSTOM_PARAMETERS_COUNT_EXCEEDS_LIMIT
The number of url custom parameters for an entity exceeds the maximum limit allowed.
URL_CUSTOM_PARAMETER_REMOVAL_WITH_NON_NULL_VALUE
The parameter has isRemove set to true but a value that is non-null.
CANNOT_REMOVE_URL_CUSTOM_PARAMETER_IN_ADD_OPERATION
For add operations, there will not be any existing parameters to delete.
CANNOT_REMOVE_URL_CUSTOM_PARAMETER_DURING_FULL_REPLACEMENT
When the doReplace flag is set to true, individual parameters cannot be deleted.
FINAL_URL_SUFFIX_MALFORMED
The final url suffix cannot begin with ? or & characters and must be a valid query string.
INVALID_TAG_IN_FINAL_URL_SUFFIX
The final url suffix cannot contain {lpurl} related or {ignore} tags.
NULL_CUSTOM_PARAMETER_VALUE_DURING_ADD_OR_FULL_REPLACEMENT
For ADD operations and when the doReplace flag is set to true, custom parameter values cannot be null.
INVALID_CHARACTERS_IN_URL_CUSTOM_PARAMETER_KEY
An invalid character appears in the parameter key.
INVALID_CHARACTERS_IN_URL_CUSTOM_PARAMETER_VALUE
An invalid character appears in the parameter value.
INVALID_TAG_IN_URL_CUSTOM_PARAMETER_VALUE
The url custom parameter value fails url tag validation.
REDUNDANT_NESTED_URL_CUSTOM_PARAMETER_TAG
The custom parameter contains nested occurrences of the same conditional tag (i.e. {ifmobile:{ifmobile:x}}).
MISSING_PROTOCOL
The protocol (http:// or https://) is missing.
INVALID_URL
The url is invalid.
DESTINATION_URL_DEPRECATED
Destination Url is deprecated.
INVALID_TAG_IN_URL
The url contains invalid tag.
MISSING_URL_TAG
The url must contain at least one tag (e.g. {lpurl}), This applies only to urls associated with website ads or product ads.
DUPLICATE_URL_ID
INVALID_URL_ID
URL_ERROR

Send feedback about...

AdWords API
AdWords API
Need help? Visit our support page.