Method: people.listDirectoryPeople

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

Jika syncToken ditentukan, resource yang dihapus sejak sinkronisasi terakhir akan ditampilkan sebagai orang dengan PersonMetadata.deleted ditetapkan ke true.

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

Operasi tulis mungkin memiliki penundaan penyebaran beberapa menit untuk permintaan sinkronisasi. Sinkronisasi inkremental tidak ditujukan untuk kasus penggunaan baca-setelah-tulis.

Lihat contoh penggunaan di Mencantumkan direktori orang yang telah berubah.

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 dengan koma. Nilai yang valid adalah:

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

enum (DirectorySourceType)

Wajib. Sumber direktori yang akan ditampilkan.
mergeSources[]

enum (DirectoryMergeSourceType)

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

integer

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

string

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

Saat melakukan penomoran halaman, semua parameter lain yang diberikan untuk people.listDirectoryPeople harus sesuai dengan panggilan pertama yang menyediakan token halaman.
requestSyncToken

boolean

Opsional. Apakah respons harus menampilkan nextSyncToken. Opsi 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 token ini untuk hanya mengambil resource yang diubah sejak permintaan terakhir.

Saat menyinkronkan, semua parameter lain yang diberikan untuk 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 ke permintaan untuk 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:

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

Untuk informasi selengkapnya, lihat Panduan otorisasi.