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

Interface AdGroupCriterionServiceInterface

public interface AdGroupCriterionServiceInterface

Use this service to manage criteria (such as keywords or placements). A criterion describes the conditions that determine if an ad should display. Two classes of criteria are available:

• A biddable criterion defines conditions that will cause the parent ad group's ads to display. A biddable criterion can also specify a bid amount that overrides the parent ad group's default bid.
• A negative criterion defines conditions that will prevent the parent ad group's ads from displaying.

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
AdGroupCriterionPage	get(Selector serviceSelector) Gets adgroup criteria.
AdGroupCriterionReturnValue	mutate(List<AdGroupCriterionOperation> operations) Adds, removes or updates adgroup criteria.
AdGroupCriterionLabelReturnValue	mutateLabel(List<AdGroupCriterionLabelOperation> operations) Adds labels to the AdGroupCriterion or removes labels from the AdGroupCriterion
AdGroupCriterionPage	query(String query) Returns the list of AdGroupCriterion 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.AdGroupCriterionServiceInterfaceget")
 @ResponseWrapper(localName="getResponse",
                 targetNamespace="https://adwords.google.com/api/adwords/cm/v201809",
                 className="com.google.api.ads.adwords.jaxws.v201809.cm.AdGroupCriterionServiceInterfacegetResponse")
AdGroupCriterionPage get(Selector serviceSelector)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            throws ApiException_Exception

Gets adgroup criteria.

Parameters:

serviceSelector - filters the adgroup criteria to be returned.

serviceSelector -

Returns:

a page (subset) view of the criteria selected

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.AdGroupCriterionServiceInterfacemutate")
 @ResponseWrapper(localName="mutateResponse",
                 targetNamespace="https://adwords.google.com/api/adwords/cm/v201809",
                 className="com.google.api.ads.adwords.jaxws.v201809.cm.AdGroupCriterionServiceInterfacemutateResponse")
AdGroupCriterionReturnValue mutate(List<AdGroupCriterionOperation> operations)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  throws ApiException_Exception

Adds, removes or updates adgroup criteria.

Parameters:

operations - operations to do during checks on keywords to be added.

operations -

Returns:

added and updated adgroup criteria (without optional parts)

Throws:

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

ApiException_Exception

mutateLabel

@RequestWrapper(localName="mutateLabel",
                targetNamespace="https://adwords.google.com/api/adwords/cm/v201809",
                className="com.google.api.ads.adwords.jaxws.v201809.cm.AdGroupCriterionServiceInterfacemutateLabel")
 @ResponseWrapper(localName="mutateLabelResponse",
                 targetNamespace="https://adwords.google.com/api/adwords/cm/v201809",
                 className="com.google.api.ads.adwords.jaxws.v201809.cm.AdGroupCriterionServiceInterfacemutateLabelResponse")
AdGroupCriterionLabelReturnValue mutateLabel(List<AdGroupCriterionLabelOperation> operations)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                throws ApiException_Exception

Adds labels to the AdGroupCriterion or removes labels from the AdGroupCriterion

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

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

Parameters:

operations - the operations to apply

operations -

Returns:

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

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

Returns the list of AdGroupCriterion that match the query.

Parameters:

query - The SQL-like AWQL query string

query -

Returns:

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

Throws:

ApiException - when the query is invalid or there are errors processing the request.

ApiException_Exception