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

Class AdGroupCriterionDelegate

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.AdGroupCriterion,com.google.api.ads.adwords.axis.v201409.cm.AdGroupCriterionOperation,com.google.api.ads.adwords.axis.v201409.cm.AdGroupCriterionServiceInterface>

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

public final class AdGroupCriterionDelegate
extends AbstractGetMutateDelegate<com.google.api.ads.adwords.axis.v201409.cm.AdGroupCriterion,com.google.api.ads.adwords.axis.v201409.cm.AdGroupCriterionOperation,com.google.api.ads.adwords.axis.v201409.cm.AdGroupCriterionServiceInterface>

Specific AbstractGetMutateDelegate for AdGroupCriterion.

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
AdGroupCriterionDelegate(AdWordsSession adWordsSession, boolean includeBetaFields) Default Constructor.
AdGroupCriterionDelegate(AdWordsSession adWordsSession, List<SelectorFields.AdGroupCriterion> selectorFields) Constructor with custom fields.

Method Summary

Methods

Modifier and Type	Method and Description
List<com.google.api.ads.adwords.axis.v201409.cm.AdGroupCriterion>	getByAdGroupId(List<Long> adGroupIds) Retrieves AdGroupCriterions by adGroupIds.
List<com.google.api.ads.adwords.axis.v201409.cm.AdGroupCriterion>	getByAdGroupId(Long adGroupId) Retrieves AdGroupCriterions by adGroupId.
List<com.google.api.ads.adwords.axis.v201409.cm.AdGroupCriterion>	getByAdGroupId(Long adGroupId, int startIndex, int numberResults) Retrieves AdGroupCriterions by adGroupId in the range (startIndex, numberResults).
List<com.google.api.ads.adwords.axis.v201409.cm.AdGroupCriterion>	getByAdGroupIdCriterionId(Long adGroupId, Long criterionId) Retrieves AdGroupCriterions by adGroupId and criterionId (criterionId is not unique by itself).
List<com.google.api.ads.adwords.axis.v201409.cm.AdGroupCriterion>	getByAdGroupIdCriterionType(Long adGroupId, com.google.api.ads.adwords.axis.v201409.cm.CriterionType criterionType) Retrieves AdGroupCriterions by adGroupId and CriterionType.
List<com.google.api.ads.adwords.axis.v201409.cm.AdGroupCriterion>	getByAdGroupIdCriterionUse(Long adGroupId, com.google.api.ads.adwords.axis.v201409.cm.CriterionUse criterionUse) Retrieves AdGroupCriterions by adGroupId and CriterionUse.
List<com.google.api.ads.adwords.axis.v201409.cm.AdGroupCriterion>	getByAdGroupIdCriterionUseCriterionType(Long adGroupId, com.google.api.ads.adwords.axis.v201409.cm.CriterionUse criterionUse, com.google.api.ads.adwords.axis.v201409.cm.CriterionType criterionType) Retrieves AdGroupCriterions by CriterionUse and CriterionType.
List<com.google.api.ads.adwords.axis.v201409.cm.AdGroupCriterion>	getByCriterionType(com.google.api.ads.adwords.axis.v201409.cm.CriterionType criterionType) Retrieves AdGroupCriterions by CriterionType.
List<com.google.api.ads.adwords.axis.v201409.cm.AdGroupCriterion>	getByCriterionUse(com.google.api.ads.adwords.axis.v201409.cm.CriterionUse criterionUse) Retrieves AdGroupCriterions by CriterionUse.
List<com.google.api.ads.adwords.axis.v201409.cm.AdGroupCriterion>	getByCriterionUseCriterionType(com.google.api.ads.adwords.axis.v201409.cm.CriterionUse criterionUse, com.google.api.ads.adwords.axis.v201409.cm.CriterionType criterionType) Retrieves AdGroupCriterions by CriterionUse and CriterionType.
List<com.google.api.ads.adwords.axis.v201409.cm.AdGroupCriterion>	getByLabelIds(List<Long> labelIds) Retrieves AdGroupCriterions by labelIds.
com.google.api.ads.adwords.axis.v201409.cm.AdGroupCriterionLabel	insertAdGroupCriterionLabel(com.google.api.ads.adwords.axis.v201409.cm.AdGroupCriterionLabel adGroupCriterionLabel) Creates a link (AdGroupCriterionLabel) between AdGroupCriterions and Labels.
List<com.google.api.ads.adwords.axis.v201409.cm.AdGroupCriterionLabel>	insertAdGroupCriterionLabel(List<com.google.api.ads.adwords.axis.v201409.cm.AdGroupCriterionLabel> adGroupCriterionLabels) Creates a link (AdGroupCriterionLabel) between AdGroupCriterions and Labels.
com.google.api.ads.adwords.axis.v201409.cm.AdGroupCriterionLabel	removeAdGroupCriterionLabel(com.google.api.ads.adwords.axis.v201409.cm.AdGroupCriterionLabel adGroupCriterionLabel) Removes a link (AdGroupCriterionLabel) between AdGroupCriterions and Labels.
List<com.google.api.ads.adwords.axis.v201409.cm.AdGroupCriterionLabel>	removeAdGroupCriterionLabel(List<com.google.api.ads.adwords.axis.v201409.cm.AdGroupCriterionLabel> adGroupCriterionLabels) Removes a link (AdGroupCriterionLabel) between AdGroupCriterions 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

AdGroupCriterionDelegate

public AdGroupCriterionDelegate(AdWordsSession adWordsSession,
                        boolean includeBetaFields)

Default Constructor.

Parameters:

adWordsSession - the adWordsSession to use with the delegate/service

AdGroupCriterionDelegate

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

getByAdGroupIdCriterionId

public List<com.google.api.ads.adwords.axis.v201409.cm.AdGroupCriterion> getByAdGroupIdCriterionId(Long adGroupId,
                                                                                          Long criterionId)
                                                                                            throws RemoteException

Retrieves AdGroupCriterions by adGroupId and criterionId (criterionId is not unique by itself).

Parameters:

adGroupId - the Id of the AdGroup

criterionId - the Id of the Criterion

Returns:

a list of AdGroupCriterions matching the adGroupId and adGroupId

Throws:

RemoteException - for communication-related exceptions

getByAdGroupId

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

Retrieves AdGroupCriterions by adGroupIds.

Parameters:

adGroupIds - the Ids of the AdGroup

Returns:

a list of AdGroupCriterions matching adGroupIds

Throws:

RemoteException - for communication-related exceptions

getByAdGroupId

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

Retrieves AdGroupCriterions by adGroupId.

Parameters:

adGroupId - the Id of the AdGroup

Returns:

a list of AdGroupCriterions matching the adGroupId

Throws:

RemoteException - for communication-related exceptions

getByAdGroupId

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

Retrieves AdGroupCriterions by adGroupId in the range (startIndex, numberResults).

Parameters:

adGroupId - the Id of the AdGroup

startIndex - index of the first result

numberResults - number of results

Returns:

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

Throws:

RemoteException - for communication-related exceptions

getByCriterionUse

public List<com.google.api.ads.adwords.axis.v201409.cm.AdGroupCriterion> getByCriterionUse(com.google.api.ads.adwords.axis.v201409.cm.CriterionUse criterionUse)
                                                                                    throws RemoteException

Retrieves AdGroupCriterions by CriterionUse.

Parameters:

criterionUse - CriterionUse

Returns:

a list of AdGroupCriterions matching the criterionUse

Throws:

RemoteException - for communication-related exceptions

getByCriterionType

public List<com.google.api.ads.adwords.axis.v201409.cm.AdGroupCriterion> getByCriterionType(com.google.api.ads.adwords.axis.v201409.cm.CriterionType criterionType)
                                                                                     throws RemoteException

Retrieves AdGroupCriterions by CriterionType.

Parameters:

criterionType - CriterionType

Returns:

a list of AdGroupCriterions matching the criterionType

Throws:

RemoteException - for communication-related exceptions

getByCriterionUseCriterionType

public List<com.google.api.ads.adwords.axis.v201409.cm.AdGroupCriterion> getByCriterionUseCriterionType(com.google.api.ads.adwords.axis.v201409.cm.CriterionUse criterionUse,
                                                                                               com.google.api.ads.adwords.axis.v201409.cm.CriterionType criterionType)
                                                                                                 throws RemoteException

Retrieves AdGroupCriterions by CriterionUse and CriterionType.

Parameters:

criterionUse - CriterionUse

criterionType - CriterionType

Returns:

a list of AdGroupCriterions matching the criterionUse and criterionType

Throws:

RemoteException - for communication-related exceptions

getByAdGroupIdCriterionUse

public List<com.google.api.ads.adwords.axis.v201409.cm.AdGroupCriterion> getByAdGroupIdCriterionUse(Long adGroupId,
                                                                                           com.google.api.ads.adwords.axis.v201409.cm.CriterionUse criterionUse)
                                                                                             throws RemoteException

Retrieves AdGroupCriterions by adGroupId and CriterionUse.

Parameters:

adGroupId - the Id of the AdGroup

criterionUse - CriterionUse

Returns:

a list of AdGroupCriterions matching the adGroupId and criterionUse

Throws:

RemoteException - for communication-related exceptions

getByAdGroupIdCriterionType

public List<com.google.api.ads.adwords.axis.v201409.cm.AdGroupCriterion> getByAdGroupIdCriterionType(Long adGroupId,
                                                                                            com.google.api.ads.adwords.axis.v201409.cm.CriterionType criterionType)
                                                                                              throws RemoteException

Retrieves AdGroupCriterions by adGroupId and CriterionType.

Parameters:

adGroupId - the Id of the AdGroup

criterionType - CriterionType

Returns:

a list of AdGroupCriterions matching the adGroupId and criterionType

Throws:

RemoteException - for communication-related exceptions

getByAdGroupIdCriterionUseCriterionType

public List<com.google.api.ads.adwords.axis.v201409.cm.AdGroupCriterion> getByAdGroupIdCriterionUseCriterionType(Long adGroupId,
                                                                                                        com.google.api.ads.adwords.axis.v201409.cm.CriterionUse criterionUse,
                                                                                                        com.google.api.ads.adwords.axis.v201409.cm.CriterionType criterionType)
                                                                                                          throws RemoteException

Retrieves AdGroupCriterions by CriterionUse and CriterionType.

Parameters:

adGroupId - the Id of the AdGroup

criterionUse - CriterionUse

criterionType - CriterionType

Returns:

a list of AdGroupCriterions matching the adGroupId, criterionUse and criterionType

Throws:

RemoteException - for communication-related exceptions

getByLabelIds

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

Retrieves AdGroupCriterions by labelIds.

Parameters:

labelIds - the Id of the Labels to retrieve the AdGroupCriterions

Returns:

a list of AdGroupCriterions matching labelIds

Throws:

RemoteException - for communication-related exceptions

insertAdGroupCriterionLabel

public List<com.google.api.ads.adwords.axis.v201409.cm.AdGroupCriterionLabel> insertAdGroupCriterionLabel(List<com.google.api.ads.adwords.axis.v201409.cm.AdGroupCriterionLabel> adGroupCriterionLabels)
                                                                                                   throws RemoteException

Creates a link (AdGroupCriterionLabel) between AdGroupCriterions and Labels.

Parameters:

adGroupCriterionLabels - the AdGroupCriterionLabels to add

Returns:

the AdGroupCriterionLabels added

Throws:

RemoteException - for communication-related exceptions

insertAdGroupCriterionLabel

public com.google.api.ads.adwords.axis.v201409.cm.AdGroupCriterionLabel insertAdGroupCriterionLabel(com.google.api.ads.adwords.axis.v201409.cm.AdGroupCriterionLabel adGroupCriterionLabel)
                                                                                             throws RemoteException

Creates a link (AdGroupCriterionLabel) between AdGroupCriterions and Labels.

Parameters:

adGroupCriterionLabel - the AdGroupCriterionLabel to add

Returns:

the AdGroupCriterionLabel added

Throws:

RemoteException - for communication-related exceptions

removeAdGroupCriterionLabel

public List<com.google.api.ads.adwords.axis.v201409.cm.AdGroupCriterionLabel> removeAdGroupCriterionLabel(List<com.google.api.ads.adwords.axis.v201409.cm.AdGroupCriterionLabel> adGroupCriterionLabels)
                                                                                                   throws RemoteException

Removes a link (AdGroupCriterionLabel) between AdGroupCriterions and Labels.

Parameters:

adGroupCriterionLabels - the AdGroupCriterionLabels to remove

Returns:

the AdGroupCriterionLabels removed

Throws:

RemoteException - for communication-related exceptions

removeAdGroupCriterionLabel

public com.google.api.ads.adwords.axis.v201409.cm.AdGroupCriterionLabel removeAdGroupCriterionLabel(com.google.api.ads.adwords.axis.v201409.cm.AdGroupCriterionLabel adGroupCriterionLabel)
                                                                                             throws RemoteException

Removes a link (AdGroupCriterionLabel) between AdGroupCriterions and Labels.

Parameters:

adGroupCriterionLabel - the AdGroupCriterionLabel to remove

Returns:

the AdGroupCriterionLabel removed

Throws:

RemoteException - for communication-related exceptions