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/v201509/AdGroupService?wsdl
- Namespace
-
https://adwords.google.com/api/adwords/cm/v201509
- Operations
- Errors
-
- AdGroupServiceError
- AdxError
- AuthenticationError
- AuthorizationError
- BiddingErrors
- ClientTermsError
- DatabaseError
- DateError
- DistinctError
- EntityAccessDenied
- EntityCountLimitExceeded
- EntityNotFound
- ExperimentError
- ForwardCompatibilityError
- IdError
- InternalApiError
- MultiplierError
- NewEntityCreationError
- NotEmptyError
- NullError
- OperationAccessDenied
- OperatorError
- QueryError
- QuotaCheckError
- RangeError
- RateExceededError
- ReadOnlyError
- RejectedError
- RequestError
- RequiredError
- SelectorError
- SettingError
- SizeLimitError
- StatsQueryError
- StringFormatError
- StringLengthError
- UrlError
get
Returns a list of all the ad groups specified by the selector from the target customer's account.
Parameters
Field | Type | Description |
---|---|---|
serviceSelector
|
|
The selector specifying the AdGroups to return. |
Response
Field | Type | Description |
---|---|---|
rval
|
|
List of adgroups identified by the selector. |
mutate
Adds, updates, or removes ad groups.
Note:
AdGroupOperation does not support the
REMOVE
operator. To remove an ad group, set its
status to REMOVED
.
Parameters
Field | Type | Description |
---|---|---|
operations
|
|
List of unique operations. The same ad group cannot be specified in more than one operation. |
Response
Field | Type | Description |
---|---|---|
rval
|
|
The updated adgroups. |
mutateLabel
Adds labels to the ad group or removes labels from the ad group.
ADD
-- Apply an existing
label to an existing ad group. The adGroupId
must reference an existing
ad
group. The labelId
must reference an existing label.
REMOVE
-- Removes the link
between the specified ad group and a label.
Parameters
Field | Type | Description |
---|---|---|
operations
|
|
the operations to apply. |
Response
Field | Type | Description |
---|---|---|
rval
|
|
a list of AdGroupLabels 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 AdGroupLabel contains the AdGroupId and the LabelId. In the case of a remove operation, the returned AdGroupLabel will only have AdGroupId. |
query
Returns the list of ad groups that match the query.
Parameters
Field | Type | Description |
---|---|---|
query
|
|
The SQL-like AWQL query string |
Response
Field | Type | Description |
---|---|---|
rval
|
|
A list of adgroups |
Errors
Error | Reasons |
---|---|
AdGroupServiceError
|
Represents possible error codes in AdGroupService.
Enumerations
|
AdxError
|
Errors that are thrown when a non-AdX feature is accessed by an AdX customer.
Enumerations
|
AuthenticationError
|
Errors returned when Authentication failed.
Enumerations
|
AuthorizationError
|
Errors encountered when trying to authorize a user.
Enumerations
|
BiddingErrors
|
Represents error codes for bidding strategy entities.
Enumerations
|
ClientTermsError
|
Error due to user not accepting the AdWords terms of service.
Enumerations
|
DatabaseError
|
Errors that are thrown due to a database access problem.
Enumerations
|
DateError
|
Errors associated with invalid dates and date ranges.
Enumerations
|
DistinctError
|
Errors related to distinct ids or content.
Enumerations
|
EntityAccessDenied
|
Reports permission problems trying to access an entity.
Enumerations
|
EntityCountLimitExceeded
|
Signals that an entity count limit was exceeded for some level.
For example, too many criteria for a campaign.
Enumerations
|
EntityNotFound
|
An id did not correspond to an entity, or it referred to an entity which does not belong to the
customer.
Enumerations
|
ExperimentError
|
Enumerations
|
ForwardCompatibilityError
|
A ForwardComptibilityError represents possible errors when using the forwardCompatibilityMap
in some of the common services.
Enumerations
|
IdError
|
Errors associated with the ids.
Enumerations
|
InternalApiError
|
Indicates that a server-side error has occured. InternalApiError s
are generally not the result of an invalid request or message sent by the
client.
Enumerations
|
MultiplierError
|
Represents errors in bid multipliers.
Enumerations
|
NewEntityCreationError
|
Error associated with creation of new entities.
Enumerations
|
NotEmptyError
|
Errors corresponding with violation of a NOT EMPTY check.
Enumerations
|
NullError
|
Errors associated with violation of a NOT NULL check.
Enumerations
|
OperationAccessDenied
|
Operation not permitted due to the invoked service's access policy.
Enumerations
|
OperatorError
|
Errors due to the use of unsupported operations.
Enumerations
|
QueryError
|
A QueryError represents possible errors for query parsing and execution.
Enumerations
|
QuotaCheckError
|
Encapsulates the errors thrown during developer quota checks.
Enumerations
|
RangeError
|
A list of all errors associated with the Range constraint.
Enumerations
|
RateExceededError
|
Signals that a call failed because a measured rate exceeded.
Enumerations
|
ReadOnlyError
|
Errors from attempting to write to read-only fields.
Enumerations
|
RejectedError
|
Indicates that a field was rejected due to compatibility issues.
Enumerations
|
RequestError
|
Encapsulates the generic errors thrown when there's an error with user
request.
Enumerations
|
RequiredError
|
Errors due to missing required field.
Enumerations
|
SelectorError
|
Represents possible error codes for Selector.
Enumerations
|
SettingError
|
Indicates a problem with campaign settings.
Enumerations
|
SizeLimitError
|
Indicates that the number of entries in the request or response exceeds the system limit.
Enumerations
|
StatsQueryError
|
Represents possible error codes when querying for stats.
Enumerations
|
StringFormatError
|
A list of error code for reporting invalid content of input strings.
Enumerations
|
StringLengthError
|
Errors associated with the length of the given string being
out of bounds.
Enumerations
|
UrlError
|
Url Validation errors.
Enumerations
|