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

Class ExtendedMcc

java.lang.Object

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

public final class ExtendedMcc
extends Object

ExtendedMcc encapsulates the MCC Level operations. This class does not guard its mutable reference for AdWordsSession

Author:

Julian Toledo

Constructor Summary

Constructors

Constructor and Description
ExtendedMcc(AdWordsSession adWordsSession) Constructs an ExtendedMcc from a AdWordsSession.
ExtendedMcc(AdWordsSession adWordsSession, com.google.api.ads.adwords.axis.v201409.mcm.ManagedCustomer managedCustomer) Constructs an ExtendedMcc from a AdWordsSession and a ManagedCustomer.
ExtendedMcc(AdWordsSession adWordsSession, String clientCustomerId) Constructs an ExtendedMcc from a AdWordsSession and a clientCustomerId.
ExtendedMcc(DelegateLocator delegateLocator) Constructs an ExtendedMcc from a AdWordsSession.

Method Summary

Methods

Modifier and Type	Method and Description
static List<ExtendedMcc>	as(List<com.google.api.ads.adwords.axis.v201409.mcm.ManagedCustomer> managedCustomers, AdWordsSession adWordsSession) Transforms a regular list of (MCC) ManagedCustomer into a list of ExtendedManagedCustomers.
AdWordsSession	getAdWordsSession() Retrieves the AdWordsSession for MCC.
List<com.google.api.ads.adwords.axis.v201409.billing.BillingAccount>	getBillingAccounts() Gets all the BillingAccounts for the ExtendedMcc.
String	getClientCustomerId() Retrieves the clientCustomerId for the MCC.
DelegateLocator	getDelegateLocator() Retrieves the DelegateLocator for the MCC.
ExtendedManagedCustomer	getExtendedManagedCustomer(Long customerId) Gets the ManagedCustomers for the ExtendedMcc in the customerIds list.
List<ExtendedManagedCustomer>	getExtendedManagedCustomers() Gets the ManagedCustomers for the ExtendedMcc in the customerIds list.
List<ExtendedManagedCustomer>	getExtendedManagedCustomers(int startIndex, int numberResults) Gets the ManagedCustomers for the ExtendedMcc between startIndex and numberResults.
List<ExtendedManagedCustomer>	getExtendedManagedCustomers(List<Long> customerIds) Gets the ManagedCustomers for the ExtendedMcc in the customerIds list.
ExtendedMcc	getExtendedMcc(Long customerId) Gets the (sub)MCCs for the ExtendedMcc for a list of customerIds.
List<ExtendedMcc>	getExtendedMccs() Gets the (sub)MCCs for the ExtendedMcc.
List<ExtendedMcc>	getExtendedMccs(List<Long> customerIds) Gets the (sub)MCCs for the ExtendedMcc for a list of customerIds.
com.google.api.ads.adwords.axis.v201409.mcm.ManagedCustomer	getManagedCustomer(Long customerId) Gets the ManagedCustomers for the ExtendedMcc in the customerIds list.
com.google.api.ads.adwords.axis.v201409.mcm.ManagedCustomer	getManagedCustomer(String customerId) Gets the ManagedCustomers for the ExtendedMcc in the customerIds list.
List<com.google.api.ads.adwords.axis.v201409.mcm.ManagedCustomer>	getManagedCustomers() Gets the ManagedCustomers for the ExtendedMcc in the customerIds list.
List<com.google.api.ads.adwords.axis.v201409.mcm.ManagedCustomer>	getManagedCustomers(int startIndex, int numberResults) Gets the ManagedCustomers for the ExtendedMcc between startIndex and numberResults.
List<com.google.api.ads.adwords.axis.v201409.mcm.ManagedCustomer>	getManagedCustomers(List<Long> customerIds) Gets the ManagedCustomers for the ExtendedMcc in the customerIds list.
com.google.api.ads.adwords.axis.v201409.mcm.ManagedCustomer	getMcc(Long customerId) Gets the (sub)MCCs for the ExtendedMcc for a list of customerIds.
List<com.google.api.ads.adwords.axis.v201409.mcm.ManagedCustomer>	getMccs() Gets the (sub)MCCs for the ExtendedMcc.
List<com.google.api.ads.adwords.axis.v201409.mcm.ManagedCustomer>	getMccs(List<Long> customerIds) Gets the (sub)MCCs for the ExtendedMcc for a list of customerIds.
ExtendedManagedCustomer	insertManagedCustomer(com.google.api.ads.adwords.axis.v201409.mcm.ManagedCustomer apiManagedCustomer) Inserts a ManagedCustomer into the ExtendedMcc.
ExtendedManagedCustomer	insertManagedCustomer(String name, String companyName, String dateTimeZone, String currencyCode) Inserts a ManagedCustomer into the ExtendedMcc.
List<ExtendedManagedCustomer>	insertManagedCustomers(List<com.google.api.ads.adwords.axis.v201409.mcm.ManagedCustomer> apiManagedCustomers) Inserts ManagedCustomers into the ExtendedMcc.
static ExtendedMcc	withOAuth2FromFile() Creates a new ExtendedMcc using the ads.properties file and using OAuth2.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExtendedMcc

public ExtendedMcc(AdWordsSession adWordsSession)

Constructs an ExtendedMcc from a AdWordsSession.

Parameters:

adWordsSession - the AdWordsSession for the MCC

ExtendedMcc

public ExtendedMcc(DelegateLocator delegateLocator)

Constructs an ExtendedMcc from a AdWordsSession.

Parameters:

delegateLocator - the DelegateLocator for the MCC

ExtendedMcc

public ExtendedMcc(AdWordsSession adWordsSession,
           String clientCustomerId)

Constructs an ExtendedMcc from a AdWordsSession and a clientCustomerId.

Parameters:

adWordsSession - the AdWordsSession for the MCC

clientCustomerId - the clientCustomerId as String

ExtendedMcc

public ExtendedMcc(AdWordsSession adWordsSession,
           com.google.api.ads.adwords.axis.v201409.mcm.ManagedCustomer managedCustomer)

Constructs an ExtendedMcc from a AdWordsSession and a ManagedCustomer.

Parameters:

adWordsSession - the AdWordsSession for the MCC

managedCustomer - the ManagedCustomer to use in the session

Method Detail

withOAuth2FromFile

public static ExtendedMcc withOAuth2FromFile()
                                      throws OAuthException,
                                             ValidationException,
                                             com.google.api.ads.common.lib.conf.ConfigurationLoadException

Creates a new ExtendedMcc using the ads.properties file and using OAuth2.

Returns:

the ExtendedMcc associated with the file

Throws:

OAuthException - if problem with OAuth2

com.google.api.ads.common.lib.conf.ConfigurationLoadException - if problems loading the ad.properties file

ValidationException - if the AdWordsSession did not validate

as

public static List<ExtendedMcc> as(List<com.google.api.ads.adwords.axis.v201409.mcm.ManagedCustomer> managedCustomers,
                   AdWordsSession adWordsSession)

Transforms a regular list of (MCC) ManagedCustomer into a list of ExtendedManagedCustomers.

Note: managedCustomer needs to be a MCC.

Parameters:

managedCustomers - a list of (MCC) ManagedCustomers to convert

Returns:

the converted list of ExtendedManagedCustomers

getAdWordsSession

public AdWordsSession getAdWordsSession()

Retrieves the AdWordsSession for MCC.

Returns:

the AdWordsSession for the MCC

getDelegateLocator

public DelegateLocator getDelegateLocator()

Retrieves the DelegateLocator for the MCC.

Returns:

the DelegateLocator for the MCC

getClientCustomerId

public String getClientCustomerId()

Retrieves the clientCustomerId for the MCC.

Returns:

the clientCustomerId for the MCC

getMccs

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

Gets the (sub)MCCs for the ExtendedMcc for a list of customerIds.

Parameters:

customerIds - the list of MCCs to retrieve

Returns:

a list of (sub) MCCs for the ExtendedMcc from the customerIds list

Throws:

UtilityLibraryException - if there is an error in the reflection call

RemoteException - for communication-related exceptions

getExtendedMccs

public List<ExtendedMcc> getExtendedMccs(List<Long> customerIds)
                                  throws RemoteException

Gets the (sub)MCCs for the ExtendedMcc for a list of customerIds.

Parameters:

customerIds - the list of MCCs to retrieve

Returns:

a list of (sub) MCCs for the ExtendedMcc from the customerIds list

Throws:

UtilityLibraryException - if there is an error in the reflection call

RemoteException - for communication-related exceptions

getMccs

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

Gets the (sub)MCCs for the ExtendedMcc.

Returns:

all the (sub) MCCs for the ExtendedMcc

Throws:

UtilityLibraryException - if there is an error in the reflection call

RemoteException - for communication-related exceptions

getExtendedMccs

public List<ExtendedMcc> getExtendedMccs()
                                  throws RemoteException

Gets the (sub)MCCs for the ExtendedMcc.

Returns:

all the (sub) MCCs for the ExtendedMcc

Throws:

UtilityLibraryException - if there is an error in the reflection call

RemoteException - for communication-related exceptions

getMcc

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

Gets the (sub)MCCs for the ExtendedMcc for a list of customerIds.

Parameters:

customerId - the id of the MCC to retrieve

Returns:

a (sub) MCCs for the ExtendedMcc for the customerId

Throws:

UtilityLibraryException - if there is an error in the reflection call

RemoteException - for communication-related exceptions

getExtendedMcc

public ExtendedMcc getExtendedMcc(Long customerId)
                           throws RemoteException

Gets the (sub)MCCs for the ExtendedMcc for a list of customerIds.

Parameters:

customerId - the id of the MCC to retrieve

Returns:

a (sub) MCCs for the ExtendedMcc for the customerId

Throws:

UtilityLibraryException - if there is an error in the reflection call

RemoteException - for communication-related exceptions

getManagedCustomers

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

Gets the ManagedCustomers for the ExtendedMcc in the customerIds list.

Parameters:

customerIds - the list of ids of the ManagedCustomers to retrieve

Returns:

a list of ManagedCustomer for the ExtendedMcc from the customerIds list

Throws:

UtilityLibraryException - if there is an error in the reflection call

RemoteException - for communication-related exceptions

getExtendedManagedCustomers

public List<ExtendedManagedCustomer> getExtendedManagedCustomers(List<Long> customerIds)
                                                          throws RemoteException

Gets the ManagedCustomers for the ExtendedMcc in the customerIds list.

Parameters:

customerIds - the list of ids of the ManagedCustomers to retrieve

Returns:

a list of ExtendedManagedCustomer for the ExtendedMcc from the customerIds list

Throws:

UtilityLibraryException - if there is an error in the reflection call

RemoteException - for communication-related exceptions

getManagedCustomers

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

Gets the ManagedCustomers for the ExtendedMcc in the customerIds list.

Note: returns subMccs' ManagedCustomers as well.

Returns:

all the ManagedCustomer for the ExtendedMcc

Throws:

UtilityLibraryException - if there is an error in the reflection call

RemoteException - for communication-related exceptions

getManagedCustomers

public List<com.google.api.ads.adwords.axis.v201409.mcm.ManagedCustomer> getManagedCustomers(int startIndex,
                                                                                    int numberResults)
                                                                                      throws RemoteException

Gets the ManagedCustomers for the ExtendedMcc between startIndex and numberResults.

Note: returns subMccs' ManagedCustomers as well.

Parameters:

startIndex - index of the first result to retrieve

numberResults - total number of result to retrieve

Returns:

all the ManagedCustomer for the ExtendedMcc

Throws:

UtilityLibraryException - if there is an error in the reflection call

RemoteException - for communication-related exceptions

getExtendedManagedCustomers

public List<ExtendedManagedCustomer> getExtendedManagedCustomers()
                                                          throws RemoteException

Gets the ManagedCustomers for the ExtendedMcc in the customerIds list.

Note: returns subMccs' ManagedCustomers as well.

Returns:

all the ExtendedManagedCustomer for the ExtendedMcc

Throws:

UtilityLibraryException - if there is an error in the reflection call

RemoteException - for communication-related exceptions

getExtendedManagedCustomers

public List<ExtendedManagedCustomer> getExtendedManagedCustomers(int startIndex,
                                                        int numberResults)
                                                          throws RemoteException

Gets the ManagedCustomers for the ExtendedMcc between startIndex and numberResults.

Note: returns subMccs' ManagedCustomers as well.

Parameters:

startIndex - index of the first result to retrieve

numberResults - total number of result to retrieve

Returns:

all the ExtendedManagedCustomer for the ExtendedMcc

Throws:

UtilityLibraryException - if there is an error in the reflection call

RemoteException - for communication-related exceptions

getManagedCustomer

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

Gets the ManagedCustomers for the ExtendedMcc in the customerIds list.

Parameters:

customerId - the customerId of the ManagedCustomer to retrieve

Returns:

the ManagedCustomer for the customerId

Throws:

UtilityLibraryException - if there is an error in the reflection call

RemoteException - for communication-related exceptions

getManagedCustomer

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

Gets the ManagedCustomers for the ExtendedMcc in the customerIds list.

Parameters:

customerId - the customerId of the ManagedCustomer to retrieve

Returns:

the ManagedCustomer for the customerId

Throws:

UtilityLibraryException - if there is an error in the reflection call

RemoteException - for communication-related exceptions

getExtendedManagedCustomer

public ExtendedManagedCustomer getExtendedManagedCustomer(Long customerId)
                                                   throws RemoteException

Gets the ManagedCustomers for the ExtendedMcc in the customerIds list.

Parameters:

customerId - the customerId of the ManagedCustomer to retrieve

Returns:

the ExtendedManagedCustomer for the customerId

Throws:

UtilityLibraryException - if there is an error in the reflection call

RemoteException - for communication-related exceptions

insertManagedCustomers

public List<ExtendedManagedCustomer> insertManagedCustomers(List<com.google.api.ads.adwords.axis.v201409.mcm.ManagedCustomer> apiManagedCustomers)
                                                     throws RemoteException

Inserts ManagedCustomers into the ExtendedMcc.

Note: ManagedCustomers cannot be updated/removed.

Parameters:

apiManagedCustomers - the list of ManagedCustomers to be inserted

Returns:

the updated list of ExtendedManagedCustomers

Throws:

UtilityLibraryException - if there is an error in the reflection call

RemoteException - for communication-related exceptions

insertManagedCustomer

public ExtendedManagedCustomer insertManagedCustomer(com.google.api.ads.adwords.axis.v201409.mcm.ManagedCustomer apiManagedCustomer)
                                              throws RemoteException

Inserts a ManagedCustomer into the ExtendedMcc.

Note: ManagedCustomers cannot be updated/removed.

Parameters:

apiManagedCustomer - the ManagedCustomer to be inserted

Returns:

the updated ExtendedManagedCustomer

Throws:

UtilityLibraryException - if there is an error in the reflection call

RemoteException - for communication-related exceptions

insertManagedCustomer

public ExtendedManagedCustomer insertManagedCustomer(String name,
                                            String companyName,
                                            String dateTimeZone,
                                            String currencyCode)
                                              throws RemoteException

Inserts a ManagedCustomer into the ExtendedMcc.

Note: ManagedCustomers cannot be updated/removed.

Parameters:

name - the ManagedCustomer's name

companyName - the ManagedCustomer's company name

dateTimeZone - the ManagedCustomer's time zone in POSIX: https://developers.google.com/adwords/api/docs/appendix/timezones

currencyCode - the ManagedCustomer's currency in ISO 4217 format: https://developers.google.com/adwords/api/docs/appendix/currencycodes

Returns:

the updated ExtendedManagedCustomer

Throws:

UtilityLibraryException - if there is an error in the reflection call

RemoteException - for communication-related exceptions

getBillingAccounts

public List<com.google.api.ads.adwords.axis.v201409.billing.BillingAccount> getBillingAccounts()
                                                                                        throws RemoteException

Gets all the BillingAccounts for the ExtendedMcc.

Returns:

all the BillingAccounts for the ExtendedMcc

Throws:

RemoteException - for communication-related exceptions