com.google.api.ads.adwords.axis.utility.extension.delegates

Class ManagedCustomerDelegate

java.lang.Object

com.google.api.ads.adwords.axis.utility.extension.delegates.AbstractBaseDelegate<S>

com.google.api.ads.adwords.axis.utility.extension.delegates.AbstractGetDelegate<T,S>

com.google.api.ads.adwords.axis.utility.extension.delegates.AbstractGetMutateDelegate<com.google.api.ads.adwords.axis.v201409.mcm.ManagedCustomer,com.google.api.ads.adwords.axis.v201409.mcm.ManagedCustomerOperation,com.google.api.ads.adwords.axis.v201409.mcm.ManagedCustomerServiceInterface>

com.google.api.ads.adwords.axis.utility.extension.delegates.ManagedCustomerDelegate

public final class ManagedCustomerDelegate
extends AbstractGetMutateDelegate<com.google.api.ads.adwords.axis.v201409.mcm.ManagedCustomer,com.google.api.ads.adwords.axis.v201409.mcm.ManagedCustomerOperation,com.google.api.ads.adwords.axis.v201409.mcm.ManagedCustomerServiceInterface>

Specific AbstractGetMutateDelegate for ManagedCustomer.

Implementation is not thread-safe, because AdWordsSession and Apache Axis service objects are not thread-safe.

Author:

Julian Toledo

Constructor Summary

Constructors

Constructor and Description
ManagedCustomerDelegate(AdWordsSession adWordsSession) Default Constructor.
ManagedCustomerDelegate(AdWordsSession adWordsSession, List<SelectorFields.ManagedCustomer> selectorFields) Constructor with custom fields.

Method Summary

Methods

Modifier and Type	Method and Description
List<com.google.api.ads.adwords.axis.v201409.mcm.ManagedCustomer>	getByCanManageClients(boolean canManageClients) Retrieves ManagedCustomers by canManageClients.
List<com.google.api.ads.adwords.axis.v201409.mcm.ManagedCustomer>	getByCustomerId(List<Long> customerIds) Retrieves ManagedCustomers by customerIds.
com.google.api.ads.adwords.axis.v201409.mcm.ManagedCustomer	getByCustomerId(Long customerId) Retrieves ManagedCustomers by customerId.
com.google.api.ads.adwords.axis.v201409.mcm.ManagedCustomer	getByCustomerId(String customerId) Retrieves ManagedCustomers by customerId.
List<com.google.api.ads.adwords.axis.v201409.mcm.ManagedCustomer>	getByCustomerIdCanManageClients(List<Long> customerIds, boolean canManageClients) Retrieves ManagedCustomers by customerIds and canManageClients.
List<com.google.api.ads.adwords.axis.v201409.mcm.PendingInvitation>	getPendingInvitations() Retrieves PendingInvitations for the account.
List<com.google.api.ads.adwords.axis.v201409.mcm.PendingInvitation>	getPendingInvitations(com.google.api.ads.adwords.axis.v201409.mcm.PendingInvitationSelector selector) Retrieves PendingInvitations for the account.
List<com.google.api.ads.adwords.axis.v201409.mcm.ManagedCustomerLink>	invitationAccept(List<com.google.api.ads.adwords.axis.v201409.mcm.ManagedCustomerLink> managedCustomerLinks) Accepts Invitations.
List<com.google.api.ads.adwords.axis.v201409.mcm.ManagedCustomerLink>	invitationDecline(List<com.google.api.ads.adwords.axis.v201409.mcm.ManagedCustomerLink> managedCustomerLinks) Declines Invitations.
List<com.google.api.ads.adwords.axis.v201409.mcm.ManagedCustomerLink>	invitationExtend(List<com.google.api.ads.adwords.axis.v201409.mcm.ManagedCustomerLink> managedCustomerLinks) Extends Invitations.
List<com.google.api.ads.adwords.axis.v201409.mcm.ManagedCustomerLink>	invitationRescind(List<com.google.api.ads.adwords.axis.v201409.mcm.ManagedCustomerLink> managedCustomerLinks) Rescinds Invitations.
List<com.google.api.ads.adwords.axis.v201409.mcm.ManagedCustomerLink>	moveManager(List<com.google.api.ads.adwords.axis.v201409.mcm.ManagedCustomerLink> managedCustomerLinks, Long oldManagerCustomerId) Moves client customers to new managers (moving links).
com.google.api.ads.adwords.axis.v201409.mcm.MutateLinkResults	mutateLink(com.google.api.ads.adwords.axis.v201409.mcm.LinkOperation[] operations) Modifies the ManagedCustomer forest.
com.google.api.ads.adwords.axis.v201409.mcm.MutateManagerResults	mutateManager(com.google.api.ads.adwords.axis.v201409.mcm.MoveOperation[] operations) Moves client customers to new managers (moving links).
List<com.google.api.ads.adwords.axis.v201409.mcm.ManagedCustomerLink>	terminateLink(List<com.google.api.ads.adwords.axis.v201409.mcm.ManagedCustomerLink> managedCustomerLinks) Terminates Links.

Methods inherited from class com.google.api.ads.adwords.axis.utility.extension.delegates.AbstractGetMutateDelegate

insert, insert, mutate, remove, remove, update, update

Methods inherited from class com.google.api.ads.adwords.axis.utility.extension.delegates.AbstractGetDelegate

createSelectorBuilder, get, get, get, getByField, getByField, getByField, getByField, getByFieldContainsAny, getClassT, getOneByField, getPage, setGetMethodName

Methods inherited from class com.google.api.ads.adwords.axis.utility.extension.delegates.AbstractBaseDelegate

getAdWordsSession, getService

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ManagedCustomerDelegate

public ManagedCustomerDelegate(AdWordsSession adWordsSession)

Default Constructor.

Parameters:

adWordsSession - the adWordsSession to use with the delegate/service

ManagedCustomerDelegate

public ManagedCustomerDelegate(AdWordsSession adWordsSession,
                       List<SelectorFields.ManagedCustomer> selectorFields)

Constructor with custom fields.

Parameters:

adWordsSession - the adWordsSession to use with the delegate/service

selectorFields - for the Generic Selectors using the SelectorField class

Method Detail

getByCustomerId

public List<com.google.api.ads.adwords.axis.v201409.mcm.ManagedCustomer> getByCustomerId(List<Long> customerIds)
                                                                                  throws RemoteException

Retrieves ManagedCustomers by customerIds.

Parameters:

customerIds -

Returns:

a list of ManagedCustomers matching the customerIds

Throws:

RemoteException - for communication-related exceptions

getByCustomerId

public com.google.api.ads.adwords.axis.v201409.mcm.ManagedCustomer getByCustomerId(Long customerId)
                                                                            throws RemoteException

Retrieves ManagedCustomers by customerId.

Parameters:

customerId -

Returns:

a list of ManagedCustomers matching the customerId

Throws:

RemoteException - for communication-related exceptions

getByCustomerId

public com.google.api.ads.adwords.axis.v201409.mcm.ManagedCustomer getByCustomerId(String customerId)
                                                                            throws RemoteException

Retrieves ManagedCustomers by customerId.

Parameters:

customerId - this String parameter is for support for the format 123-123-1234

Returns:

a list of ManagedCustomers matching the customerId

Throws:

RemoteException - for communication-related exceptions

NullPointerException - if customerId is null

getByCanManageClients

public List<com.google.api.ads.adwords.axis.v201409.mcm.ManagedCustomer> getByCanManageClients(boolean canManageClients)
                                                                                        throws RemoteException

Retrieves ManagedCustomers by canManageClients.

Parameters:

canManageClients -

Returns:

a list of ManagedCustomers matching the canManageClients

Throws:

RemoteException - for communication-related exceptions

getByCustomerIdCanManageClients

public List<com.google.api.ads.adwords.axis.v201409.mcm.ManagedCustomer> getByCustomerIdCanManageClients(List<Long> customerIds,
                                                                                                boolean canManageClients)
                                                                                                  throws RemoteException

Retrieves ManagedCustomers by customerIds and canManageClients.

Parameters:

customerIds -

canManageClients -

Returns:

a list of ManagedCustomers matching the customerIds and canManageClients

Throws:

RemoteException - for communication-related exceptions

getPendingInvitations

public List<com.google.api.ads.adwords.axis.v201409.mcm.PendingInvitation> getPendingInvitations(com.google.api.ads.adwords.axis.v201409.mcm.PendingInvitationSelector selector)
                                                                                          throws com.google.api.ads.adwords.axis.v201409.cm.ApiException,
                                                                                                 RemoteException

Retrieves PendingInvitations for the account.

Parameters:

selector - the manager customer id (inviter) or the client customer id (invitee)

Returns:

a list of PendingInvitations matching the customerIds

Throws:

RemoteException - for communication-related exceptions

com.google.api.ads.adwords.axis.v201409.cm.ApiException - holding a list of service errors

getPendingInvitations

public List<com.google.api.ads.adwords.axis.v201409.mcm.PendingInvitation> getPendingInvitations()
                                                                                          throws com.google.api.ads.adwords.axis.v201409.cm.ApiException,
                                                                                                 RemoteException

Retrieves PendingInvitations for the account.

Returns:

a list of PendingInvitations matching the customerIds

Throws:

RemoteException - for communication-related exceptions

com.google.api.ads.adwords.axis.v201409.cm.ApiException - holding a list of service errors

mutateLink

public com.google.api.ads.adwords.axis.v201409.mcm.MutateLinkResults mutateLink(com.google.api.ads.adwords.axis.v201409.mcm.LinkOperation[] operations)
                                                                         throws com.google.api.ads.adwords.axis.v201409.cm.ApiException,
                                                                                RemoteException

Modifies the ManagedCustomer forest.

Returns:

MutateLinkResults

Throws:

RemoteException - for communication-related exceptions

com.google.api.ads.adwords.axis.v201409.cm.ApiException - holding a list of service errors

invitationExtend

public List<com.google.api.ads.adwords.axis.v201409.mcm.ManagedCustomerLink> invitationExtend(List<com.google.api.ads.adwords.axis.v201409.mcm.ManagedCustomerLink> managedCustomerLinks)
                                                                                       throws com.google.api.ads.adwords.axis.v201409.cm.ApiException,
                                                                                              RemoteException

Extends Invitations. Sets operations to Operator.ADD and LinkStatus.PENDING as required.

Parameters:

managedCustomerLinks - a list of ManagedCustomerLink

Returns:

the resulting List from the operations

Throws:

RemoteException - for communication-related exceptions

com.google.api.ads.adwords.axis.v201409.cm.ApiException - holding a list of service errors

invitationRescind

public List<com.google.api.ads.adwords.axis.v201409.mcm.ManagedCustomerLink> invitationRescind(List<com.google.api.ads.adwords.axis.v201409.mcm.ManagedCustomerLink> managedCustomerLinks)
                                                                                        throws com.google.api.ads.adwords.axis.v201409.cm.ApiException,
                                                                                               RemoteException

Rescinds Invitations. Sets operations to Operator.SET and LinkStatus.CANCELLED as required.

Parameters:

managedCustomerLinks - a list of ManagedCustomerLink

Returns:

the resulting List from the operations

Throws:

RemoteException - for communication-related exceptions

com.google.api.ads.adwords.axis.v201409.cm.ApiException - holding a list of service errors

invitationAccept

public List<com.google.api.ads.adwords.axis.v201409.mcm.ManagedCustomerLink> invitationAccept(List<com.google.api.ads.adwords.axis.v201409.mcm.ManagedCustomerLink> managedCustomerLinks)
                                                                                       throws com.google.api.ads.adwords.axis.v201409.cm.ApiException,
                                                                                              RemoteException

Accepts Invitations. Sets operations to Operator.SET and LinkStatus.ACTIVE as required.

Parameters:

managedCustomerLinks - a list of ManagedCustomerLink

Returns:

the resulting List from the operations

Throws:

RemoteException - for communication-related exceptions

com.google.api.ads.adwords.axis.v201409.cm.ApiException - holding a list of service errors

invitationDecline

public List<com.google.api.ads.adwords.axis.v201409.mcm.ManagedCustomerLink> invitationDecline(List<com.google.api.ads.adwords.axis.v201409.mcm.ManagedCustomerLink> managedCustomerLinks)
                                                                                        throws com.google.api.ads.adwords.axis.v201409.cm.ApiException,
                                                                                               RemoteException

Declines Invitations. Sets operations to Operator.SET and LinkStatus.REFUSED as required.

Parameters:

managedCustomerLinks - a list of ManagedCustomerLink

Returns:

the resulting List from the operations

Throws:

RemoteException - for communication-related exceptions

com.google.api.ads.adwords.axis.v201409.cm.ApiException - holding a list of service errors

terminateLink

public List<com.google.api.ads.adwords.axis.v201409.mcm.ManagedCustomerLink> terminateLink(List<com.google.api.ads.adwords.axis.v201409.mcm.ManagedCustomerLink> managedCustomerLinks)
                                                                                    throws com.google.api.ads.adwords.axis.v201409.cm.ApiException,
                                                                                           RemoteException

Terminates Links. Sets operations to Operator.SET and LinkStatus.INACTIVE as required.

Parameters:

managedCustomerLinks - a list of ManagedCustomerLink

Returns:

the resulting List from the operations

Throws:

RemoteException - for communication-related exceptions

com.google.api.ads.adwords.axis.v201409.cm.ApiException - holding a list of service errors

mutateManager

public com.google.api.ads.adwords.axis.v201409.mcm.MutateManagerResults mutateManager(com.google.api.ads.adwords.axis.v201409.mcm.MoveOperation[] operations)
                                                                               throws com.google.api.ads.adwords.axis.v201409.cm.ApiException,
                                                                                      RemoteException

Moves client customers to new managers (moving links).

Returns:

MutateManagerResults

Throws:

RemoteException - for communication-related exceptions

com.google.api.ads.adwords.axis.v201409.cm.ApiException - holding a list of service errors

moveManager

public List<com.google.api.ads.adwords.axis.v201409.mcm.ManagedCustomerLink> moveManager(List<com.google.api.ads.adwords.axis.v201409.mcm.ManagedCustomerLink> managedCustomerLinks,
                                                                                Long oldManagerCustomerId)
                                                                                  throws com.google.api.ads.adwords.axis.v201409.cm.ApiException,
                                                                                         RemoteException

Moves client customers to new managers (moving links). oldManagerCustomerId restricts the moves from a single MCC.

Parameters:

oldManagerCustomerId - from where the accounts are being moved

Returns:

the resulting List from the operations

Throws:

RemoteException - for communication-related exceptions

com.google.api.ads.adwords.axis.v201409.cm.ApiException - holding a list of service errors