Method: users.list

現在のユーザーがアクセスできるユーザーを一覧表示します。2 人のユーザーが同じパートナーまたは広告主のユーザー役割を持っている場合は、互いにアクセスできます。

この方法では、独自の認証要件があります。この方法を使用する前に、ユーザー管理ガイドの前提条件をお読みください。

この方法では「この方法を試す」機能を使用できません。

HTTP リクエスト

GET https://displayvideo.googleapis.com/v2/users

この URL は gRPC Transcoding 構文を使用します。

クエリ パラメータ

パラメータ
pageSize

integer

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

string

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

string

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

  • displayName（デフォルト）

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

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 での入力）

例:

  • 「foo」を含む displayName を持つユーザー: 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 リクエストのフィルタに関するガイドをご覧ください。

リクエスト本文

リクエストの本文は空にする必要があります。

レスポンスの本文

成功すると、レスポンスの本文に次の構造のデータが含まれます。

JSON 表現 
{
  "users": [
    {
      object (User)
    }
  ],
  "nextPageToken": string
}
フィールド
users[]

object (User)

ユーザーのリスト。

空の場合、このリストは存在しません。
nextPageToken

string

結果の次のページを取得するためのトークン。 結果の次のページを取得するには、後続の users.list メソッドの呼び出しで、この値を pageToken フィールドに渡します。返す結果がない場合、このトークンは存在しません。

承認スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/display-video-user-management

詳細については、OAuth 2.0 の概要をご覧ください。