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

Class CampaignDelegate

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.cm.Campaign,com.google.api.ads.adwords.axis.v201409.cm.CampaignOperation,com.google.api.ads.adwords.axis.v201409.cm.CampaignServiceInterface>

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

public final class CampaignDelegate
extends AbstractGetMutateDelegate<com.google.api.ads.adwords.axis.v201409.cm.Campaign,com.google.api.ads.adwords.axis.v201409.cm.CampaignOperation,com.google.api.ads.adwords.axis.v201409.cm.CampaignServiceInterface>

Specific AbstractGetMutateDelegate for Campaign.

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
CampaignDelegate(AdWordsSession adWordsSession) Default Constructor.
CampaignDelegate(AdWordsSession adWordsSession, com.google.api.ads.adwords.axis.v201409.cm.CampaignServiceInterface service) Constructor with custom service.
CampaignDelegate(AdWordsSession adWordsSession, List<SelectorFields.Campaign> selectorFields) Constructor with custom fields.

Method Summary

Methods

Modifier and Type	Method and Description
List<com.google.api.ads.adwords.axis.v201409.cm.Campaign>	getByCampaignId(List<Long> campaignIds) Retrieves Campaigns by campaignIds.
com.google.api.ads.adwords.axis.v201409.cm.Campaign	getByCampaignId(Long campaignId) Retrieves a Campaign by campaignId.
List<com.google.api.ads.adwords.axis.v201409.cm.Campaign>	getByLabelIds(List<Long> labelIds) Retrieves Campaigns by labelIds.
List<com.google.api.ads.adwords.axis.v201409.cm.Campaign>	getByStatus(com.google.api.ads.adwords.axis.v201409.cm.CampaignStatus campaignStatus) Retrieves Campaigns by campaignStatus.
com.google.api.ads.adwords.axis.v201409.cm.CampaignLabel	insertCampaignLabel(com.google.api.ads.adwords.axis.v201409.cm.CampaignLabel campaignLabel) Creates a link (CampaignLabel) between Campaigns and Labels.
List<com.google.api.ads.adwords.axis.v201409.cm.CampaignLabel>	insertCampaignLabel(List<com.google.api.ads.adwords.axis.v201409.cm.CampaignLabel> campaignLabels) Creates a link (CampaignLabel) between Campaigns and Labels.
com.google.api.ads.adwords.axis.v201409.cm.Campaign	remove(com.google.api.ads.adwords.axis.v201409.cm.Campaign campaign) Removes Campaign.
List<com.google.api.ads.adwords.axis.v201409.cm.Campaign>	remove(List<com.google.api.ads.adwords.axis.v201409.cm.Campaign> list) Removes Campaign.
com.google.api.ads.adwords.axis.v201409.cm.CampaignLabel	removeCampaignLabel(com.google.api.ads.adwords.axis.v201409.cm.CampaignLabel campaignLabel) Removes a link (CampaignLabel) between Campaigns and Labels.
List<com.google.api.ads.adwords.axis.v201409.cm.CampaignLabel>	removeCampaignLabel(List<com.google.api.ads.adwords.axis.v201409.cm.CampaignLabel> campaignLabels) Removes a link (CampaignLabel) between Campaigns and Labels.

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

insert, insert, mutate, 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

CampaignDelegate

public CampaignDelegate(AdWordsSession adWordsSession)

Default Constructor.

Parameters:

adWordsSession - the adWordsSession to use with the delegate/service

CampaignDelegate

public CampaignDelegate(AdWordsSession adWordsSession,
                com.google.api.ads.adwords.axis.v201409.cm.CampaignServiceInterface service)

Constructor with custom service.

Parameters:

adWordsSession - the adWordsSession to use with the delegate/service

service - the custom service class for the SOAP service

CampaignDelegate

public CampaignDelegate(AdWordsSession adWordsSession,
                List<SelectorFields.Campaign> 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

getByCampaignId

public List<com.google.api.ads.adwords.axis.v201409.cm.Campaign> getByCampaignId(List<Long> campaignIds)
                                                                          throws RemoteException

Retrieves Campaigns by campaignIds.

Parameters:

campaignIds - the Ids of the Campaigns

Returns:

a list of Campaigns matching campaignIds

Throws:

RemoteException - for communication-related exceptions

getByCampaignId

public com.google.api.ads.adwords.axis.v201409.cm.Campaign getByCampaignId(Long campaignId)
                                                                    throws RemoteException

Retrieves a Campaign by campaignId.

Parameters:

campaignId - the Id of the Campaign

Returns:

a list of Campaigns matching campaignId

Throws:

RemoteException - for communication-related exceptions

getByStatus

public List<com.google.api.ads.adwords.axis.v201409.cm.Campaign> getByStatus(com.google.api.ads.adwords.axis.v201409.cm.CampaignStatus campaignStatus)
                                                                      throws RemoteException

Retrieves Campaigns by campaignStatus.

Parameters:

campaignStatus - the Status of the Campaign

Returns:

a list of Campaigns matching campaignStatus

Throws:

RemoteException - for communication-related exceptions

getByLabelIds

public List<com.google.api.ads.adwords.axis.v201409.cm.Campaign> getByLabelIds(List<Long> labelIds)
                                                                        throws RemoteException

Retrieves Campaigns by labelIds.

Parameters:

labelIds - the Ids of the Labels to retrieve the Campaigns

Returns:

a list of Campaigns matching labelIds

Throws:

RemoteException - for communication-related exceptions

remove

public List<com.google.api.ads.adwords.axis.v201409.cm.Campaign> remove(List<com.google.api.ads.adwords.axis.v201409.cm.Campaign> list)
                                                                 throws RemoteException

Removes Campaign. Removing it sets the campaigns' statuses to DELETED and performs a Set.

Overrides:

remove in class AbstractGetMutateDelegate<com.google.api.ads.adwords.axis.v201409.cm.Campaign,com.google.api.ads.adwords.axis.v201409.cm.CampaignOperation,com.google.api.ads.adwords.axis.v201409.cm.CampaignServiceInterface>

Parameters:

list - the list of Campaigns to remove

Returns:

the Campaigns deleted

Throws:

RemoteException - for communication-related exceptions

remove

public com.google.api.ads.adwords.axis.v201409.cm.Campaign remove(com.google.api.ads.adwords.axis.v201409.cm.Campaign campaign)
                                                           throws RemoteException

Removes Campaign. Removing it sets the campaing's status to DELETED and performs a Set.

Overrides:

remove in class AbstractGetMutateDelegate<com.google.api.ads.adwords.axis.v201409.cm.Campaign,com.google.api.ads.adwords.axis.v201409.cm.CampaignOperation,com.google.api.ads.adwords.axis.v201409.cm.CampaignServiceInterface>

Parameters:

campaign - the Campaign to remove

Returns:

the Campaign deleted

Throws:

RemoteException - for communication-related exceptions

insertCampaignLabel

public List<com.google.api.ads.adwords.axis.v201409.cm.CampaignLabel> insertCampaignLabel(List<com.google.api.ads.adwords.axis.v201409.cm.CampaignLabel> campaignLabels)
                                                                                   throws RemoteException

Creates a link (CampaignLabel) between Campaigns and Labels.

Parameters:

campaignLabels - the CampaignLabels to add

Returns:

the CampaignLabels added

Throws:

RemoteException - for communication-related exceptions

insertCampaignLabel

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

Creates a link (CampaignLabel) between Campaigns and Labels.

Parameters:

campaignLabel - the CampaignLabel to add

Returns:

the CampaignLabel added

Throws:

RemoteException - for communication-related exceptions

removeCampaignLabel

public List<com.google.api.ads.adwords.axis.v201409.cm.CampaignLabel> removeCampaignLabel(List<com.google.api.ads.adwords.axis.v201409.cm.CampaignLabel> campaignLabels)
                                                                                   throws RemoteException

Removes a link (CampaignLabel) between Campaigns and Labels.

Parameters:

campaignLabels - the CampaignLabels to remove

Returns:

the CampaignLabels removed

Throws:

RemoteException - for communication-related exceptions

removeCampaignLabel

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

Removes a link (CampaignLabel) between Campaigns and Labels.

Parameters:

campaignLabel - the CampaignLabel to remove

Returns:

the CampaignLabel removed

Throws:

RemoteException - for communication-related exceptions