Method: users.list

integer

リクエストされたページサイズ。1～200 の範囲で指定してください。指定しない場合、デフォルトで 100 になります。

string

サーバーが返す必要がある結果のページを特定するトークン。通常、これは users.list メソッドの前の呼び出しから返された nextPageToken の値です。指定しない場合は、結果の最初のページが返されます。

string

リストの並べ替えに使用するフィールド。使用できる値は次のとおりです。

• displayName（デフォルト）

デフォルトの並べ替え順序は昇順です。フィールドに対して降順を指定するには、フィールド名に接尾辞「desc」を追加する必要があります。例: displayName desc

string

ユーザー フィールドでフィルタできます。

サポートされている構文:

• フィルタ式は、1 つ以上の制限で構成されます。
• 制限は論理演算子 AND で組み合わせることができます。
• 制限の形式は {field} {operator} {value} です。
• displayName フィールドと email フィールドでは、HAS (:) 演算子を使用する必要があります。
• lastLoginTime フィールドでは、LESS THAN OR EQUAL TO (<=) 演算子または GREATER THAN OR EQUAL TO (>=) 演算子のいずれかを使用する必要があります。
• 他のすべてのフィールドは EQUALS (=) 演算子を使用する必要があります。

サポートされているフィールド:

• assignedUserRole.advertiserId
• assignedUserRole.entityType: フィルタリングに使用される AssignedUserRole の合成フィールドです。ユーザーロールが割り当てられているエンティティのタイプを識別します。有効な値は Partner と Advertiser です。
• assignedUserRole.parentPartnerId: フィルタリングに使用される AssignedUserRole の合成フィールドです。ユーザーロールが割り当てられているエンティティの親パートナーを識別します。
• assignedUserRole.partnerId
• assignedUserRole.userRole
• displayName
• email
• lastLoginTime（ISO 8601 形式または YYYY-MM-DDTHH:MM:SSZ で入力）

例:

• displayName に「foo」を含むユーザー: displayName:"foo"
• 「bar」を含む email を持つユーザー: email:"bar"
• 標準ユーザーロールを持つすべてのユーザー: assignedUserRole.userRole="STANDARD"
• パートナー 123 のユーザーロールを持つすべてのユーザー: assignedUserRole.partnerId="123"
• 広告主 123 のユーザーロールを持つすべてのユーザー: assignedUserRole.advertiserId="123"
• パートナー レベルのユーザーロールを持つすべてのユーザー: entityType="PARTNER"
• パートナー 123 と、パートナー 123 の下の広告主のユーザー役割を持つすべてのユーザー: parentPartnerId="123"
• 2023-01-01T00:00:00Z（ISO 8601 形式）以降に最後にログインしたすべてのユーザー: lastLoginTime>="2023-01-01T00:00:00Z"

このフィールドの長さは 500 文字以下にする必要があります。

詳しくは、フィルタ LIST リクエストのガイドをご覧ください。