Method: users.list

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

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

[Try this method]このメソッドでは動作しません。

HTTP リクエスト

GET https://displayvideo.googleapis.com/v3/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 で入力）

例:

  • displayName に「foo」が含まれているユーザー: 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 の概要をご覧ください。