Method: users.list

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

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

「このメソッドを試す」機能は、このメソッドでは機能しません。

HTTP リクエスト

GET https://displayvideo.googleapis.com/v5/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"
  • email に「bar」を含むユーザー: 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 Overview をご覧ください。