Use this service to manage ads. Available ad types are subclasses of the base Ad type and are shown in the AdGroupAd.ad documentation. Here are some of the commonly used ad types:
- Text Ad
- The primary ad type used on both the search and display networks. A text ad contains a headline, two lines of text, and a destination URL.
- Image Ad
- A standard image ad.
- Mobile Ad
- A text ad specific to mobile devices. In addition, a mobile ad can contain a click-to-call phone number.
- Template Ad (AdWords Display Ad Builder)
- A flexible ad type that supports video ads, image search ads, and more. For a list of available templates, see the Template Ad Formats appendix.
- Production WSDL
-
https://adwords.google.com/api/adwords/cm/v201306/AdGroupAdService?wsdl
- Namespace
-
https://adwords.google.com/api/adwords/cm/v201306
- Operations
- Errors
-
- AdError
- AdGroupAdError
- AdxError
- AuthenticationError
- AuthorizationError
- BetaError
- ClientTermsError
- DatabaseError
- DateError
- DistinctError
- EntityCountLimitExceeded
- EntityNotFound
- ForwardCompatibilityError
- IdError
- ImageError
- InternalApiError
- MediaError
- NewEntityCreationError
- NotEmptyError
- NotWhitelistedError
- NullError
- OperationAccessDenied
- PagingError
- PolicyViolationError
- QueryError
- QuotaCheckError
- RangeError
- RateExceededError
- ReadOnlyError
- RequestError
- RequiredError
- SelectorError
- SizeLimitError
- StatsQueryError
- StringLengthError
get
Returns a list of AdGroupAds. Deleted AdGroupAds are not returned by default.
Parameters
Field | Type | Description |
---|---|---|
serviceSelector |
Selector
|
The selector specifying the AdGroupAds to return. |
Response
Field | Type | Description |
---|---|---|
rval |
AdGroupAdPage
|
The page containing the AdGroupAds that meet the criteria specified by the selector. |
mutate
Applies the list of mutate operations (ie. add, set, remove):
Add - Creates a new ad group ad. The
adGroupId
must
reference an existing ad group. The child Ad
must be sufficiently
specified by constructing a concrete ad type (such as TextAd
)
and setting its fields accordingly.
Set - Updates an ad group ad. Except for status
,
ad group ad fields are not mutable. Status updates are
straightforward - the status of the ad group ad is updated as
specified. If any other field has changed, it will be ignored. If
you want to change any of the fields other than status, you must
make a new ad and then delete the old one.
Remove - Removes the link between the specified AdGroup and Ad.
Parameters
Field | Type | Description |
---|---|---|
operations |
AdGroupAdOperation[]
|
The operations to apply. |
Response
Field | Type | Description |
---|---|---|
rval |
AdGroupAdReturnValue
|
A list of AdGroupAds where each entry in the list is the result of applying the operation in the input list with the same index. For an add/set operation, the return AdGroupAd will be what is saved to the db. In the case of the remove operation, the return AdGroupAd will simply be an AdGroupAd containing an Ad with the id set to the Ad being deleted from the AdGroup. |
query
Returns a list of AdGroupAds based on the query.
Parameters
Field | Type | Description |
---|---|---|
query |
xsd:string
|
The SQL-like AWQL query string. |
Response
Field | Type | Description |
---|---|---|
rval |
AdGroupAdPage
|
A list of AdGroupAds. |
Errors
Error | Reasons |
---|---|
AdError | Base error class for Ad Service. Enumerations
|
AdGroupAdError | Error information for AdGroupAdService. 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
|
BetaError | Errors that are thrown when a Beta feature is accessed incorrectly. 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
|
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
|
ForwardCompatibilityError | A ForwardComptibilityError represents possible errors when using the forwardCompatibilityMap
in some of the common services. Enumerations
|
IdError | Errors associated with the ids. Enumerations
|
ImageError | Error class for errors associated with parsing image data. 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
|
MediaError | Error class for media related errors. Enumerations
|
NewEntityCreationError | Error associated with creation of new entities using
TempId s.Enumerations
|
NotEmptyError | Errors corresponding with violation of a NOT EMPTY check. Enumerations
|
NotWhitelistedError | Indicates that the customer is not whitelisted for accessing the API. 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
|
PagingError | Error codes for pagination.
See Paging. Enumerations
|
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
|
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
|
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
|
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
|
StringLengthError | Errors associated with the length of the given string being
out of bounds. Enumerations
|