Method: users.list

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

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

この方法では、「Try this method」機能は動作しません。

HTTP リクエスト

GET https://displayvideo.googleapis.com/v1/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} です。
  • budget.budget_segments.date_range.end_date フィールドでは LESS THAN (<) 演算子を使用する必要があります。
  • displayName andemailfield must use theHAS（:）演算子。
  • 他のすべてのフィールドでは EQUALS (=) 演算子を使用する必要があります。

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

  • assignedUserRole.advertiserId
  • assignedUserRole.entityType
  • これはフィルタリングに使用される AssignedUserRole の合成フィールドです。ユーザー役割が割り当てられているエンティティのタイプを示します。有効な値は Partner と Advertiser です。
  • assignedUserRole.parentPartnerId
  • これは、フィルタリングに使用される AssignedUserRole の合成フィールドです。ユーザー役割が割り当てられているエンティティの親パートナーを指定します。
  • assignedUserRole.partnerId
  • assignedUserRole.userRole
  • displayName
  • email

例:

  • 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"

このフィールドの長さは 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 の概要をご覧ください。