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

Interface AdGroupServiceInterface

public interface AdGroupServiceInterface

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. 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
AdGroupPage	get(Selector serviceSelector) Returns a list of all the ad groups specified by the selector from the target customer's account.
AdGroupReturnValue	mutate(List<AdGroupOperation> operations) Adds, updates, or removes ad groups.
AdGroupLabelReturnValue	mutateLabel(List<AdGroupLabelOperation> operations) Adds labels to the ad group or removes labels from the ad group.
AdGroupPage	query(String query) Returns the list of ad groups that match 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.AdGroupServiceInterfaceget")
 @ResponseWrapper(localName="getResponse",
                 targetNamespace="https://adwords.google.com/api/adwords/cm/v201809",
                 className="com.google.api.ads.adwords.jaxws.v201809.cm.AdGroupServiceInterfacegetResponse")
AdGroupPage get(Selector serviceSelector)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 throws ApiException_Exception

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

Parameters:

serviceSelector - The selector specifying the AdGroups to return.

serviceSelector -

Returns:

List of adgroups identified 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.AdGroupServiceInterfacemutate")
 @ResponseWrapper(localName="mutateResponse",
                 targetNamespace="https://adwords.google.com/api/adwords/cm/v201809",
                 className="com.google.api.ads.adwords.jaxws.v201809.cm.AdGroupServiceInterfacemutateResponse")
AdGroupReturnValue mutate(List<AdGroupOperation> operations)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       throws ApiException_Exception

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:

operations - List of unique operations. The same ad group cannot be specified in more than one operation.

operations -

Returns:

The updated adgroups.

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.AdGroupServiceInterfacemutateLabel")
 @ResponseWrapper(localName="mutateLabelResponse",
                 targetNamespace="https://adwords.google.com/api/adwords/cm/v201809",
                 className="com.google.api.ads.adwords.jaxws.v201809.cm.AdGroupServiceInterfacemutateLabelResponse")
AdGroupLabelReturnValue mutateLabel(List<AdGroupLabelOperation> operations)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     throws ApiException_Exception

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:

operations - the operations to apply.

operations -

Returns:

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.

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.AdGroupServiceInterfacequery")
 @ResponseWrapper(localName="queryResponse",
                 targetNamespace="https://adwords.google.com/api/adwords/cm/v201809",
                 className="com.google.api.ads.adwords.jaxws.v201809.cm.AdGroupServiceInterfacequeryResponse")
AdGroupPage query(String query)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           throws ApiException_Exception

Returns the list of ad groups that match the query.

Parameters:

query - The SQL-like AWQL query string

query -

Returns:

A list of adgroups

Throws:

ApiException

ApiException_Exception