AdWords API

AdWords API
Feedback on this document

CampaignCriterionService (v201209)

Use this service to manage campaign-level criteria.

A campaign-level negative criterion prevents the campaign's ads from showing on specific placements, specific keywords, demographics, and so on.

Additionally, the service can be used to target criteria such as location, language, carrier, platform, and so on. The targeting criteria can be added using the Criterion Id listed in the documentation.

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

get

Gets campaign criteria.

Parameters

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

Response

Field Type Description
rval CampaignCriterionPage A list of campaign criteria.

mutate

Adds, removes or updates campaign criteria.

Parameters

Field Type Description
operations CampaignCriterionOperation[] The operations to apply.

Response

Field Type Description
rval CampaignCriterionReturnValue The added campaign criteria (without any optional parts).

query

Returns the list of campaign criteria that match the query.

Parameters

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

Response

Field Type Description
rval CampaignCriterionPage A list of campaign criteria.

Errors

Error Reasons
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.
CampaignCriterionError Base error class for Campaign Criterion Service.
Enumerations
CRITERIA_QUOTA_EXCEEDED
The operation would result in more campaign criteria than allowed.
CONCRETE_TYPE_REQUIRED
Concrete type of criterion (keyword v.s. placement) is required for ADD and SET operations.
ID_FILTERS_HAVE_DIFF_FIELDS_SET
Id filters have different combinations of field settings (they should all be the same).
INVALID_EXCLUDED_CATEGORY
The category requested for exclusion is invalid.
INVALID_KEYWORD_TEXT
Invalid keyword criteria text.
INVALID_PLACEMENT_URL
Invalid placement URL.
INVALID_VERTICAL_PATH
Invalid vertical path
LICENSED_USERLISTS_NOT_ALLOWED
Not allowed to exclude licensed user list.
CANNOT_EXCLUDE_ALL_PLATFORMS
Cannot exclude all platforms.
CANNOT_EXCLUDE_CRITERIA_TYPE
Criteria type can not be excluded for the campaign by the customer. like AOL account type cannot target site type criteria
CANNOT_EXCLUDE_PLATFORM_CRITERION
Cannot exclude platform criterion, i.e. this platform criterion has been already excluded.
CANNOT_TARGET_AND_EXCLUDE
Cannot target and exclude the same criterion.
TOO_MANY_OPERTAIONS
The #mutate operation contained too many operations.
OPERATOR_NOT_SUPPORTED_FOR_CRITERION_TYPE
This operator cannot be applied to a criterion of this 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
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.
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.
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.
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.
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.
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_NEGATIVE_CRITERION
Cannot set bid modifier for a negative criterion.
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 the campaign's bidding strategy.
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.
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).
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.
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.
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
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
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

Authentication required

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

Signing you in...

Google Developers needs your permission to do that.