Method: people.listDirectoryPeople

Menyediakan daftar profil domain dan kontak domain di direktori domain pengguna yang diautentikasi.

Saat syncToken ditentukan, resource yang dihapus sejak sinkronisasi terakhir akan ditampilkan sebagai pengguna dengan PersonMetadata.deleted disetel ke benar (true).

Saat pageToken atau syncToken ditentukan, semua parameter permintaan lainnya harus cocok dengan panggilan pertama.

Operasi tulis mungkin mengalami penundaan penerapan selama beberapa menit untuk permintaan sinkronisasi. Sinkronisasi inkremental tidak dimaksudkan untuk kasus penggunaan baca setelah tulis.

Lihat contoh penggunaan di Menampilkan daftar direktori yang telah diubah.

Permintaan HTTP

GET https://people.googleapis.com/v1/people:listDirectoryPeople

URL menggunakan sintaksis gRPC Transcoding.

Parameter kueri

Parameter
readMask

string (FieldMask format)

Wajib. Mask kolom untuk membatasi kolom mana pada setiap orang yang ditampilkan. Beberapa kolom dapat ditentukan dengan memisahkannya menggunakan koma. Nilai yang valid adalah:

  • addresses
  • ageRanges
  • biografi
  • ulang tahun
  • calendarUrls
  • clientData
  • coverPhotos
  • emailAddresses
  • acara
  • externalIds
  • gender
  • imClients
  • minat
  • locales
  • lokasi
  • channel
  • metadata
  • miscKeywords
  • names
  • nama panggilan
  • pekerjaan
  • organizations
  • phoneNumbers
  • foto
  • relasi
  • sipAddresses
  • keterampilan
  • urls
  • userDefined
sources[]

enum (DirectorySourceType)

Wajib. Sumber direktori yang akan ditampilkan.
mergeSources[]

enum (DirectoryMergeSourceType)

Opsional. Data tambahan untuk digabungkan ke dalam sumber direktori jika terhubung melalui kunci gabungan terverifikasi seperti alamat email atau nomor telepon.
pageSize

integer

Opsional. Jumlah orang yang akan disertakan dalam respons. Nilai yang valid adalah antara 1 dan 1000, inklusif. Jika tidak disetel atau disetel ke 0, defaultnya adalah 100.
pageToken

string

Opsional. Token halaman, diterima dari respons sebelumnya nextPageToken. Berikan ini untuk mengambil halaman berikutnya.

Saat melakukan penomoran halaman, semua parameter lain yang disediakan ke people.listDirectoryPeople harus cocok dengan panggilan pertama yang menyediakan token halaman.
requestSyncToken

boolean

Opsional. Apakah respons harus menampilkan nextSyncToken. Class ini dapat digunakan untuk mendapatkan perubahan inkremental sejak permintaan terakhir dengan menyetelnya pada permintaan syncToken.

Detail selengkapnya tentang perilaku sinkronisasi di people.listDirectoryPeople.
syncToken

string

Opsional. Token sinkronisasi, diterima dari respons sebelumnya nextSyncToken Berikan ini untuk mengambil resource yang diubah sejak permintaan terakhir.

Saat menyinkronkan, semua parameter lain yang disediakan ke people.listDirectoryPeople harus cocok dengan panggilan pertama yang menyediakan token sinkronisasi.

Detail selengkapnya tentang perilaku sinkronisasi di people.listDirectoryPeople.

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Respons terhadap permintaan direktori domain pengguna yang diautentikasi.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "people": [
    {
      object (Person)
    }
  ],
  "nextPageToken": string,
  "nextSyncToken": string
}
Kolom
people[]

object (Person)

Daftar orang di direktori domain.
nextPageToken

string

Token, yang dapat dikirim sebagai pageToken untuk mengambil halaman berikutnya. Jika kolom ini dihilangkan, tidak akan ada halaman berikutnya.
nextSyncToken

string

Token yang dapat dikirim sebagai syncToken untuk mengambil perubahan sejak permintaan terakhir. Permintaan harus menetapkan requestSyncToken untuk menampilkan token sinkronisasi.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut ini:

  • https://www.googleapis.com/auth/directory.readonly

Untuk informasi selengkapnya, lihat Panduan otorisasi.