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

Class AdGroupDelegate

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.AdGroup,com.google.api.ads.adwords.axis.v201409.cm.AdGroupOperation,com.google.api.ads.adwords.axis.v201409.cm.AdGroupServiceInterface>

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

public final class AdGroupDelegate
extends AbstractGetMutateDelegate<com.google.api.ads.adwords.axis.v201409.cm.AdGroup,com.google.api.ads.adwords.axis.v201409.cm.AdGroupOperation,com.google.api.ads.adwords.axis.v201409.cm.AdGroupServiceInterface>

Specific AbstractGetMutateDelegate for AdGroup.

Author:

Julian Toledo

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
com.google.api.ads.adwords.axis.v201409.cm.AdGroup	getByAdGroupId(Long adGroupId) Retrieves AdGroups by adIds.
List<com.google.api.ads.adwords.axis.v201409.cm.AdGroup>	getByCampaignId(List<Long> campaignIds) Retrieves AdGroups by campaignIds.
List<com.google.api.ads.adwords.axis.v201409.cm.AdGroup>	getByCampaignId(Long campaignId) Retrieves AdGroups by campaignId.
List<com.google.api.ads.adwords.axis.v201409.cm.AdGroup>	getByCampaignId(Long campaignId, int startIndex, int numberResults) Retrieves AdGroups by campaignId in the range (startIndex, numberResults).
List<com.google.api.ads.adwords.axis.v201409.cm.AdGroup>	getByLabelIds(List<Long> labelIds) Retrieves AdGroups by labelIds.
List<com.google.api.ads.adwords.axis.v201409.cm.AdGroup>	getByStatus(com.google.api.ads.adwords.axis.v201409.cm.AdGroupStatus adGroupStatus) Retrieves AdGroups by adGroupStatus.
List<com.google.api.ads.adwords.axis.v201409.cm.AdGroup>	getByStatus(com.google.api.ads.adwords.axis.v201409.cm.AdGroupStatus adGroupStatus, int startIndex, int numberResults) Retrieves AdGroups by adGroupStatus in the range (startIndex, numberResults).
com.google.api.ads.adwords.axis.v201409.cm.AdGroupLabel	insertAdGroupLabel(com.google.api.ads.adwords.axis.v201409.cm.AdGroupLabel adGroupLabel) Creates a link (AdGroupLabel) between AdGroups and Labels.
List<com.google.api.ads.adwords.axis.v201409.cm.AdGroupLabel>	insertAdGroupLabel(List<com.google.api.ads.adwords.axis.v201409.cm.AdGroupLabel> adGroupLabels) Creates a link (AdGroupLabel) between AdGroups and Labels.
com.google.api.ads.adwords.axis.v201409.cm.AdGroup	remove(com.google.api.ads.adwords.axis.v201409.cm.AdGroup adGroup) Removes AdGroup.
List<com.google.api.ads.adwords.axis.v201409.cm.AdGroup>	remove(List<com.google.api.ads.adwords.axis.v201409.cm.AdGroup> list) Removes AdGroups.
com.google.api.ads.adwords.axis.v201409.cm.AdGroupLabel	removeAdGroupLabel(com.google.api.ads.adwords.axis.v201409.cm.AdGroupLabel adGroupLabel) Removes a link (AdGroupLabel) between AdGroups and Labels.
List<com.google.api.ads.adwords.axis.v201409.cm.AdGroupLabel>	removeAdGroupLabel(List<com.google.api.ads.adwords.axis.v201409.cm.AdGroupLabel> adGroupLabels) Removes a link (AdGroupLabel) between AdGroups 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

AdGroupDelegate

public AdGroupDelegate(AdWordsSession adWordsSession)

Default Constructor.

Parameters:

adWordsSession - the adWordsSession to use with the delegate/service

AdGroupDelegate

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

getByAdGroupId

public com.google.api.ads.adwords.axis.v201409.cm.AdGroup getByAdGroupId(Long adGroupId)
                                                                  throws RemoteException

Retrieves AdGroups by adIds.

Parameters:

adGroupId - the Id of the AdGroup

Returns:

a list of AdGroups matching the adGroupId

Throws:

RemoteException - for communication-related exceptions

getByCampaignId

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

Retrieves AdGroups by campaignIds.

Parameters:

campaignIds - the Ids of the Campaigns

Returns:

a list of AdGroups matching the campaignIds

Throws:

RemoteException - for communication-related exceptions

getByCampaignId

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

Retrieves AdGroups by campaignId.

Parameters:

campaignId - the Id of the Campaign

Returns:

a list of AdGroups matching the campaignId

Throws:

RemoteException - for communication-related exceptions

getByCampaignId

public List<com.google.api.ads.adwords.axis.v201409.cm.AdGroup> getByCampaignId(Long campaignId,
                                                                       int startIndex,
                                                                       int numberResults)
                                                                         throws RemoteException

Retrieves AdGroups by campaignId in the range (startIndex, numberResults).

Parameters:

campaignId - the Id of the Campaign

startIndex - index of the first result

numberResults - number of results

Returns:

a list of AdGroups matching the campaignId in the range (startIndex, numberResults)

Throws:

RemoteException - for communication-related exceptions

getByStatus

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

Retrieves AdGroups by adGroupStatus.

Parameters:

adGroupStatus - the Status of the AdGroup

Returns:

a list of AdGroups matching the campaignId

Throws:

RemoteException - for communication-related exceptions

getByStatus

public List<com.google.api.ads.adwords.axis.v201409.cm.AdGroup> getByStatus(com.google.api.ads.adwords.axis.v201409.cm.AdGroupStatus adGroupStatus,
                                                                   int startIndex,
                                                                   int numberResults)
                                                                     throws RemoteException

Retrieves AdGroups by adGroupStatus in the range (startIndex, numberResults).

Parameters:

adGroupStatus - the Status of the AdGroup

startIndex - index of the first result

numberResults - number of results

Returns:

a list of AdGroups matching the campaignId in the range (startIndex, numberResults)

Throws:

RemoteException - for communication-related exceptions

getByLabelIds

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

Retrieves AdGroups by labelIds.

Parameters:

labelIds - the Ids of the Labels to retreive the AdGroups

Returns:

a list of AdGroups matching labelIds

Throws:

RemoteException - for communication-related exceptions

remove

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

Removes AdGroups. Removing it sets the ad groups' statuses to DELETED and performs a Set.

Overrides:

remove in class AbstractGetMutateDelegate<com.google.api.ads.adwords.axis.v201409.cm.AdGroup,com.google.api.ads.adwords.axis.v201409.cm.AdGroupOperation,com.google.api.ads.adwords.axis.v201409.cm.AdGroupServiceInterface>

Parameters:

list - the list of AdGroups to remove

Returns:

the AdGroups deleted

Throws:

RemoteException - for communication-related exceptions

remove

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

Removes AdGroup. Removing it sets the ad group's status to DELETED and performs a Set.

Overrides:

remove in class AbstractGetMutateDelegate<com.google.api.ads.adwords.axis.v201409.cm.AdGroup,com.google.api.ads.adwords.axis.v201409.cm.AdGroupOperation,com.google.api.ads.adwords.axis.v201409.cm.AdGroupServiceInterface>

Parameters:

adGroup - the AdGroup to remove

Returns:

the AdGroup deleted

Throws:

RemoteException - for communication-related exceptions

insertAdGroupLabel

public List<com.google.api.ads.adwords.axis.v201409.cm.AdGroupLabel> insertAdGroupLabel(List<com.google.api.ads.adwords.axis.v201409.cm.AdGroupLabel> adGroupLabels)
                                                                                 throws RemoteException

Creates a link (AdGroupLabel) between AdGroups and Labels.

Parameters:

adGroupLabels - the AdGroupLabels to add

Returns:

the AdGroupLabels added

Throws:

RemoteException - for communication-related exceptions

insertAdGroupLabel

public com.google.api.ads.adwords.axis.v201409.cm.AdGroupLabel insertAdGroupLabel(com.google.api.ads.adwords.axis.v201409.cm.AdGroupLabel adGroupLabel)
                                                                           throws RemoteException

Creates a link (AdGroupLabel) between AdGroups and Labels.

Parameters:

adGroupLabel - the AdGroupLabel to add

Returns:

the AdGroupLabel added

Throws:

RemoteException - for communication-related exceptions

removeAdGroupLabel

public List<com.google.api.ads.adwords.axis.v201409.cm.AdGroupLabel> removeAdGroupLabel(List<com.google.api.ads.adwords.axis.v201409.cm.AdGroupLabel> adGroupLabels)
                                                                                 throws RemoteException

Removes a link (AdGroupLabel) between AdGroups and Labels.

Parameters:

adGroupLabels - the AdGroupLabels to remove

Returns:

the AdGroupLabels removed

Throws:

RemoteException - for communication-related exceptions

removeAdGroupLabel

public com.google.api.ads.adwords.axis.v201409.cm.AdGroupLabel removeAdGroupLabel(com.google.api.ads.adwords.axis.v201409.cm.AdGroupLabel adGroupLabel)
                                                                           throws RemoteException

Removes a link (AdGroupLabel) between AdGroups and Labels.

Parameters:

adGroupLabel - the AdGroupLabel to remove

Returns:

the AdGroupLabel removed

Throws:

RemoteException - for communication-related exceptions