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

Interface CampaignServiceInterface

public interface CampaignServiceInterface

Use this service to manage campaigns. A campaign organizes one or more ad groups together and has its own budget, bidding strategy, serving date range, and targeting settings (managed using CampaignCriterionService). You can also set campaign-wide ad extensions using CampaignExtensionSettingService.

Note: CampaignService does not support video campaigns.

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
CampaignPage	get(Selector serviceSelector) Returns the list of campaigns that meet the selector criteria.
CampaignReturnValue	mutate(List<CampaignOperation> operations) Adds, updates, or removes campaigns.
CampaignLabelReturnValue	mutateLabel(List<CampaignLabelOperation> operations) Adds labels to the campaign or removes labels from the campaign.
CampaignPage	query(String query) Returns the list of campaigns 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.CampaignServiceInterfaceget")
 @ResponseWrapper(localName="getResponse",
                 targetNamespace="https://adwords.google.com/api/adwords/cm/v201809",
                 className="com.google.api.ads.adwords.jaxws.v201809.cm.CampaignServiceInterfacegetResponse")
CampaignPage get(Selector serviceSelector)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    throws ApiException_Exception

Returns the list of campaigns that meet the selector criteria.

Parameters:

serviceSelector - the selector specifying the Campaigns to return.

serviceSelector -

Returns:

A list of campaigns.

Throws:

ApiException - if problems occurred while fetching campaign information.

ApiException_Exception

mutate

@RequestWrapper(localName="mutate",
                targetNamespace="https://adwords.google.com/api/adwords/cm/v201809",
                className="com.google.api.ads.adwords.jaxws.v201809.cm.CampaignServiceInterfacemutate")
 @ResponseWrapper(localName="mutateResponse",
                 targetNamespace="https://adwords.google.com/api/adwords/cm/v201809",
                 className="com.google.api.ads.adwords.jaxws.v201809.cm.CampaignServiceInterfacemutateResponse")
CampaignReturnValue mutate(List<CampaignOperation> operations)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          throws ApiException_Exception

Adds, updates, or removes campaigns.

Note: CampaignOperation does not support the REMOVE operator. To remove a campaign, set its status to REMOVED.

Parameters:

operations - A list of unique operations. The same campaign cannot be specified in more than one operation.

operations -

Returns:

The list of updated campaigns, returned in the same order as the operations array.

Throws:

ApiException - if problems occurred while updating campaign information.

ApiException_Exception

mutateLabel

@RequestWrapper(localName="mutateLabel",
                targetNamespace="https://adwords.google.com/api/adwords/cm/v201809",
                className="com.google.api.ads.adwords.jaxws.v201809.cm.CampaignServiceInterfacemutateLabel")
 @ResponseWrapper(localName="mutateLabelResponse",
                 targetNamespace="https://adwords.google.com/api/adwords/cm/v201809",
                 className="com.google.api.ads.adwords.jaxws.v201809.cm.CampaignServiceInterfacemutateLabelResponse")
CampaignLabelReturnValue mutateLabel(List<CampaignLabelOperation> operations)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        throws ApiException_Exception

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

Add - Apply an existing label to an existing campaign. The campaignId must reference an existing Campaign. The labelId must reference an existing label.

Remove - Removes the link between the specified campaign and label.

Parameters:

operations - the operations to apply.

operations -

Returns:

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

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

Returns the list of campaigns that match the query.

Parameters:

query - The SQL-like AWQL query string.

query -

Returns:

A list of campaigns.

Throws:

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

ApiException_Exception