AdsApp.​SharedExcludedPlacementSelector

AI-generated Key Takeaways

outlined_flag

• SharedExcludedPlacementSelector fetches shared excluded placements and supports filtering and sorting.

• The get() method retrieves the requested shared excluded placements and provides an iterator to go through them.

• The orderBy() method allows specifying the order of the resulting entities.

• The withCondition() method adds conditions to narrow down the results using specific column names and operators.

• The withLimit() method sets a limit on the number of entities to return.

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:

get()

Return values:

orderBy(orderBy)

• 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:

Return values:

withCondition(condition)

Multiple conditions may be added to the same selector:

sharedExcludedPlacementSelector = sharedExcludedPlacementSelector
    .withCondition("shared_set.id > 5")
    .withCondition("shared_set.name CONTAINS 'brand'");

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

"COLUMN_NAME OPERATOR VALUE"

Operators

• For Long columns (e.g. shared_set.id):

  <  <=  >  >=  =  !=

• For String columns (e.g. shared_set.name):

  =  !=  (NOT) (LIKE | CONTAINS | REGEXP_MATCH)

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).

Arguments:

Return values:

withLimit(limit)

Arguments:

Return values: