Fetches excluded placements. Supports filtering and sorting.
Typical usage:
var adGroup = AdsApp.adGroups().get().next();
var excludedPlacementSelector = adGroup.display().excludedPlacements();
var excludedPlacementIterator = excludedPlacementSelector.get();
while (excludedPlacementIterator.hasNext()) {
var excludedPlacement = excludedPlacementIterator.next();
}
Related:
Methods:
get()
Fetches the requested excluded placements 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("PlacementUrl") - orders results by PlacementUrl, in ascending order.
orderBy("PlacementUrl ASC") - orders results by PlacementUrl, in ascending order.
orderBy("PlacementUrl DESC") - orders results by PlacementUrl, in descending
order.
See ExcludedPlacementSelector.withCondition(String) for enumeration of columns that can be used.
orderBy() may be called multiple times. Consider the following example:
selector = selector.
.orderBy("PlacementUrl")
.orderBy("AdGroupName");
The results will be ordered by PlacementUrl in ascending order. Results with equal
PlacementUrl 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("PlacementUrl CONTAINS 'test'")
.withCondition("AdGroupStatus NOT_IN [PAUSED]");
All specified conditions are
AND-ed together. The above example will retrieve excluded
placements that contain 'test' and 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. PlacementUrl):
= != 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("AdGroupStatus 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 placement attributes
|
| PlacementUrl |
String |
withCondition("PlacementUrl CONTAINS 'test'") |
| AdGroupName |
String |
withCondition("AdGroupName CONTAINS_IGNORE_CASE 'shoes'") |
| AdGroupStatus |
Enumeration: ENABLED, PAUSED, REMOVED |
withCondition("AdGroupStatus = ENABLED"). Use to fetch excluded placements
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 placements
keywords 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:
