Fetches excluded audiences. Supports filtering and sorting.
Typical usage:
var adGroup = AdsApp.adGroups().get().next();
var excludedAudienceSelector = adGroup.display().excludedAudiences();
var excludedAudienceIterator = excludedAudienceSelector.get();
while (excludedAudienceIterator.hasNext()) {
var excludedAudience = excludedAudienceIterator.next();
}
Related:
Methods:
get()
Fetches the requested excluded audiences and returns an iterator.
Return values:
orderBy(orderBy)
Specifies the ordering of the resulting entities.
orderBy parameter can have one of the
following forms:
orderBy("UserListName") - orders results by UserListName, in ascending order.
orderBy("UserListName ASC") - orders results by UserListName, in ascending order.
orderBy("UserListName DESC") - orders results by UserListName, in descending
order.
See ExcludedAudienceSelector.withCondition(String) for enumeration of columns that can be used.
orderBy() may be called multiple times. Consider the following example:
selector = selector.
.orderBy("UserListName")
.orderBy("AdGroupName");
The results will be ordered by UserListName in ascending order. Results with equal
UserListName value will be ordered by AdGroupName in ascending order.
Arguments:
| Name | Type | Description |
|---|
| orderBy |
String |
Ordering to apply. |
Return values:
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("UserListName 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 that start 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. UserListName):
= != 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
|
| UserListName |
String |
withCondition("UserListName STARTS_WITH 'leather'") |
| 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:
| Name | Type | Description |
|---|
| condition |
String |
Condition to add to the selector. |
Return values:
withLimit(limit)
Specifies limit for the selector to use. For instance,
withLimit(50) returns only the
first 50 entities.
Arguments:
| Name | Type | Description |
|---|
| limit |
int |
How many entities to return. |
Return values:
