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

Class ExtendedAdGroup

java.lang.Object

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

public final class ExtendedAdGroup
extends Object

ExtendedAdGroup, encapsulates the AdGroup level operations.

Author:

Julian Toledo

Constructor Summary

Constructors

Constructor and Description
ExtendedAdGroup(com.google.api.ads.adwords.axis.v201309.cm.AdGroup adGroup, DelegateLocator delegateLocator) Default Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
static List<ExtendedAdGroup>	as(List<com.google.api.ads.adwords.axis.v201309.cm.AdGroup> adGroups, DelegateLocator delegateLocator) Transforms a regular list of AdGroups into a list of ExtendedAdGroups.
com.google.api.ads.adwords.axis.v201309.cm.AdGroup	getAdGroup() Retrieves the encapsulated AdGroup.
List<com.google.api.ads.adwords.axis.v201309.cm.AdGroupAd>	getAdGroupAds() Gets the AdGroupAds for the ExtendedAdGroup's AdGroup.
List<com.google.api.ads.adwords.axis.v201309.cm.AdGroupBidLandscape>	getAdGroupBidLandscapes() Gets the AdGroupBidLandscapes for the ExtendedAdGroup's AdGroup.
List<com.google.api.ads.adwords.axis.v201309.cm.AdGroupCriterion>	getAdGroupCriterions() Gets the AdGroupCriterions for the ExtendedAdGroup's AdGroup.
List<com.google.api.ads.adwords.axis.v201309.cm.AdGroupFeed>	getAdGroupFeeds() Gets the AdGroupFeeds for the ExtendedAdGroup's AdGroup.
List<com.google.api.ads.adwords.axis.v201309.cm.AdParam>	getAdParams() Gets the AdParams for the ExtendedAdGroup's AdGroup.
List<com.google.api.ads.adwords.axis.v201309.cm.AdGroupCriterion>	getBiddableAdGroupCriterions() Gets the Biddable (Positive) AdGroupCriterions for the ExtendedAdGroup's AdGroup.
List<com.google.api.ads.adwords.axis.v201309.cm.CriterionBidLandscape>	getCriterionBidLandscape() Gets the CriterionBidLandscapes for the ExtendedAdGroup's AdGroup.
DelegateLocator	getDelegateLocator() Retrieves the DelegateLocator for the Account (ManagedCustomer).
List<com.google.api.ads.adwords.axis.v201309.cm.AdGroupCriterion>	getNegativeAdGroupCriterions() Gets the Negative AdGroupCriterions for the ExtendedAdGroup's AdGroup.
com.google.api.ads.adwords.axis.v201309.cm.AdGroupAd	insertAd(com.google.api.ads.adwords.axis.v201309.cm.Ad ad) Inserts the Ad into the ExtendedAdGroup's AdGroup.
com.google.api.ads.adwords.axis.v201309.cm.AdGroupAd	insertAdGroupAd(com.google.api.ads.adwords.axis.v201309.cm.AdGroupAd adGroupAd) Inserts the AdGroupAd into the ExtendedAdGroup's AdGroup.
List<com.google.api.ads.adwords.axis.v201309.cm.AdGroupAd>	insertAdGroupAds(List<com.google.api.ads.adwords.axis.v201309.cm.AdGroupAd> adGroupAds) Inserts the AdGroupAds into the ExtendedAdGroup's AdGroup.
com.google.api.ads.adwords.axis.v201309.cm.AdGroupCriterion	insertAdGroupCriterion(com.google.api.ads.adwords.axis.v201309.cm.AdGroupCriterion adGroupCriterion) Inserts the AdGroupCriterion into the ExtendedAdGroup's AdGroup.
List<com.google.api.ads.adwords.axis.v201309.cm.AdGroupCriterion>	insertAdGroupCriterions(List<com.google.api.ads.adwords.axis.v201309.cm.AdGroupCriterion> adGroupCriterions) Inserts the AdGroupCriterions into the ExtendedAdGroup's AdGroup.
List<com.google.api.ads.adwords.axis.v201309.cm.AdGroupAd>	insertAds(List<com.google.api.ads.adwords.axis.v201309.cm.Ad> ads) Inserts the Ads into the ExtendedAdGroup's AdGroup.
com.google.api.ads.adwords.axis.v201309.cm.AdGroupAd	removeAdGroupAd(com.google.api.ads.adwords.axis.v201309.cm.AdGroupAd adGroupAd) Removes the AdGroupAd from the ExtendedAdGroup's AdGroup.
List<com.google.api.ads.adwords.axis.v201309.cm.AdGroupAd>	removeAdGroupAds(List<com.google.api.ads.adwords.axis.v201309.cm.AdGroupAd> adGroupAds) Removes the AdGroupAds from the ExtendedAdGroup's AdGroup.
com.google.api.ads.adwords.axis.v201309.cm.AdGroupCriterion	removeAdGroupCriterion(com.google.api.ads.adwords.axis.v201309.cm.AdGroupCriterion adGroupCriterion) Removes the AdGroupCriterion from the ExtendedAdGroup's AdGroup.
List<com.google.api.ads.adwords.axis.v201309.cm.AdGroupCriterion>	removeAdGroupCriterions(List<com.google.api.ads.adwords.axis.v201309.cm.AdGroupCriterion> adGroupCriterions) Removes the AdGroupCriterions from the ExtendedAdGroup's AdGroup.
com.google.api.ads.adwords.axis.v201309.cm.AdParam	removeAdParam(com.google.api.ads.adwords.axis.v201309.cm.AdParam adParam) Removes the AdParam from the ExtendedAdGroup's AdGroup.
List<com.google.api.ads.adwords.axis.v201309.cm.AdParam>	removeAdParams(List<com.google.api.ads.adwords.axis.v201309.cm.AdParam> adParams) Removes the AdParams from the ExtendedAdGroup's AdGroup.
ExtendedAdGroup	update() Updates the ExtendedAdGroup's AdGroup.
com.google.api.ads.adwords.axis.v201309.cm.AdGroupAd	updateAdGroupAd(com.google.api.ads.adwords.axis.v201309.cm.AdGroupAd adGroupAd) Updates the AdGroupAd for the ExtendedAdGroup's AdGroup.
List<com.google.api.ads.adwords.axis.v201309.cm.AdGroupAd>	updateAdGroupAds(List<com.google.api.ads.adwords.axis.v201309.cm.AdGroupAd> adGroupAds) Updates the AdGroupAds for the ExtendedAdGroup's AdGroup.
com.google.api.ads.adwords.axis.v201309.cm.AdParam	updateAdParam(com.google.api.ads.adwords.axis.v201309.cm.AdParam adParam) Updates the AdParam for the ExtendedAdGroup's AdGroup.
List<com.google.api.ads.adwords.axis.v201309.cm.AdParam>	updateAdParams(List<com.google.api.ads.adwords.axis.v201309.cm.AdParam> adParams) Updates the AdParams for the ExtendedAdGroup's AdGroup.
com.google.api.ads.adwords.axis.v201309.cm.AdGroupCriterion	updateBiddableAdGroupCriterion(com.google.api.ads.adwords.axis.v201309.cm.AdGroupCriterion adGroupCriterion) Updates the Biddable AdGroupCriterion for the ExtendedAdGroup's AdGroup.
List<com.google.api.ads.adwords.axis.v201309.cm.AdGroupCriterion>	updateBiddableAdGroupCriterions(List<com.google.api.ads.adwords.axis.v201309.cm.AdGroupCriterion> adGroupCriterions) Updates the Biddable AdGroupCriterions for the ExtendedAdGroup's AdGroup.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExtendedAdGroup

public ExtendedAdGroup(com.google.api.ads.adwords.axis.v201309.cm.AdGroup adGroup,
               DelegateLocator delegateLocator)

Default Constructor.

Parameters:

delegateLocator - the DelegateLocator for the Account (ManagedCustomer)

adGroup - the AdGroup to encapsulate

Method Detail

as

public static List<ExtendedAdGroup> as(List<com.google.api.ads.adwords.axis.v201309.cm.AdGroup> adGroups,
                       DelegateLocator delegateLocator)

Transforms a regular list of AdGroups into a list of ExtendedAdGroups.

Parameters:

adGroups - a list of AdGroups to convert

delegateLocator - the DelegateLocator for the Account (ManagedCustomer)

Returns:

the converted list of ExtendedAdGroups

getDelegateLocator

public DelegateLocator getDelegateLocator()

Retrieves the DelegateLocator for the Account (ManagedCustomer).

Returns:

the DelegateLocator for the Account (ManagedCustomer)

getAdGroup

public com.google.api.ads.adwords.axis.v201309.cm.AdGroup getAdGroup()

Retrieves the encapsulated AdGroup.

Returns:

the encapsulated AdGroup

update

public ExtendedAdGroup update()
                       throws RemoteException

Updates the ExtendedAdGroup's AdGroup.

Note: remove is not supported, instead, set its status to DELETED and then update(). See AdGroupServiceInterface.

Returns:

the updated ExtendedAdGroup

Throws:

RemoteException - for communication-related exceptions

getAdGroupCriterions

public List<com.google.api.ads.adwords.axis.v201309.cm.AdGroupCriterion> getAdGroupCriterions()
                                                                                       throws RemoteException

Gets the AdGroupCriterions for the ExtendedAdGroup's AdGroup.

Returns:

all the AdGroupCriterion for the AdGroup

Throws:

RemoteException - for communication-related exceptions

getNegativeAdGroupCriterions

public List<com.google.api.ads.adwords.axis.v201309.cm.AdGroupCriterion> getNegativeAdGroupCriterions()
                                                                                               throws RemoteException

Gets the Negative AdGroupCriterions for the ExtendedAdGroup's AdGroup.

Returns:

all the Negative AdGroupCriterion for the AdGroup

Throws:

RemoteException - for communication-related exceptions

getBiddableAdGroupCriterions

public List<com.google.api.ads.adwords.axis.v201309.cm.AdGroupCriterion> getBiddableAdGroupCriterions()
                                                                                               throws RemoteException

Gets the Biddable (Positive) AdGroupCriterions for the ExtendedAdGroup's AdGroup.

Returns:

all the Biddable AdGroupCriterion for the AdGroup

Throws:

RemoteException - for communication-related exceptions

insertAdGroupCriterions

public List<com.google.api.ads.adwords.axis.v201309.cm.AdGroupCriterion> insertAdGroupCriterions(List<com.google.api.ads.adwords.axis.v201309.cm.AdGroupCriterion> adGroupCriterions)
                                                                                          throws RemoteException

Inserts the AdGroupCriterions into the ExtendedAdGroup's AdGroup.

Parameters:

adGroupCriterions - the list of AdGroupCriterions to insert

Returns:

the updated list of AdGroupCriterions

Throws:

RemoteException - for communication-related exceptions

insertAdGroupCriterion

public com.google.api.ads.adwords.axis.v201309.cm.AdGroupCriterion insertAdGroupCriterion(com.google.api.ads.adwords.axis.v201309.cm.AdGroupCriterion adGroupCriterion)
                                                                                   throws RemoteException

Inserts the AdGroupCriterion into the ExtendedAdGroup's AdGroup.

Parameters:

adGroupCriterion - the AdGroupCriterion to insert

Returns:

the updated AdGroupCriterion

Throws:

RemoteException - for communication-related exceptions

updateBiddableAdGroupCriterions

public List<com.google.api.ads.adwords.axis.v201309.cm.AdGroupCriterion> updateBiddableAdGroupCriterions(List<com.google.api.ads.adwords.axis.v201309.cm.AdGroupCriterion> adGroupCriterions)
                                                                                                  throws RemoteException

Updates the Biddable AdGroupCriterions for the ExtendedAdGroup's AdGroup.

Parameters:

adGroupCriterions - the list of AdGroupCriterions to update

Returns:

the updated list of AdGroupCriterions

Throws:

RemoteException - for communication-related exceptions

updateBiddableAdGroupCriterion

public com.google.api.ads.adwords.axis.v201309.cm.AdGroupCriterion updateBiddableAdGroupCriterion(com.google.api.ads.adwords.axis.v201309.cm.AdGroupCriterion adGroupCriterion)
                                                                                           throws RemoteException

Updates the Biddable AdGroupCriterion for the ExtendedAdGroup's AdGroup.

Parameters:

adGroupCriterion - the AdGroupCriterion to update

Returns:

the updated list of AdGroupCriterions

Throws:

RemoteException - for communication-related exceptions

removeAdGroupCriterions

public List<com.google.api.ads.adwords.axis.v201309.cm.AdGroupCriterion> removeAdGroupCriterions(List<com.google.api.ads.adwords.axis.v201309.cm.AdGroupCriterion> adGroupCriterions)
                                                                                          throws RemoteException

Removes the AdGroupCriterions from the ExtendedAdGroup's AdGroup.

Parameters:

adGroupCriterions - the list of AdGroupCriterions to remove

Returns:

the updated list of AdGroupCriterions

Throws:

RemoteException - for communication-related exceptions

removeAdGroupCriterion

public com.google.api.ads.adwords.axis.v201309.cm.AdGroupCriterion removeAdGroupCriterion(com.google.api.ads.adwords.axis.v201309.cm.AdGroupCriterion adGroupCriterion)
                                                                                   throws RemoteException

Removes the AdGroupCriterion from the ExtendedAdGroup's AdGroup.

Parameters:

adGroupCriterion - the AdGroupCriterion to remove

Returns:

the updated AdGroupCriterion

Throws:

RemoteException - for communication-related exceptions

getAdGroupAds

public List<com.google.api.ads.adwords.axis.v201309.cm.AdGroupAd> getAdGroupAds()
                                                                         throws RemoteException

Gets the AdGroupAds for the ExtendedAdGroup's AdGroup.

Returns:

all the AdGroupAds for the AdGroup

Throws:

RemoteException - for communication-related exceptions

insertAdGroupAds

public List<com.google.api.ads.adwords.axis.v201309.cm.AdGroupAd> insertAdGroupAds(List<com.google.api.ads.adwords.axis.v201309.cm.AdGroupAd> adGroupAds)
                                                                            throws RemoteException

Inserts the AdGroupAds into the ExtendedAdGroup's AdGroup.

Parameters:

adGroupAds - the list of AdGroupAds to insert

Returns:

the updated list of AdGroupAds

Throws:

RemoteException - for communication-related exceptions

insertAdGroupAd

public com.google.api.ads.adwords.axis.v201309.cm.AdGroupAd insertAdGroupAd(com.google.api.ads.adwords.axis.v201309.cm.AdGroupAd adGroupAd)
                                                                     throws RemoteException

Inserts the AdGroupAd into the ExtendedAdGroup's AdGroup.

Parameters:

adGroupAd - the AdGroupAd to insert

Returns:

the updated AdGroupAd

Throws:

RemoteException - for communication-related exceptions

updateAdGroupAds

public List<com.google.api.ads.adwords.axis.v201309.cm.AdGroupAd> updateAdGroupAds(List<com.google.api.ads.adwords.axis.v201309.cm.AdGroupAd> adGroupAds)
                                                                            throws RemoteException

Updates the AdGroupAds for the ExtendedAdGroup's AdGroup.

Parameters:

adGroupAds - the list of AdGroupAds to update

Returns:

the updated list of AdGroupAds

Throws:

RemoteException - for communication-related exceptions

updateAdGroupAd

public com.google.api.ads.adwords.axis.v201309.cm.AdGroupAd updateAdGroupAd(com.google.api.ads.adwords.axis.v201309.cm.AdGroupAd adGroupAd)
                                                                     throws RemoteException

Updates the AdGroupAd for the ExtendedAdGroup's AdGroup.

Parameters:

adGroupAd - the AdGroupAd to update

Returns:

the updated AdGroupAd

Throws:

RemoteException - for communication-related exceptions

removeAdGroupAds

public List<com.google.api.ads.adwords.axis.v201309.cm.AdGroupAd> removeAdGroupAds(List<com.google.api.ads.adwords.axis.v201309.cm.AdGroupAd> adGroupAds)
                                                                            throws RemoteException

Removes the AdGroupAds from the ExtendedAdGroup's AdGroup.

Parameters:

adGroupAds - the list of AdGroupAds to remove

Returns:

the updated list of AdGroupAds

Throws:

RemoteException - for communication-related exceptions

removeAdGroupAd

public com.google.api.ads.adwords.axis.v201309.cm.AdGroupAd removeAdGroupAd(com.google.api.ads.adwords.axis.v201309.cm.AdGroupAd adGroupAd)
                                                                     throws RemoteException

Removes the AdGroupAd from the ExtendedAdGroup's AdGroup.

Parameters:

adGroupAd - the AdGroupAd to remove

Returns:

the updated AdGroupAd

Throws:

RemoteException - for communication-related exceptions

insertAds

public List<com.google.api.ads.adwords.axis.v201309.cm.AdGroupAd> insertAds(List<com.google.api.ads.adwords.axis.v201309.cm.Ad> ads)
                                                                     throws RemoteException

Inserts the Ads into the ExtendedAdGroup's AdGroup.

Note: this method creates the necessary AdGroupAd implicitly.

Parameters:

ads - the list of Ads to insert

Returns:

the updated list of AdGroupAds

Throws:

RemoteException - for communication-related exceptions

insertAd

public com.google.api.ads.adwords.axis.v201309.cm.AdGroupAd insertAd(com.google.api.ads.adwords.axis.v201309.cm.Ad ad)
                                                              throws RemoteException

Inserts the Ad into the ExtendedAdGroup's AdGroup.

Note: this method creates the necessary AdGroupAd implicitly.

Parameters:

ad - the Ad to insert

Returns:

the updated AdGroupAd

Throws:

RemoteException - for communication-related exceptions

getAdParams

public List<com.google.api.ads.adwords.axis.v201309.cm.AdParam> getAdParams()
                                                                     throws RemoteException

Gets the AdParams for the ExtendedAdGroup's AdGroup.

Returns:

all the AdParams for the ExtendedAdGroup's AdGroup

Throws:

RemoteException - for communication-related exceptions

updateAdParams

public List<com.google.api.ads.adwords.axis.v201309.cm.AdParam> updateAdParams(List<com.google.api.ads.adwords.axis.v201309.cm.AdParam> adParams)
                                                                        throws RemoteException

Updates the AdParams for the ExtendedAdGroup's AdGroup.

Note: insertAdParams is not supported, use update for new AdParams. See AdParamServiceInterface.

Parameters:

adParams - the list of AdParams to update

Returns:

the updated list of AdParams

Throws:

RemoteException - for communication-related exceptions

updateAdParam

public com.google.api.ads.adwords.axis.v201309.cm.AdParam updateAdParam(com.google.api.ads.adwords.axis.v201309.cm.AdParam adParam)
                                                                 throws RemoteException

Updates the AdParam for the ExtendedAdGroup's AdGroup.

Note: insertAdParams is not supported, use update for new AdParams. See AdParamServiceInterface.

Parameters:

adParam - the AdParam to update

Returns:

the updated AdParam

Throws:

RemoteException - for communication-related exceptions

removeAdParams

public List<com.google.api.ads.adwords.axis.v201309.cm.AdParam> removeAdParams(List<com.google.api.ads.adwords.axis.v201309.cm.AdParam> adParams)
                                                                        throws RemoteException

Removes the AdParams from the ExtendedAdGroup's AdGroup.

Parameters:

adParams - the list of AdParams to remove

Returns:

the updated list of AdParams

Throws:

RemoteException - for communication-related exceptions

removeAdParam

public com.google.api.ads.adwords.axis.v201309.cm.AdParam removeAdParam(com.google.api.ads.adwords.axis.v201309.cm.AdParam adParam)
                                                                 throws RemoteException

Removes the AdParam from the ExtendedAdGroup's AdGroup.

Parameters:

adParam - the AdParam to remove

Returns:

the updated AdParam

Throws:

RemoteException - for communication-related exceptions

getAdGroupBidLandscapes

public List<com.google.api.ads.adwords.axis.v201309.cm.AdGroupBidLandscape> getAdGroupBidLandscapes()
                                                                                             throws RemoteException

Gets the AdGroupBidLandscapes for the ExtendedAdGroup's AdGroup.

Returns:

all the AdGroupBidLandscapes for the ExtendedAdGroup's AdGroup

Throws:

RemoteException - for communication-related exceptions

getCriterionBidLandscape

public List<com.google.api.ads.adwords.axis.v201309.cm.CriterionBidLandscape> getCriterionBidLandscape()
                                                                                                throws RemoteException

Gets the CriterionBidLandscapes for the ExtendedAdGroup's AdGroup.

Returns:

all the CriterionBidLandscapes for the ExtendedAdGroup's AdGroup

Throws:

RemoteException - for communication-related exceptions

getAdGroupFeeds

public List<com.google.api.ads.adwords.axis.v201309.cm.AdGroupFeed> getAdGroupFeeds()
                                                                             throws RemoteException

Gets the AdGroupFeeds for the ExtendedAdGroup's AdGroup.

Returns:

all the AdGroupFeeds for the ExtendedAdGroup's AdGroup

Throws:

RemoteException - for communication-related exceptions