UserListSelector

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

メソッド

メソッド名 戻り値の型 説明
get UserListIterator ユーザー リストの反復処理に使用される反復子を取得します。
orderBy(string, orderBy) UserListSelector 選択したユーザー リストに指定された順序を適用します。
withCondition(string condition) UserListSelector ユーザー リストにフィルター条件を適用します。
withIds(string[], ids) UserListSelector 指定した ID のユーザー リストを取得します。
withLimit(int limit) UserListSelector 選択条件に一致する上位 n 個のユーザー リストを取得します。

get

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

戻り値

型 説明
UserListIterator 選択したユーザー リストを反復処理するために使用される反復子。

orderBy(string, orderBy)

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

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

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

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

selector = selector.orderBy("Name");

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

引数

名前 型 説明
orderBy string 適用する順序。

戻り値

型 説明
UserListSelector 順序が適用されたセレクター。

withCondition(String condition)

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

条件パラメーターを "columnName operator value" の形式で指定します。

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

演算子

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

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

<
<=
>
>=
=
!=

double 型の値を含む列の演算子:

<
>

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

=
!=
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

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

列 型 例
説明 string ユーザー リストの説明。

withCondition("Description = 'foo'")
MembershipLifeSpan int Microsoft 広告がこのユーザー リスト定義に一致するアクションをどの程度さかのぼって検索する必要がある時間 (日数)。

withCondition("MembershipLifeSpan > 10")
名前 string ユーザー リストの名前。

withCondition("Name = 'foo'")
SizeForAudienceNetwork long オーディエンス ネットワーク内のユーザー リストのサイズ。

withCondition("SizeForAudienceNetwork > 1000")
SizeForSearch long オーディエンス ネットワーク内のユーザー リストのサイズ。

withCondition("SizeForSearch > 1000")
型 string ユーザー リストの派生型。 大文字と小文字を区別できる値は次のとおりです。
  • カスタム
  • CUSTOMER_LIST
  • IN_MARKET
  • 論理
  • PRODUCT
  • RULE_BASED
  • 類似
この例では、顧客リストのみが返されます。

withCondition("Type = CUSTOMER_LIST")

引数

名前 型 説明
condition string セレクターに追加する条件。

戻り値

型 説明
UserListSelector 条件が適用されたセレクター。

withIds(string[], ids)

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

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

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

引数

名前 型 説明
ids string[] ユーザー リスト ID の配列。 制限については、「 スクリプト実行制限」を参照してください。

戻り値

型 説明
UserListSelector ID が適用されたセレクター。

withLimit(int limit)

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

引数

名前 型 説明
limit int 返されるユーザー リストの数。 実際の数は少ない場合があります。

戻り値

型 説明
UserListSelector 制限が適用されたセレクター。

関連項目

  • Last updated on