AdWords API

AdWords API
Feedback on this document

AdGroupService (v201302)

Use this service to manage ad groups. An ad group organizes a set of ads and criteria together, and also provides the default bid for its criteria. One or more ad groups belong to a campaign.

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

get

Returns a list of all the ad groups specified by the selector from the target customer's account.

Parameters

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

Response

Field Type Description
rval AdGroupPage List of adgroups identified by the selector.

mutate

Adds, updates, or deletes ad groups.

Note: AdGroupOperation does not support the REMOVE operator. To delete an ad group, set its status to DELETED.

Parameters

Field Type Description
operations AdGroupOperation[] List of unique operations. The same ad group cannot be specified in more than one operation.

Response

Field Type Description
rval AdGroupReturnValue The updated adgroups.

query

Returns the list of ad groups that match the query.

Parameters

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

Response

Field Type Description
rval AdGroupPage A list of adgroups

Errors

Error Reasons
AdGroupServiceError Represents possible error codes in AdGroupService.
Enumerations
DUPLICATE_ADGROUP_NAME
AdGroup with the same name already exists for the campaign.
INVALID_ADGROUP_ID
AdGroup Id is not valid.
INVALID_ADGROUP_NAME
AdGroup name is not valid.
USE_SET_OPERATOR_AND_MARK_STATUS_TO_DELETED
Cannot delete an adgroup, adgroup status can be marked deleted using set operator.
ADVERTISER_NOT_ON_CONTENT_NETWORK
Advertiser is not allowed to target sites or set site bids that are not on the Google Search Network.
BID_TOO_BIG
Bid amount is too big.
BID_TOO_SMALL
Bid amount is too small.
BID_TYPE_AND_BIDDING_STRATEGY_MISMATCH
AdGroup bid does not match the campaign's bidding strategy.
INVALID_BID
Invalid bid amoumt.
MISSING_ADGROUP_NAME
AdGroup name is required for Add.
INVALID_CONTENT_BID_CRITERION_TYPE_GROUP
The CriterionTypeGroup is not supported for the content bid dimension.
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.
BiddingError Represents bidding errors.
Enumerations
BID_AMOUNT_REQUIRED
Bid amount can not be null.
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.
NON_POSITIVE_BID
Bids must have a positive amount.
BID_TOO_HIGH_FOR_DAILY_BUDGET
Bid is too high for the daily budget.
BID_TOO_HIGH_FOR_MONTHLY_BUDGET
Bid is too high for the monthly budget.
MUST_EXCLUDE_0_TO_17_WITH_OTHER_AGE_EXCLUSIONS
Demographic targeting: Age 0-17 needs to be excluded for any other age to get excluded
CAMPAIGN_MUST_HAVE_A_BUDGET_TO_ENABLE_BUDGET_OPTIMIZER
Not allowed to enable budget optimizer, for a campaign with no budget.
CANNOT_SET_CONTENT_BID_WITHOUT_SETTING_KEYWORD_MAX_CPC_AS_WELL
Not allowed to set content bid without setting the keyword bid.
CANNOT_CREATE_CAMPAIGN_WITH_CONVERSION_OPTIMIZER
Campaign can not be created with Conversion Optimizer bidding strategy. It can be transitioned to conversion optimizer, once eligible.
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
PAY_PER_CONVERSION_NOT_ALLOWED_WITH_MANY_PER_CLICK
Pay per conversion is not allowed with many per click
TARGET_CPA_NOT_AVAILABLE_FOR_CUSTOMER
Customer is not whitelisted to use target cpa
MANY_PER_CLICK_NOT_AVAILABLE_FOR_CUSTOMER
Customer is not whitelisted to use many per click
CANNOT_SET_SITE_MAX_CPC
Site cpc bid can not be set
BID_ERROR
Default bidding related error
BiddingErrors Represents error codes for bidding strategy entities.
Enumerations
BIDDING_STRATEGY_OVERRIDE_NOT_ALLOWED
Bidding strategy cannot override ad group or campaign bidding strategy.
BIDDING_STRATEGY_TRANSITION_NOT_ALLOWED
Cannot transition to new bidding strategy.
PERCENT_CPA_NOT_AVAILABLE_FOR_CUSTOMER
Percent Cpa not available for customer. Only whitelisted customers can use it.
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.
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.
NOT_ENOUGH_CONVERSION_DATA
Not enough right kind of data required for conversion or not enough data in last 3 days suggesting the campaign is not stable enough to enter into conversion optimizer.
CANNOT_CREATE_CAMPAIGN_WITH_CONVERSION_OPTIMIZER
Campaign can not be created with Conversion Optimizer bidding strategy. It can be transitioned to conversion optimizer, once eligible.
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.
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
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
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
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.
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.
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
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.
QuotaError Errors that are thrown if a quota limit is exceeded.
Enumerations
TOO_MANY_ADGROUPS_PER_CAMPAIGN
Too many ad groups per campaign.
TOO_MANY_CAMPAIGNS_PER_ACCOUNT
Too many campaigns per account.
TOO_MANY_CONVERSION_TYPES_PER_ACCOUNT
Too many conversion types per account.
TOO_MANY_KEYWORDS_PER_ADGROUP
Too many keywords per ad group.
TOO_MANY_KEYWORDS_PER_CAMPAIGN
Too many keywords per campaign.
TOO_MANY_KEYWORDS_PER_CUSTOMER
Too many keywords per customer.
TOO_MANY_SITES_PER_ADGROUP
Too many sites per ad group.
TOO_MANY_SITES_PER_CAMPAIGN
Too many sites per campaign.
TOO_MANY_CRITERIA_PER_ACCOUNT
Too many campaign level negative keywords + negative sites + geo targets for the account.
UNKNOWN
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.
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.
SettingError Indicates a problem with campaign settings.
Enumerations
DUPLICATE_SETTING_TYPE
The campaign already has a setting of the type that is being added.
SETTING_TYPE_IS_NOT_AVAILABLE
The campaign setting is not available for this AdWords account.
SETTING_TYPE_IS_NOT_COMPATIBLE_WITH_CAMPAIGN
The setting is not compatible with the campaign.
TARGETING_SETTING_REQUIRES_CAMPAIGN_TARGET_RESTRICT_SETTING
TargetingSetting for AdGroups requires a TargetRestrictSetting be added to the campaign with useAdGroup set to true.
TARGET_RESTRICT_SETTING_CANNOT_BE_REVERSED
TargetRestrictSetting useAdGroup cannot be reversed from true back to false.
TARGETING_SETTING_CONTAINS_INVALID_CRITERION_TYPE_GROUP
The supplied TargetingSetting contains an invalid CriterionTypeGroup. See CriterionTypeGroup documentation for CriterionTypeGroups allowed in Campaign or AdGroup TargetingSettings.
UNKNOWN
Unspecified campaign setting 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.
StatsQueryError Represents possible error codes when querying for stats.
Enumerations
DATE_NOT_IN_VALID_RANGE
Date is outside of allowed range.
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.