AdWordsApp.​SearchAdGroupExcludedAudienceSelector

Fetches excluded audiences. Supports filtering and sorting.

Typical usage:

 var adGroup = AdWordsApp.adGroups().get().next();
 var excludedAudienceSelector = adGroup.targeting().excludedAudiences();

 var excludedAudienceIterator = excludedAudienceSelector.get();
 while (excludedAudienceIterator.hasNext()) {
   var excludedAudience = excludedAudienceIterator.next();
 }
Related:

Methods:

MemberTypeDescription
get AdWordsApp.SearchAdGroupExcludedAudienceIterator Fetches the requested excluded audiences and returns an iterator.
orderBy AdWordsApp.SearchAdGroupExcludedAudienceSelector Specifies the ordering of the resulting entities.
withCondition AdWordsApp.SearchAdGroupExcludedAudienceSelector Adds the specified condition to the selector in order to narrow down the results.
withLimit AdWordsApp.SearchAdGroupExcludedAudienceSelector Specifies limit for the selector to use.

get()

Fetches the requested excluded audiences and returns an iterator.

Return values:

TypeDescription
AdWordsApp.SearchAdGroupExcludedAudienceIterator Iterator of the requested excluded audiences.

orderBy(orderBy)

Specifies the ordering of the resulting entities. orderBy parameter can have one of the following forms:
  • orderBy("AdGroupName") - orders results by AdGroupName, in ascending order.
  • orderBy("AdGroupName ASC") - orders results by AdGroupName, in ascending order.
  • orderBy("AdGroupName DESC") - orders results by AdGroupName, in descending order.

See SearchAdGroupExcludedAudienceSelector.withCondition(String) for enumeration of columns that can be used.

orderBy() may be called multiple times. Consider the following example:

 selector = selector.
     .orderBy("CampaignName")
     .orderBy("AdGroupName");

The results will be ordered by CampaignName in ascending order. Results with equal CampaignName value will be ordered by AdGroupName in ascending order.

Arguments:

NameTypeDescription
orderBy String Ordering to apply.

Return values:

TypeDescription
AdWordsApp.SearchAdGroupExcludedAudienceSelector The selector with ordering applied.

withCondition(condition)

Adds the specified condition to the selector in order to narrow down the results.

Multiple conditions may be added to the same selector:

 selector = selector
     .withCondition("AdGroupName STARTS_WITH 'a'")
     .withCondition("CampaignName = 'Campaign 1'");
All specified conditions are AND-ed together. The above example will retrieve excluded audiences of type USER_LIST whose ad group name starts with 'a' and are in Campaign 1.

The parameter to be passed into this method must be of the following form:

 "COLUMN_NAME OPERATOR VALUE"

Operators

The operator that can be used in a condition depends on the type of column.
  • For String columns (e.g. AdGroupName):
    =  !=  STARTS_WITH  STARTS_WITH_IGNORE_CASE  CONTAINS
     CONTAINS_IGNORE_CASE  DOES_NOT_CONTAIN  DOES_NOT_CONTAIN_IGNORE_CASE
  • For Enumeration columns (ones that can only take one value from a pre-defined list, such as AdGroupStatus):
    =  !=  IN []  NOT_IN []
Conditions using IN, NOT_IN, CONTAINS_ALL, CONTAINS_ANY and CONTAINS_NONE operators look as follows:
 withCondition("KeywordMatchType IN [Value1, Value2]")
Operators are case-sensitive: starts_with won't work.

Columns

All column names are case-sensitive, and so are all values of enumerated columns (such as AdGroupStatus)

Column Type Example
Excluded audience attributes
AdGroupName String withCondition("AdGroupName CONTAINS_IGNORE_CASE 'shoes'")
AdGroupStatus Enumeration: ENABLED, PAUSED, REMOVED withCondition("AdGroupStatus = ENABLED"). Use to fetch excluded audiences from only ENABLED ad groups.
CampaignName String withCondition("CampaignName CONTAINS_IGNORE_CASE 'promotion'")
CampaignStatus Enumeration: ENABLED, PAUSED, REMOVED withCondition("CampaignStatus = ENABLED"). Use to fetch excluded audiences from only ENABLED campaigns.

Arguments:

NameTypeDescription
condition String Condition to add to the selector.

Return values:

TypeDescription
AdWordsApp.SearchAdGroupExcludedAudienceSelector The selector with the condition applied.

withLimit(limit)

Specifies limit for the selector to use. For instance, withLimit(50) returns only the first 50 entities.

Arguments:

NameTypeDescription
limit int How many entities to return.

Return values:

TypeDescription
AdWordsApp.SearchAdGroupExcludedAudienceSelector The selector with limit applied.

Оставить отзыв о...

Текущей странице
AdWords Scripts
AdWords Scripts
Нужна помощь? Обратитесь в службу поддержки.