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

Interface ManagedCustomerServiceInterface

public interface ManagedCustomerServiceInterface

Customer Manager Service. 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
ManagedCustomerPage	get(Selector serviceSelector) Returns the list of customers that meet the selector criteria.
List<PendingInvitation>	getPendingInvitations(PendingInvitationSelector selector) Returns the pending invitations for the customer IDs in the selector.
ManagedCustomerReturnValue	mutate(List<ManagedCustomerOperation> operations) Modifies or creates new ManagedCustomers.
ManagedCustomerLabelReturnValue	mutateLabel(List<ManagedCustomerLabelOperation> operations) Adds AccountLabels to, and removes AccountLabels from, ManagedCustomers.
MutateLinkResults	mutateLink(List<LinkOperation> operations) Modifies the ManagedCustomer forest.
MutateManagerResults	mutateManager(List<MoveOperation> operations) Moves client customers to new managers (moving links).

Method Detail

get

@RequestWrapper(localName="get",
                targetNamespace="https://adwords.google.com/api/adwords/mcm/v201809",
                className="com.google.api.ads.adwords.jaxws.v201809.mcm.ManagedCustomerServiceInterfaceget")
 @ResponseWrapper(localName="getResponse",
                 targetNamespace="https://adwords.google.com/api/adwords/mcm/v201809",
                 className="com.google.api.ads.adwords.jaxws.v201809.mcm.ManagedCustomerServiceInterfacegetResponse")
ManagedCustomerPage get(Selector serviceSelector)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             throws ApiException

Returns the list of customers that meet the selector criteria.

Parameters:

selector - The selector specifying the ManagedCustomers to return.

serviceSelector -

Returns:

List of customers identified by the selector.

Throws:

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

ApiException

getPendingInvitations

@RequestWrapper(localName="getPendingInvitations",
                targetNamespace="https://adwords.google.com/api/adwords/mcm/v201809",
                className="com.google.api.ads.adwords.jaxws.v201809.mcm.ManagedCustomerServiceInterfacegetPendingInvitations")
 @ResponseWrapper(localName="getPendingInvitationsResponse",
                 targetNamespace="https://adwords.google.com/api/adwords/mcm/v201809",
                 className="com.google.api.ads.adwords.jaxws.v201809.mcm.ManagedCustomerServiceInterfacegetPendingInvitationsResponse")
List<PendingInvitation> getPendingInvitations(PendingInvitationSelector selector)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           throws ApiException

Returns the pending invitations for the customer IDs in the selector.

Parameters:

selector - the manager customer ids (inviters) or the client customer ids (invitees)

selector -

Returns:

returns java.util.List

Throws:

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

ApiException

mutate

@RequestWrapper(localName="mutate",
                targetNamespace="https://adwords.google.com/api/adwords/mcm/v201809",
                className="com.google.api.ads.adwords.jaxws.v201809.mcm.ManagedCustomerServiceInterfacemutate")
 @ResponseWrapper(localName="mutateResponse",
                 targetNamespace="https://adwords.google.com/api/adwords/mcm/v201809",
                 className="com.google.api.ads.adwords.jaxws.v201809.mcm.ManagedCustomerServiceInterfacemutateResponse")
ManagedCustomerReturnValue mutate(List<ManagedCustomerOperation> operations)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   throws ApiException

Modifies or creates new ManagedCustomers.

Note: See ManagedCustomerOperation for available operators.

Parameters:

operations - List of unique operations.

operations -

Returns:

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

Throws:

ApiException

mutateLabel

@RequestWrapper(localName="mutateLabel",
                targetNamespace="https://adwords.google.com/api/adwords/mcm/v201809",
                className="com.google.api.ads.adwords.jaxws.v201809.mcm.ManagedCustomerServiceInterfacemutateLabel")
 @ResponseWrapper(localName="mutateLabelResponse",
                 targetNamespace="https://adwords.google.com/api/adwords/mcm/v201809",
                 className="com.google.api.ads.adwords.jaxws.v201809.mcm.ManagedCustomerServiceInterfacemutateLabelResponse")
ManagedCustomerLabelReturnValue mutateLabel(List<ManagedCustomerLabelOperation> operations)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 throws ApiException

Adds AccountLabels to, and removes AccountLabels from, ManagedCustomers.

To add an AccountLabel to a ManagedCustomer, use Operator#ADD. To remove an AccountLabel from a ManagedCustomer, use Operator#REMOVE.

The label must already exist (see AccountLabelService#mutate for how to create them) and be owned by the authenticated user.

The ManagedCustomer must already exist and be managed by the customer making the request (either directly or indirectly).

An AccountLabel may be applied to at most 1000 customers.

This method does not support partial failures, and will fail if any operation is invalid.

Parameters:

operations -

Returns:

returns com.google.api.ads.adwords.jaxws.v201809.mcm.ManagedCustomerLabelReturnValue

Throws:

ApiException

mutateLink

@RequestWrapper(localName="mutateLink",
                targetNamespace="https://adwords.google.com/api/adwords/mcm/v201809",
                className="com.google.api.ads.adwords.jaxws.v201809.mcm.ManagedCustomerServiceInterfacemutateLink")
 @ResponseWrapper(localName="mutateLinkResponse",
                 targetNamespace="https://adwords.google.com/api/adwords/mcm/v201809",
                 className="com.google.api.ads.adwords.jaxws.v201809.mcm.ManagedCustomerServiceInterfacemutateLinkResponse")
MutateLinkResults mutateLink(List<LinkOperation> operations)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              throws ApiException

Modifies the ManagedCustomer forest. These actions are possible (categorized by Operator + Link Status):

• ADD + PENDING: manager extends invitations
• SET + CANCELLED: manager rescinds invitations
• SET + INACTIVE: manager/client terminates links
• SET + ACTIVE: client accepts invitations
• SET + REFUSED: client declines invitations

In addition to these, active links can also be marked hidden / unhidden.

• An ACTIVE link can be marked hidden with SET + ACTIVE along with setting the isHidden bit to true.
• An ACTIVE link can be marked unhidden with SET + ACTIVE along with setting the isHidden bit to false.

Parameters:

operations - the list of operations

operations -

Returns:

results for the given operations

Throws:

ApiException - with a ManagedCustomerServiceError

ApiException

mutateManager

@RequestWrapper(localName="mutateManager",
                targetNamespace="https://adwords.google.com/api/adwords/mcm/v201809",
                className="com.google.api.ads.adwords.jaxws.v201809.mcm.ManagedCustomerServiceInterfacemutateManager")
 @ResponseWrapper(localName="mutateManagerResponse",
                 targetNamespace="https://adwords.google.com/api/adwords/mcm/v201809",
                 className="com.google.api.ads.adwords.jaxws.v201809.mcm.ManagedCustomerServiceInterfacemutateManagerResponse")
MutateManagerResults mutateManager(List<MoveOperation> operations)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                throws ApiException

Moves client customers to new managers (moving links). Only the following action is possible:

• SET + ACTIVE: manager moves client customers to new managers within the same manager account hierarchy

Parameters:

operations - List of unique operations.

operations -

Returns:

results for the given operations

Throws:

ApiException - with a ManagedCustomerServiceError

ApiException