AdsApp.​SharedExcludedPlacementSelector

Fetches shared excluded placements. Supports filtering and sorting.

Typical usage:

 var sharedExcludedPlacementSelector = excludedPlacementList.excludedPlacements()
     .withCondition("PlacementUrl CONTAINS 'test'")
     .withLimit(1)
     .withIds([10,20])
     .orderBy("SharedSetId DESC");

 var sharedExcludedPlacementIterator = sharedExcludedPlacementSelector.get();

 while (sharedExcludedPlacementIterator.hasNext()) {
   var sharedExcludedPlacement = sharedExcludedPlacementIterator.next();
 }

Methods:

MemberTypeDescription
get AdsApp.SharedExcludedPlacementIterator Fetches the requested shared excluded placements and returns an iterator.
orderBy AdsApp.SharedExcludedPlacementSelector Specifies the ordering of the resulting entities.
withCondition AdsApp.SharedExcludedPlacementSelector Adds the specified condition to the selector in order to narrow down the results.
withLimit AdsApp.SharedExcludedPlacementSelector Specifies limit for the selector to use.

get()

Fetches the requested shared excluded placements and returns an iterator.

Return values:

TypeDescription
AdsApp.SharedExcludedPlacementIterator Iterator of the requested shared excluded placements.

orderBy(orderBy)

Specifies the ordering of the resulting entities. orderBy parameter can have one of the following forms:
  • orderBy("shared_criterion.keyword.text") - orders results by keyword text, in ascending order.
  • orderBy("shared_criterion.shared_set ASC") - orders results by shared set resource name, in ascending order.
  • orderBy("shared_criterion.criterion_id DESC") - orders results by criterion id, in descending order.

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

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

 sharedExcludedPlacementSelector = sharedExcludedPlacementselector
     .orderBy("shared_criterion.criterion_id DESC");

The results will be ordered by shared_criterion.criterion_id in descending order.

Arguments:

NameTypeDescription
orderBy String Ordering to apply.

Return values:

TypeDescription
AdsApp.SharedExcludedPlacementSelector 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:

 sharedExcludedPlacementSelector = sharedExcludedPlacementSelector
     .withCondition("shared_set.id > 5")
     .withCondition("shared_set.name CONTAINS 'brand'");
All specified conditions are AND-ed together. The above example will retrieve shared excluded placements that have a Shared Set Id greater than 5 and contains "brand" in its name.

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 Long columns (e.g. shared_set.id):
    <  <=  >  >=  =  !=
  • For String columns (e.g. shared_set.name):
    =  !=  (NOT) (LIKE | CONTAINS | REGEXP_MATCH)
Conditions using IN, NOT IN, CONTAINS ALL, CONTAINS ANY and CONTAINS NONE operators look as follows:
 withCondition("shared_set.name IN (Value1, Value2)")

Columns

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

Column Type Example
Shared Set Criterion Attributes
shared_criterion.criterion_id Long withCondition("shared_criterion.criterion_id = 5")
shared_criterion.shared_set Long withCondition("shared_criterion.shared_set = 'customers/1234567890/shared_sets/123'"). The value is a shared set resource name.
PlacementUrl String withCondition("PlacementUrl CONTAINS 'test'")

Arguments:

NameTypeDescription
condition String Condition to add to the selector.

Return values:

TypeDescription
AdsApp.SharedExcludedPlacementSelector 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
AdsApp.SharedExcludedPlacementSelector The selector with limit applied.