Method: users.list

Mencantumkan pengguna yang dapat diakses oleh pengguna saat ini. Jika dua pengguna memiliki peran pengguna di partner atau pengiklan yang sama, mereka dapat saling mengakses.

Metode ini memiliki persyaratan autentikasi yang unik. Baca prasyarat di panduan Mengelola Pengguna sebelum menggunakan metode ini.

Fitur "Coba metode ini" tidak berfungsi untuk metode ini.

Permintaan HTTP

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

URL menggunakan sintaksis gRPC Transcoding.

Parameter kueri

Parameter
pageSize

integer

Ukuran halaman yang diminta. Harus antara 1 dan 200. Jika tidak ditentukan, nilai defaultnya adalah 100.
pageToken

string

Token yang mengidentifikasi halaman hasil yang harus ditampilkan server. Biasanya, ini adalah nilai nextPageToken yang ditampilkan dari panggilan sebelumnya ke metode users.list. Jika tidak ditentukan, halaman pertama hasil akan ditampilkan.
orderBy

string

Kolom yang akan digunakan untuk mengurutkan daftar. Nilai yang dapat diterima adalah:

  • displayName (default)

Urutan pengurutan default adalah menaik. Untuk menentukan urutan menurun untuk kolom, akhiran "desc" harus ditambahkan ke nama kolom. Misalnya, displayName desc.
filter

string

Memungkinkan pemfilteran berdasarkan kolom pengguna.

Sintaksis yang didukung:

  • Ekspresi filter terdiri dari satu atau beberapa batasan.
  • Batasan dapat digabungkan oleh operator logis AND.
  • Batasan memiliki bentuk {field} {operator} {value}.
  • Kolom displayName dan email harus menggunakan operator HAS (:).
  • Kolom lastLoginTime harus menggunakan operator LESS THAN OR EQUAL TO (<=) atau GREATER THAN OR EQUAL TO (>=).
  • Semua kolom lainnya harus menggunakan operator EQUALS (=).

Kolom yang didukung:

  • assignedUserRole.advertiserId
  • assignedUserRole.entityType: Ini adalah kolom sintetis AssignedUserRole yang digunakan untuk pemfilteran. Mengidentifikasi jenis entitas tempat peran pengguna ditetapkan. Nilai yang valid adalah Partner dan Advertiser.
  • assignedUserRole.parentPartnerId: Ini adalah kolom sintetis AssignedUserRole yang digunakan untuk pemfilteran. Mengidentifikasi partner induk entitas tempat peran pengguna ditetapkan.
  • assignedUserRole.partnerId
  • assignedUserRole.userRole
  • displayName
  • email
  • lastLoginTime (input dalam format ISO 8601, atau YYYY-MM-DDTHH:MM:SSZ)

Contoh:

  • Pengguna dengan displayName yang berisi "foo": displayName:"foo"
  • Pengguna dengan email yang berisi "bar": email:"bar"
  • Semua pengguna dengan peran pengguna standar: assignedUserRole.userRole="STANDARD"
  • Semua pengguna dengan peran pengguna untuk partner 123: assignedUserRole.partnerId="123"
  • Semua pengguna dengan peran pengguna untuk pengiklan 123: assignedUserRole.advertiserId="123"
  • Semua pengguna dengan peran pengguna tingkat partner: entityType="PARTNER"
  • Semua pengguna dengan peran pengguna untuk partner 123 dan pengiklan di bawah partner 123: parentPartnerId="123"
  • Semua pengguna yang terakhir kali login pada atau setelah 01-01-2023T00:00:00Z (format ISO 8601): lastLoginTime>="2023-01-01T00:00:00Z"

Panjang kolom ini tidak boleh lebih dari 500 karakter.

Lihat panduan memfilter permintaan LIST untuk mengetahui informasi selengkapnya.

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "users": [
    {
      object (User)
    }
  ],
  "nextPageToken": string
}
Kolom
users[]

object (User)

Daftar pengguna.

Daftar ini tidak akan ada jika kosong.
nextPageToken

string

Token untuk mengambil halaman hasil berikutnya. Teruskan nilai ini di kolom pageToken dalam panggilan berikutnya ke metode users.list untuk mengambil halaman hasil berikutnya. Token ini tidak akan ada jika tidak ada lagi hasil yang dapat ditampilkan.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

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

Untuk informasi selengkapnya, lihat Ringkasan OAuth 2.0.