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

Class ExtendedCampaign

java.lang.Object

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

public final class ExtendedCampaign
extends Object

ExtendedCampaign, encapsulates the Campaign level operations.

Author:

Julian Toledo

Constructor Summary

Constructors

Constructor and Description
ExtendedCampaign(com.google.api.ads.adwords.axis.v201409.cm.Campaign campaign, DelegateLocator delegateLocator) Default Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
static List<ExtendedCampaign>	as(List<com.google.api.ads.adwords.axis.v201409.cm.Campaign> campaigns, DelegateLocator delegateLocator) Transforms a regular list of Campaigns into a list of ExtendedCampaigns.
List<com.google.api.ads.adwords.axis.v201409.cm.AdGroupBidLandscape>	getAdGroupBidLandscapes() Gets the AdGroupBidLandscapes for the ExtendedCampaign's Campaign.
List<com.google.api.ads.adwords.axis.v201409.cm.AdGroup>	getAdGroups() Gets the AdGroups for the ExtendedCampaign's Campaign.
com.google.api.ads.adwords.axis.v201409.cm.Campaign	getCampaign() Retrieves the encapsulated Campaign
List<com.google.api.ads.adwords.axis.v201409.cm.CampaignAdExtension>	getCampaignAdExtensions() Gets the CampaignAdExtensions for the ExtendedCampaign's Campaign.
List<com.google.api.ads.adwords.axis.v201409.ch.CampaignChangeData>	getCampaignChangeData(Date dateStart, Date dateEnd) Gets the CampaignChangeDatas for the ExtendedCampaign's Campaign.
List<com.google.api.ads.adwords.axis.v201409.cm.CampaignCriterion>	getCampaignCriterions() Gets the CampaignCriterions for the ExtendedCampaign's Campaign.
List<com.google.api.ads.adwords.axis.v201409.cm.CampaignFeed>	getCampaignFeeds() Gets the CampaignFeeds for the ExtendedCampaign's Campaign.
List<com.google.api.ads.adwords.axis.v201409.cm.CriterionBidLandscape>	getCriterionBidLandscape() Gets the CriterionBidLandscapes for the ExtendedCampaign's Campaign.
DelegateLocator	getDelegateLocator() Retrieves the DelegateLocator for the Account (ManagedCustomer).
List<com.google.api.ads.adwords.axis.v201409.cm.Experiment>	getExperiments() Gets the Experiments for the ExtendedCampaign's Campaign.
List<ExtendedAdGroup>	getExtendedAdGroups() Gets the ExtendedAdGroups for the ExtendedCampaign's Campaign.
ExtendedAdGroup	insertAdGroup(com.google.api.ads.adwords.axis.v201409.cm.AdGroup adGroup) Inserts the AdGroup into the ExtendedCampaign's Campaign.
List<ExtendedAdGroup>	insertAdGroups(List<com.google.api.ads.adwords.axis.v201409.cm.AdGroup> adGroups) Inserts the AdGroups into the ExtendedCampaign's Campaign.
com.google.api.ads.adwords.axis.v201409.cm.CampaignAdExtension	insertCampaignAdExtension(com.google.api.ads.adwords.axis.v201409.cm.AdExtension adExtension) Inserts the AdExtension into the ExtendedCampaign's Campaign.
com.google.api.ads.adwords.axis.v201409.cm.CampaignAdExtension	insertCampaignAdExtension(com.google.api.ads.adwords.axis.v201409.cm.CampaignAdExtension campaignAdExtension) Inserts the CampaignAdExtension into the ExtendedCampaign's Campaign.
List<com.google.api.ads.adwords.axis.v201409.cm.CampaignAdExtension>	insertCampaignAdExtensions(List<com.google.api.ads.adwords.axis.v201409.cm.CampaignAdExtension> campaignAdExtensions) Inserts the CampaignAdExtensions into the ExtendedCampaign's Campaign.
com.google.api.ads.adwords.axis.v201409.cm.CampaignCriterion	insertCampaignCriterion(com.google.api.ads.adwords.axis.v201409.cm.CampaignCriterion campaignCriterion) Inserts the CampaignCriterion into the ExtendedCampaign's Campaign.
com.google.api.ads.adwords.axis.v201409.cm.CampaignCriterion	insertCampaignCriterion(com.google.api.ads.adwords.axis.v201409.cm.Criterion criterion) Inserts the Criterion into the ExtendedCampaign's Campaign.
List<com.google.api.ads.adwords.axis.v201409.cm.CampaignCriterion>	insertCampaignCriterions(List<com.google.api.ads.adwords.axis.v201409.cm.CampaignCriterion> campaignCriterions) Inserts the CampaignCriterions into the ExtendedCampaign's Campaign.
com.google.api.ads.adwords.axis.v201409.cm.CampaignLabel	insertCampaignLabel(Long labelId) Inserts a CampaignLabel into the ExtendedCampaign's Campaign.
com.google.api.ads.adwords.axis.v201409.cm.Experiment	insertExperiment(com.google.api.ads.adwords.axis.v201409.cm.Experiment experiment) Inserts the Experiment into the ExtendedCampaign's Campaign.
List<com.google.api.ads.adwords.axis.v201409.cm.Experiment>	insertExperiments(List<com.google.api.ads.adwords.axis.v201409.cm.Experiment> experiments) Inserts the Experiments into the ExtendedCampaign's Campaign.
com.google.api.ads.adwords.axis.v201409.cm.CampaignCriterion	insertNegativeCampaignCriterion(com.google.api.ads.adwords.axis.v201409.cm.Criterion criterion) Inserts the Criterion as negative into the ExtendedCampaign's Campaign.
com.google.api.ads.adwords.axis.v201409.cm.CampaignAdExtension	removeCampaignAdExtension(com.google.api.ads.adwords.axis.v201409.cm.CampaignAdExtension campaignAdExtension) Removes the CampaignAdExtension from the ExtendedCampaign's Campaign.
List<com.google.api.ads.adwords.axis.v201409.cm.CampaignAdExtension>	removeCampaignAdExtensions(List<com.google.api.ads.adwords.axis.v201409.cm.CampaignAdExtension> campaignAdExtensions) Removes the CampaignAdExtensions from the ExtendedCampaign's Campaign.
com.google.api.ads.adwords.axis.v201409.cm.CampaignCriterion	removeCampaignCriterion(com.google.api.ads.adwords.axis.v201409.cm.CampaignCriterion campaignCriterion) Removes the CampaignCriterion from the ExtendedCampaign's Campaign.
List<com.google.api.ads.adwords.axis.v201409.cm.CampaignCriterion>	removeCampaignCriterions(List<com.google.api.ads.adwords.axis.v201409.cm.CampaignCriterion> campaignCriterions) Removes the CampaignCriterions from the ExtendedCampaign's Campaign.
com.google.api.ads.adwords.axis.v201409.cm.CampaignLabel	removeCampaignLabel(Long labelId) Removes a CampaignLabel into the ExtendedCampaign's Campaign.
ExtendedCampaign	update() Updates the ExtendedCampaign's Campaign.
List<ExtendedAdGroup>	updateAdGroups(List<com.google.api.ads.adwords.axis.v201409.cm.AdGroup> adGroups) Uptades the AdGroups for the ExtendedCampaign's Campaign.
com.google.api.ads.adwords.axis.v201409.cm.CampaignCriterion	updateCampaignCriterion(com.google.api.ads.adwords.axis.v201409.cm.CampaignCriterion campaignCriterion) Updates the CampaignCriterion for the ExtendedCampaign's Campaign.
List<com.google.api.ads.adwords.axis.v201409.cm.CampaignCriterion>	updateCampaignCriterions(List<com.google.api.ads.adwords.axis.v201409.cm.CampaignCriterion> campaignCriterions) Updates the CampaignCriterions for the ExtendedCampaign's Campaign.
com.google.api.ads.adwords.axis.v201409.cm.Experiment	updateExperiment(com.google.api.ads.adwords.axis.v201409.cm.Experiment experiment) Updates the Experiment into the ExtendedCampaign's Campaign.
List<com.google.api.ads.adwords.axis.v201409.cm.Experiment>	updateExperiments(List<com.google.api.ads.adwords.axis.v201409.cm.Experiment> experiments) Updates the Experiments into the ExtendedCampaign's Campaign.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExtendedCampaign

public ExtendedCampaign(com.google.api.ads.adwords.axis.v201409.cm.Campaign campaign,
                DelegateLocator delegateLocator)

Default Constructor.

Parameters:

campaign - the Campaign to encapsulate

delegateLocator - the DelegateLocator for the Account (ManagedCustomer)

Method Detail

as

public static List<ExtendedCampaign> as(List<com.google.api.ads.adwords.axis.v201409.cm.Campaign> campaigns,
                        DelegateLocator delegateLocator)

Transforms a regular list of Campaigns into a list of ExtendedCampaigns.

Parameters:

campaigns - a list of Campaigns to convert

delegateLocator - the DelegateLocator for the Account (ManagedCustomer)

Returns:

the converted list of ExtendedCampaigns

getDelegateLocator

public DelegateLocator getDelegateLocator()

Retrieves the DelegateLocator for the Account (ManagedCustomer).

Returns:

the DelegateLocator for the Account (ManagedCustomer)

getCampaign

public com.google.api.ads.adwords.axis.v201409.cm.Campaign getCampaign()

Retrieves the encapsulated Campaign

Returns:

the encapsulated Campaign

update

public ExtendedCampaign update()
                        throws RemoteException

Updates the ExtendedCampaign's Campaign.

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

Returns:

the updated ExtendedCampaign

Throws:

RemoteException - for communication-related exceptions

getExtendedAdGroups

public List<ExtendedAdGroup> getExtendedAdGroups()
                                          throws RemoteException

Gets the ExtendedAdGroups for the ExtendedCampaign's Campaign.

Returns:

all the ExtendedAdGroups for the ExtendedCampaign's Campaign

Throws:

RemoteException - for communication-related exceptions

getAdGroups

public List<com.google.api.ads.adwords.axis.v201409.cm.AdGroup> getAdGroups()
                                                                     throws RemoteException

Gets the AdGroups for the ExtendedCampaign's Campaign.

Returns:

all the AdGroups for the ExtendedCampaign's Campaign

Throws:

RemoteException - for communication-related exceptions

insertAdGroups

public List<ExtendedAdGroup> insertAdGroups(List<com.google.api.ads.adwords.axis.v201409.cm.AdGroup> adGroups)
                                     throws RemoteException

Inserts the AdGroups into the ExtendedCampaign's Campaign.

Parameters:

adGroups - the list of AdGroups to insert

Returns:

the updated List of ExtendedAdGroups

Throws:

RemoteException - for communication-related exceptions

insertAdGroup

public ExtendedAdGroup insertAdGroup(com.google.api.ads.adwords.axis.v201409.cm.AdGroup adGroup)
                              throws RemoteException

Inserts the AdGroup into the ExtendedCampaign's Campaign.

Parameters:

adGroup - the AdGroup to insert

Returns:

the updated ExtendedAdGroup

Throws:

RemoteException - for communication-related exceptions

updateAdGroups

public List<ExtendedAdGroup> updateAdGroups(List<com.google.api.ads.adwords.axis.v201409.cm.AdGroup> adGroups)
                                     throws RemoteException

Uptades the AdGroups for the ExtendedCampaign's Campaign.

Parameters:

adGroups - the list of AdGroups to update

Returns:

the updated list of ExtendedAdGroups

Throws:

RemoteException - for communication-related exceptions

getCampaignCriterions

public List<com.google.api.ads.adwords.axis.v201409.cm.CampaignCriterion> getCampaignCriterions()
                                                                                         throws RemoteException

Gets the CampaignCriterions for the ExtendedCampaign's Campaign.

Returns:

all the CampaignCriterions for the ExtendedCampaign's Campaign

Throws:

RemoteException - for communication-related exceptions

insertCampaignCriterions

public List<com.google.api.ads.adwords.axis.v201409.cm.CampaignCriterion> insertCampaignCriterions(List<com.google.api.ads.adwords.axis.v201409.cm.CampaignCriterion> campaignCriterions)
                                                                                            throws RemoteException

Inserts the CampaignCriterions into the ExtendedCampaign's Campaign.

Parameters:

campaignCriterions - the list of CampaignCriterions to insert

Returns:

the updated list of CampaignCriterions

Throws:

RemoteException - for communication-related exceptions

insertCampaignCriterion

public com.google.api.ads.adwords.axis.v201409.cm.CampaignCriterion insertCampaignCriterion(com.google.api.ads.adwords.axis.v201409.cm.CampaignCriterion campaignCriterion)
                                                                                     throws RemoteException

Inserts the CampaignCriterion into the ExtendedCampaign's Campaign.

Parameters:

campaignCriterion - the CampaignCriterion to insert

Returns:

the updated CampaignCriterion

Throws:

RemoteException - for communication-related exceptions

insertCampaignCriterion

public com.google.api.ads.adwords.axis.v201409.cm.CampaignCriterion insertCampaignCriterion(com.google.api.ads.adwords.axis.v201409.cm.Criterion criterion)
                                                                                     throws RemoteException

Inserts the Criterion into the ExtendedCampaign's Campaign.

Note: this method creates the necessary CampaignCriterion implicitly.

Parameters:

criterion - the Criterion to insert

Returns:

the updated CampaignCriterion

Throws:

RemoteException - for communication-related exceptions

insertNegativeCampaignCriterion

public com.google.api.ads.adwords.axis.v201409.cm.CampaignCriterion insertNegativeCampaignCriterion(com.google.api.ads.adwords.axis.v201409.cm.Criterion criterion)
                                                                                             throws RemoteException

Inserts the Criterion as negative into the ExtendedCampaign's Campaign.

Note: this method creates the necessary NegativeCampaignCriterion implicitly.

Parameters:

criterion - the Criterion to insert

Returns:

the updated CampaignCriterion

Throws:

RemoteException - for communication-related exceptions

updateCampaignCriterions

public List<com.google.api.ads.adwords.axis.v201409.cm.CampaignCriterion> updateCampaignCriterions(List<com.google.api.ads.adwords.axis.v201409.cm.CampaignCriterion> campaignCriterions)
                                                                                            throws RemoteException

Updates the CampaignCriterions for the ExtendedCampaign's Campaign.

Parameters:

campaignCriterions - the list of CampaignCriterions to update

Returns:

the updated list of CampaignCriterions

Throws:

RemoteException - for communication-related exceptions

updateCampaignCriterion

public com.google.api.ads.adwords.axis.v201409.cm.CampaignCriterion updateCampaignCriterion(com.google.api.ads.adwords.axis.v201409.cm.CampaignCriterion campaignCriterion)
                                                                                     throws RemoteException

Updates the CampaignCriterion for the ExtendedCampaign's Campaign.

Parameters:

campaignCriterion - the CampaignCriterion to update

Returns:

the updated CampaignCriterion

Throws:

RemoteException - for communication-related exceptions

removeCampaignCriterions

public List<com.google.api.ads.adwords.axis.v201409.cm.CampaignCriterion> removeCampaignCriterions(List<com.google.api.ads.adwords.axis.v201409.cm.CampaignCriterion> campaignCriterions)
                                                                                            throws RemoteException

Removes the CampaignCriterions from the ExtendedCampaign's Campaign.

Parameters:

campaignCriterions - the list of CampaignCriterions to remove

Returns:

the updated list of CampaignCriterions

Throws:

RemoteException - for communication-related exceptions

removeCampaignCriterion

public com.google.api.ads.adwords.axis.v201409.cm.CampaignCriterion removeCampaignCriterion(com.google.api.ads.adwords.axis.v201409.cm.CampaignCriterion campaignCriterion)
                                                                                     throws RemoteException

Removes the CampaignCriterion from the ExtendedCampaign's Campaign.

Parameters:

campaignCriterion - the CampaignCriterion to remove

Returns:

the updated CampaignCriterion

Throws:

RemoteException - for communication-related exceptions

getCampaignAdExtensions

public List<com.google.api.ads.adwords.axis.v201409.cm.CampaignAdExtension> getCampaignAdExtensions()
                                                                                             throws RemoteException

Gets the CampaignAdExtensions for the ExtendedCampaign's Campaign.

Returns:

all the CampaignAdExtensions for the ExtendedCampaign's Campaign

Throws:

RemoteException - for communication-related exceptions

insertCampaignAdExtensions

public List<com.google.api.ads.adwords.axis.v201409.cm.CampaignAdExtension> insertCampaignAdExtensions(List<com.google.api.ads.adwords.axis.v201409.cm.CampaignAdExtension> campaignAdExtensions)
                                                                                                throws RemoteException

Inserts the CampaignAdExtensions into the ExtendedCampaign's Campaign.

Parameters:

campaignAdExtensions - the list of CampaignAdExtension to insert

Returns:

the updated list of CampaignAdExtensions

Throws:

RemoteException - for communication-related exceptions

insertCampaignAdExtension

public com.google.api.ads.adwords.axis.v201409.cm.CampaignAdExtension insertCampaignAdExtension(com.google.api.ads.adwords.axis.v201409.cm.CampaignAdExtension campaignAdExtension)
                                                                                         throws RemoteException

Inserts the CampaignAdExtension into the ExtendedCampaign's Campaign.

Parameters:

campaignAdExtension - the CampaignAdExtension to insert

Returns:

the updated CampaignAdExtension

Throws:

RemoteException - for communication-related exceptions

insertCampaignAdExtension

public com.google.api.ads.adwords.axis.v201409.cm.CampaignAdExtension insertCampaignAdExtension(com.google.api.ads.adwords.axis.v201409.cm.AdExtension adExtension)
                                                                                         throws RemoteException

Inserts the AdExtension into the ExtendedCampaign's Campaign.

Note: this method creates the necessary CampaignAdExtension implicitly.

Parameters:

adExtension - the AdExtension to insert

Returns:

the updated CampaignAdExtension

Throws:

RemoteException - for communication-related exceptions

removeCampaignAdExtensions

public List<com.google.api.ads.adwords.axis.v201409.cm.CampaignAdExtension> removeCampaignAdExtensions(List<com.google.api.ads.adwords.axis.v201409.cm.CampaignAdExtension> campaignAdExtensions)
                                                                                                throws RemoteException

Removes the CampaignAdExtensions from the ExtendedCampaign's Campaign.

Parameters:

campaignAdExtensions - the list of CampaignAdExtensions to remove

Returns:

the updated list of CampaignAdExtensions

Throws:

RemoteException - for communication-related exceptions

removeCampaignAdExtension

public com.google.api.ads.adwords.axis.v201409.cm.CampaignAdExtension removeCampaignAdExtension(com.google.api.ads.adwords.axis.v201409.cm.CampaignAdExtension campaignAdExtension)
                                                                                         throws RemoteException

Removes the CampaignAdExtension from the ExtendedCampaign's Campaign.

Parameters:

campaignAdExtension - the CampaignAdExtension to remove

Returns:

the updated CampaignAdExtension

Throws:

RemoteException - for communication-related exceptions

getExperiments

public List<com.google.api.ads.adwords.axis.v201409.cm.Experiment> getExperiments()
                                                                           throws RemoteException

Gets the Experiments for the ExtendedCampaign's Campaign.

Returns:

all the Experiments for the ExtendedCampaign's Campaign

Throws:

RemoteException - for communication-related exceptions

insertExperiments

public List<com.google.api.ads.adwords.axis.v201409.cm.Experiment> insertExperiments(List<com.google.api.ads.adwords.axis.v201409.cm.Experiment> experiments)
                                                                              throws RemoteException

Inserts the Experiments into the ExtendedCampaign's Campaign.

Parameters:

experiments - the list of Experiments to insert

Returns:

the updated list of Experiments

Throws:

RemoteException - for communication-related exceptions

insertExperiment

public com.google.api.ads.adwords.axis.v201409.cm.Experiment insertExperiment(com.google.api.ads.adwords.axis.v201409.cm.Experiment experiment)
                                                                       throws RemoteException

Inserts the Experiment into the ExtendedCampaign's Campaign.

Parameters:

experiment - the Experiment to insert

Returns:

the updated Experiment

Throws:

RemoteException - for communication-related exceptions

updateExperiments

public List<com.google.api.ads.adwords.axis.v201409.cm.Experiment> updateExperiments(List<com.google.api.ads.adwords.axis.v201409.cm.Experiment> experiments)
                                                                              throws RemoteException

Updates the Experiments into the ExtendedCampaign's Campaign.

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

Parameters:

experiments - the list of Experiments to update

Returns:

the updated list of Experiments

Throws:

RemoteException - for communication-related exceptions

updateExperiment

public com.google.api.ads.adwords.axis.v201409.cm.Experiment updateExperiment(com.google.api.ads.adwords.axis.v201409.cm.Experiment experiment)
                                                                       throws RemoteException

Updates the Experiment into the ExtendedCampaign's Campaign.

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

Parameters:

experiment - the Experiment to update

Returns:

the updated Experiment

Throws:

RemoteException - for communication-related exceptions

getAdGroupBidLandscapes

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

Gets the AdGroupBidLandscapes for the ExtendedCampaign's Campaign.

Returns:

all the AdGroupBidLandscapes for the ExtendedCampaign's Campaign

Throws:

RemoteException - for communication-related exceptions

getCriterionBidLandscape

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

Gets the CriterionBidLandscapes for the ExtendedCampaign's Campaign.

Returns:

all the CriterionBidLandscapes for the ExtendedCampaign's Campaign

Throws:

RemoteException - for communication-related exceptions

getCampaignChangeData

public List<com.google.api.ads.adwords.axis.v201409.ch.CampaignChangeData> getCampaignChangeData(Date dateStart,
                                                                                        Date dateEnd)
                                                                                          throws RemoteException

Gets the CampaignChangeDatas for the ExtendedCampaign's Campaign.

Returns:

all the CampaignChangeData for the ExtendedCampaign's Campaign

Throws:

RemoteException - for communication-related exceptions

getCampaignFeeds

public List<com.google.api.ads.adwords.axis.v201409.cm.CampaignFeed> getCampaignFeeds()
                                                                               throws RemoteException

Gets the CampaignFeeds for the ExtendedCampaign's Campaign.

Returns:

all the CampaignFeeds for the ExtendedManagedCustomer's ManagedCustomer

Throws:

RemoteException - for communication-related exceptions

insertCampaignLabel

public com.google.api.ads.adwords.axis.v201409.cm.CampaignLabel insertCampaignLabel(Long labelId)
                                                                             throws RemoteException

Inserts a CampaignLabel into the ExtendedCampaign's Campaign.

(Creates a Label to Campaign link).

Parameters:

labelId - the Label to insert

Returns:

the new CampaignLabel

Throws:

RemoteException - for communication-related exceptions

removeCampaignLabel

public com.google.api.ads.adwords.axis.v201409.cm.CampaignLabel removeCampaignLabel(Long labelId)
                                                                             throws RemoteException

Removes a CampaignLabel into the ExtendedCampaign's Campaign.

(Deletes a Label to Campaign link).

Parameters:

labelId - the Label to insert

Returns:

the new CampaignLabel

Throws:

RemoteException - for communication-related exceptions