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

Class AdGroupAdDelegate

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.AdGroupAd,com.google.api.ads.adwords.axis.v201409.cm.AdGroupAdOperation,com.google.api.ads.adwords.axis.v201409.cm.AdGroupAdServiceInterface>

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

public final class AdGroupAdDelegate
extends AbstractGetMutateDelegate<com.google.api.ads.adwords.axis.v201409.cm.AdGroupAd,com.google.api.ads.adwords.axis.v201409.cm.AdGroupAdOperation,com.google.api.ads.adwords.axis.v201409.cm.AdGroupAdServiceInterface>

Specific AbstractGetMutateDelegate for AdGroupAd.

Author:

Julian Toledo

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
List<com.google.api.ads.adwords.axis.v201409.cm.AdGroupAd>	getByAdGroupId(List<Long> adGroupIds) Retrieves AdGroupAds by adGroupIds.
List<com.google.api.ads.adwords.axis.v201409.cm.AdGroupAd>	getByAdGroupId(Long adGroupId) Retrieves AdGroupAds by adGroupId.
List<com.google.api.ads.adwords.axis.v201409.cm.AdGroupAd>	getByAdGroupId(Long adGroupId, int startIndex, int numberResults) Retrieves AdGroupAds by adGroupId.
com.google.api.ads.adwords.axis.v201409.cm.AdGroupAd	getByAdId(Long adId) Retrieves AdGroupAds by adIds.
List<com.google.api.ads.adwords.axis.v201409.cm.AdGroupAd>	getByLabelIds(List<Long> labelIds) Retrieves AdGroupAds by labelIds.
com.google.api.ads.adwords.axis.v201409.cm.AdGroupAdLabel	insertAdGroupAdLabel(com.google.api.ads.adwords.axis.v201409.cm.AdGroupAdLabel adGroupAdLabel) Creates a link (AdGroupAdLabel) between AdGroupAds and Labels.
List<com.google.api.ads.adwords.axis.v201409.cm.AdGroupAdLabel>	insertAdGroupAdLabel(List<com.google.api.ads.adwords.axis.v201409.cm.AdGroupAdLabel> adGroupAdLabels) Creates a link (AdGroupAdLabel) between AdGroupAds and Labels.
com.google.api.ads.adwords.axis.v201409.cm.AdGroupAdLabel	removeAdGroupAdLabel(com.google.api.ads.adwords.axis.v201409.cm.AdGroupAdLabel adGroupAdLabel) Removes a link (AdGroupAdLabel) between AdGroupAds and Labels.
List<com.google.api.ads.adwords.axis.v201409.cm.AdGroupAdLabel>	removeAdGroupAdLabel(List<com.google.api.ads.adwords.axis.v201409.cm.AdGroupAdLabel> adGroupAdLabels) Removes a link (AdGroupAdLabel) between AdGroupAds and Labels.

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

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

AdGroupAdDelegate

public AdGroupAdDelegate(AdWordsSession adWordsSession)

Default Constructor.

Parameters:

adWordsSession - the adWordsSession to use with the delegate/service

AdGroupAdDelegate

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

getByAdId

public com.google.api.ads.adwords.axis.v201409.cm.AdGroupAd getByAdId(Long adId)
                                                               throws RemoteException

Retrieves AdGroupAds by adIds.

Parameters:

adId - the Id of the Ad to retrieve the AdGroupAd

Returns:

a list of AdGroupAds matching the adIds or a RemoteException/ApiException in the client library call

Throws:

RemoteException - for communication-related exceptions

getByAdGroupId

public List<com.google.api.ads.adwords.axis.v201409.cm.AdGroupAd> getByAdGroupId(List<Long> adGroupIds)
                                                                          throws RemoteException

Retrieves AdGroupAds by adGroupIds.

Parameters:

adGroupIds - the Ids of the AdGroup to retrieve the AdGroupAds

Returns:

a list of AdGroupAds matching the adGroupIds

Throws:

RemoteException - for communication-related exceptions

getByAdGroupId

public List<com.google.api.ads.adwords.axis.v201409.cm.AdGroupAd> getByAdGroupId(Long adGroupId)
                                                                          throws RemoteException

Retrieves AdGroupAds by adGroupId.

Parameters:

adGroupId - the Id of the AdGroup to retrieve the AdGroupAds

Returns:

a list of AdGroupAds matching the adGroupId

Throws:

RemoteException - for communication-related exceptions

getByAdGroupId

public List<com.google.api.ads.adwords.axis.v201409.cm.AdGroupAd> getByAdGroupId(Long adGroupId,
                                                                        int startIndex,
                                                                        int numberResults)
                                                                          throws RemoteException

Retrieves AdGroupAds by adGroupId.

Parameters:

adGroupId - the Id of the AdGroup to retrieve the AdGroupAds

numberResults - number of results

startIndex - index of the first result

Returns:

a list of AdGroupAds matching the adGroupId in the range (startIndex, numberResults)

Throws:

RemoteException - for communication-related exceptions

getByLabelIds

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

Retrieves AdGroupAds by labelIds.

Parameters:

labelIds - the Ids of the Labels to retrieve the AdGroupAds

Returns:

a list of AdGroupAds matching labelIds

Throws:

RemoteException - for communication-related exceptions

insertAdGroupAdLabel

public List<com.google.api.ads.adwords.axis.v201409.cm.AdGroupAdLabel> insertAdGroupAdLabel(List<com.google.api.ads.adwords.axis.v201409.cm.AdGroupAdLabel> adGroupAdLabels)
                                                                                     throws RemoteException

Creates a link (AdGroupAdLabel) between AdGroupAds and Labels.

Parameters:

adGroupAdLabels - the AdGroupAdLabels to add

Returns:

the AdGroupAdLabels added

Throws:

RemoteException - for communication-related exceptions

insertAdGroupAdLabel

public com.google.api.ads.adwords.axis.v201409.cm.AdGroupAdLabel insertAdGroupAdLabel(com.google.api.ads.adwords.axis.v201409.cm.AdGroupAdLabel adGroupAdLabel)
                                                                               throws RemoteException

Creates a link (AdGroupAdLabel) between AdGroupAds and Labels.

Parameters:

adGroupAdLabel - the AdGroupAdLabel to add

Returns:

the AdGroupAdLabel added

Throws:

RemoteException - for communication-related exceptions

removeAdGroupAdLabel

public List<com.google.api.ads.adwords.axis.v201409.cm.AdGroupAdLabel> removeAdGroupAdLabel(List<com.google.api.ads.adwords.axis.v201409.cm.AdGroupAdLabel> adGroupAdLabels)
                                                                                     throws RemoteException

Removes a link (AdGroupAdLabel) between AdGroupAds and Labels.

Parameters:

adGroupAdLabels - the AdGroupAdLabels to remove

Returns:

the AdGroupAdLabels removed

Throws:

RemoteException - for communication-related exceptions

removeAdGroupAdLabel

public com.google.api.ads.adwords.axis.v201409.cm.AdGroupAdLabel removeAdGroupAdLabel(com.google.api.ads.adwords.axis.v201409.cm.AdGroupAdLabel adGroupAdLabel)
                                                                               throws RemoteException

Removes a link (AdGroupAdLabel) between AdGroupAds and Labels.

Parameters:

adGroupAdLabel - the AdGroupAdLabel to remove

Returns:

the AdGroupAdLabel removed

Throws:

RemoteException - for communication-related exceptions