com.google.api.ads.adwords.jaxws.v201809.cm

Interface AdGroupAdServiceInterface

public interface AdGroupAdServiceInterface

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:

Expanded Text Ad

The primary ad type used on the search network. An expanded text ad contains two headlines, a single description line, a final url, and optional path fields.

Image Ad

A standard image ad.

Template Ad (AdWords Display Ad Builder)

A flexible ad type that supports various Template Ad formats.

This class was generated by the JAX-WS RI. JAX-WS RI 2.2.9-b130926.1035 Generated source version: 2.1

Method Summary

Modifier and Type	Method and Description
AdGroupAdPage	get(Selector serviceSelector) Returns a list of AdGroupAds.
AdGroupAdReturnValue	mutate(List<AdGroupAdOperation> operations) Applies the list of mutate operations (ie.
AdGroupAdLabelReturnValue	mutateLabel(List<AdGroupAdLabelOperation> operations) Adds labels to the AdGroupAd or removes labels from the AdGroupAd.
AdGroupAdPage	query(String query) Returns a list of AdGroupAds based on the query.

Method Detail

get

@RequestWrapper(localName="get",
                targetNamespace="https://adwords.google.com/api/adwords/cm/v201809",
                className="com.google.api.ads.adwords.jaxws.v201809.cm.AdGroupAdServiceInterfaceget")
 @ResponseWrapper(localName="getResponse",
                 targetNamespace="https://adwords.google.com/api/adwords/cm/v201809",
                 className="com.google.api.ads.adwords.jaxws.v201809.cm.AdGroupAdServiceInterfacegetResponse")
AdGroupAdPage get(Selector serviceSelector)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       throws ApiException_Exception

Returns a list of AdGroupAds. AdGroupAds that had been removed are not returned by default.

Parameters:

serviceSelector - The selector specifying the AdGroupAds to return.

serviceSelector -

Returns:

The page containing the AdGroupAds that meet the criteria specified by the selector.

Throws:

ApiException - when there is at least one error with the request.

ApiException_Exception

mutate

@RequestWrapper(localName="mutate",
                targetNamespace="https://adwords.google.com/api/adwords/cm/v201809",
                className="com.google.api.ads.adwords.jaxws.v201809.cm.AdGroupAdServiceInterfacemutate")
 @ResponseWrapper(localName="mutateResponse",
                 targetNamespace="https://adwords.google.com/api/adwords/cm/v201809",
                 className="com.google.api.ads.adwords.jaxws.v201809.cm.AdGroupAdServiceInterfacemutateResponse")
AdGroupAdReturnValue mutate(List<AdGroupAdOperation> operations)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             throws ApiException_Exception

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 remove the old one.

Remove - Removes the link between the specified AdGroup and Ad.

Parameters:

operations - The operations to apply.

operations -

Returns:

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 removed from the AdGroup.

Throws:

ApiException_Exception

mutateLabel

@RequestWrapper(localName="mutateLabel",
                targetNamespace="https://adwords.google.com/api/adwords/cm/v201809",
                className="com.google.api.ads.adwords.jaxws.v201809.cm.AdGroupAdServiceInterfacemutateLabel")
 @ResponseWrapper(localName="mutateLabelResponse",
                 targetNamespace="https://adwords.google.com/api/adwords/cm/v201809",
                 className="com.google.api.ads.adwords.jaxws.v201809.cm.AdGroupAdServiceInterfacemutateLabelResponse")
AdGroupAdLabelReturnValue mutateLabel(List<AdGroupAdLabelOperation> operations)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           throws ApiException_Exception

Adds labels to the AdGroupAd or removes labels from the AdGroupAd.

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

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

Parameters:

operations - The operations to apply.

operations -

Returns:

A list of AdGroupAdLabel 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 AdGroupAdLabel contains the AdGroupId, AdId and the LabelId. In the case of a remove operation, the returned AdGroupAdLabel will only have AdGroupId and AdId.

Throws:

ApiException - when there are one or more errors with the request.

ApiException_Exception

query

@RequestWrapper(localName="query",
                targetNamespace="https://adwords.google.com/api/adwords/cm/v201809",
                className="com.google.api.ads.adwords.jaxws.v201809.cm.AdGroupAdServiceInterfacequery")
 @ResponseWrapper(localName="queryResponse",
                 targetNamespace="https://adwords.google.com/api/adwords/cm/v201809",
                 className="com.google.api.ads.adwords.jaxws.v201809.cm.AdGroupAdServiceInterfacequeryResponse")
AdGroupAdPage query(String query)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 throws ApiException_Exception

Returns a list of AdGroupAds based on the query.

Parameters:

query - The SQL-like AWQL query string.

query -

Returns:

A list of AdGroupAds.

Throws:

ApiException - if problems occur while parsing the query or fetching AdGroupAds.

ApiException_Exception