UserListSelector

アカウント内のユーザー リストの一覧をフィルター処理および順序付けするためのメソッドが含まれています。 セレクターの詳細については、「 セレクター」を参照してください。

メソッド

取得

ユーザー リストの一覧を反復処理するために使用される 反復子 を取得します。

戻り値

orderBy(string orderBy)

選択したユーザー リストに指定した順序を適用します。

"columnName orderDirection" という形式で orderBy パラメーターを指定します。

• columnName は、[サポートされている列](#supported-user list-columns) のいずれかです。
• orderDirection は、結果を並べ替える順序です。 結果を昇順に並べ替える場合は ASC に、結果を降順に並べ替える場合は DESC に設定します。 既定値は ASC です。

たとえば、次の呼び出しでは、結果がユーザー リストの名前の昇順で返されます。

selector = selector.orderBy("Name");

セレクターでは、1 つのフィールドによるエンティティの並べ替えのみがサポートされます。 フィールド x、x 内のエンティティの一覧をフィールド y ごとに並べ替えすることはできません。 チェーンまたは個別のセレクター呼び出しで複数 orderBy() の呼び出しを指定した場合、スクリプトは最後 orderBy() の呼び出しで指定されたフィールドを使用してエンティティの一覧を並べ替えます。 

引数

戻り値

withCondition(String condition)

ユーザー リストにフィルター条件を適用します。

"columnName 演算子値" という形式で condition パラメーターを指定します。

• columnName は、[サポートされている列](#supported-user list-columns) のいずれかです。
• operator は、サポートされている演算子の 1 つです。

演算子

使用する演算子は、列の型によって異なります。 演算子では大文字と小文字が区別されます。 たとえば、starts_withの代わりに STARTS_WITH を使用します。

整数と長い値を含む列の演算子:

<
<=
>
>=
=
!=

二重値を含む列の演算子:

<
>

文字列値を含む列の演算子:

=
!=
STARTS_WITH
STARTS_WITH_IGNORE_CASE
CONTAINS
CONTAINS_IGNORE_CASE
DOES_NOT_CONTAIN
DOES_NOT_CONTAIN_IGNORE_CASE

列挙値を含む列の演算子:

=
!=
IN []
NOT_IN []

文字列の配列を含む列の演算子:

CONTAINS_ALL
CONTAINS_ANY
CONTAINS_NONE

ユーザー リストのフィルター処理でサポートされている列。 列名は大文字と小文字を区別します。

引数

戻り値

withIds(string[] ids)

指定した ID を持つユーザー リストを取得します。

セレクターに 1 つ以上の条件を適用できます。 条件のチェーンは AND 演算と見なされます。 たとえば、条件 A が true の場合にのみエンティティが選択され、条件 B が true です。 たとえば、次の呼び出しでは、ユーザー リスト 33333 のみが選択されます。

AdsApp.userLists()
    .withIds(['11111', '22222', '33333'])
    .withIds(['33333', '44444', '55555']);

引数

戻り値

withLimit(int limit)

選択条件に一致する上位 n 個のユーザー リストを取得します。

引数

戻り値

関連項目

• UserListIterator
• UserList