AdsApp.ExcludedTopicSelector
Stay organized with collections Save and categorize content based on your preferences.
Fetches excluded topics. Supports filtering and sorting.
Typical usage:
var adGroup = AdsApp.adGroups().get().next();
var excludedTopicSelector = adGroup.display().excludedTopics();
var excludedTopicIterator = excludedTopicSelector.get();
while (excludedTopicIterator.hasNext()) {
var excludedTopic = excludedTopicIterator.next();
}Related:
Methods:
get()
Fetches the requested excluded topics 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("ad_group.name") - orders results by ad_group.name, in ascending order.orderBy("ad_group.name ASC") - orders results by ad_group.name, in ascending order.orderBy("ad_group.name DESC") - orders results by ad_group.name, in descending order.
See ExcludedTopicSelector.withCondition(String) for enumeration of columns that can be used.
orderBy() may be called multiple times. Consider the following example:
selector = selector.
.orderBy("ad_group.name")
.orderBy("campaign.name");The results will be ordered by ad_group.name in ascending order. Results with equal ad_group.name value will be ordered by campaign.name 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("ad_group.status NOT IN [PAUSED]")
.withCondition("campaign.name = 'Campaign 1'");All specified conditions are
AND-ed together. The above example will retrieve excluded topics in Campaign 1 that are in ad groups that are not paused.
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. ad_group.name): = != (NOT) (LIKE | CONTAINS | REGEXP_MATCH)
- For
Enumeration columns (ones that can only take one value from a pre-defined list, such as ad_group.status): = != IN () NOT IN ()
Conditions using
IN,
NOT IN,
CONTAINS ALL,
CONTAINS ANY and
CONTAINS NONE operators look as follows:
withCondition("ad_group.status IN [ENABLED, PAUSED]")Columns
All column names are case-sensitive, and so are all values of enumerated columns (such as ad_group.status)
| Column | Type | Example |
|---|
| Excluded Topic attributes |
| ad_group.name | String | withCondition("ad_group.name REGEXP_MATCH '.*shoes.*'") |
| ad_group.status | Enumeration: ENABLED, PAUSED, REMOVED | withCondition("ad_group.status = ENABLED"). Use to fetch excluded topics from only ENABLED ad groups. |
| campaign.name | String | withCondition("campaign.name REGEXP_MATCH '.*promotion.*'") |
| campaign.status | Enumeration: ENABLED, PAUSED, REMOVED | withCondition("campaign.status = ENABLED"). Use to fetch excluded topics 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:
