AdsApp.​UserListSelector

Stay organized with collections Save and categorize content based on your preferences.

Typical usage:

var userListSelector = AdsApp.userlists()
    .withCondition("metrics.impressions > 100")
    .orderBy("metrics.clicks DESC");

var userListIterator = userListSelector.get();
while (userListIterator.hasNext()) {
  var userList = userListIterator.next();
}

• UserListIterator
• UserList

Methods:

get()

Return values:

orderBy(orderBy)

• orderBy("user_list.membership_life_span") - orders results by user_list.membership_life_span, in ascending order.
• orderBy("user_list.size_for_search ASC") - orders results by user_list.size_for_search, in ascending order.
• orderBy("user_list.name DESC") - orders results by user_list.name, in descending order.

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

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

selector = selector.orderBy("user_list.name ASC")
    .orderBy("user_list.membership_life_span DESC");

The results will be ordered by user_list.name in ascending order. Results with equal user_list.name values will be ordered by user_list.membership_life_span in descending order.

Arguments:

Return values:

withCondition(condition)

Multiple conditions may be added to the same selector:

selector = selector.withCondition("user_list.membership_life_span > 30")
                   .withCondition("user_list.size_for_search > 1000");

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

"COLUMN_NAME OPERATOR VALUE"

Operators

• For Integer and Long columns (e.g. user_list.size_for_search):

  <  <=  >  >= =  !=

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

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

• For Enumeration columns (ones that can only take one value from a predefined list, such as user_list.status):

  =  !=  IN () NOT IN ()

withCondition("ColumnName IN (Value1, Value2)")

Columns

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

Arguments:

Return values:

withIds(ids)

var userListIds = ['12345', '23456', '34567'];
selector = selector.withIds(userListIds);

The resulting selector can be further refined by applying additional conditions to it. The ID-based condition will then be AND-ed together with all the other conditions, including any other ID-based conditions. So, for instance, the following selector:

AdsApp.userLists().userLists()
   .withIds(['12345', '23456', '34567'])
   .withIds(['34567', '45678', '56789']);

The selector can only support up to 10,000 IDs. If more than 10,000 IDs are specified, the corresponding get() call will fail with a runtime error.

Arguments:

Return values:

withLimit(limit)

Arguments:

Return values:

withResourceNames(resourceNames)

const userListResourceNames = [
  'customers/1234567890/userLists/111',
  'customers/1234567890/userLists/222',
  'customers/1234567890/userLists/333',
];
selector = selector.withResourceNames(userListResourceNames);

The resulting selector can be further refined by applying additional conditions to it. The resource name condition will then be AND-ed together with all the other conditions.

The selector can only support up to 10,000 resource names. If more than 10,000 resource names are specified, the corresponding get() call will fail with a runtime error.

Arguments:

Return values: