AdsApp.​SharedNegativeKeywordSelector

AI-generated Key Takeaways

outlined_flag

• SharedNegativeKeywordSelector fetches shared negative keywords and supports filtering and sorting.

• The get() method fetches the shared negative keywords and returns an iterator.

• The orderBy() method specifies the order of the results.

• The withCondition() method adds conditions to narrow down the results.

• The withLimit() method specifies the maximum number of entities to return.

Typical usage:

var sharedNegativeKeywordSelector = negativeKeywordList.negativeKeywords()
    .withCondition("shared_criterion.keyword.text REGEXP_MATCH 'test.*'")
    .withLimit(1)
    .withIds([10,20])
    .orderBy("shared_criterion.shared_set DESC");

var sharedNegativeKeywordIterator = sharedNegativeKeywordSelector.get();

while (sharedNegativeKeywordIterator.hasNext()) {
  var sharedNegativeKeyword = sharedNegativeKeywordIterator.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 SharedNegativeKeywordSelector.withCondition(String) for enumeration of columns that can be used.

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

sharedNegativeKeywordSelector = sharedNegativeKeywordselector
    .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:

sharedNegativeKeywordSelector = sharedNegativeKeywordSelector
    .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: