Method: people.listDirectoryPeople

Udostępnia listę profili domen i kontaktów w domenie w katalogu domeny uwierzytelnionego użytkownika.

Jeśli określisz właściwość syncToken, zasoby usunięte od ostatniej synchronizacji zostaną zwrócone jako osoba z atrybutem PersonMetadata.deleted ustawionym na wartość Prawda.

Jeśli podany jest parametr pageToken lub syncToken, pozostałe parametry żądania muszą odpowiadać pierwszemu wywołaniu.

Na propagację zapisów może wystąpić kilkuminutowe opóźnienie w przypadku żądań synchronizacji. Synchronizacje przyrostowe nie są przeznaczone do zastosowań typu odczyt po zapisie.

Przykład użycia znajdziesz w artykule Lista katalogów, w których wprowadzono zmiany.

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry zapytania

Parametry
readMask

string (FieldMask format)

To pole jest wymagane. Maska pola określająca, które pola każdej osoby mają być zwracane. Można określić wiele pól, rozdzielając je przecinkami. Prawidłowe wartości to:

  • adresy
  • ageRanges
  • biografie
  • urodziny
  • calendarUrls
  • clientData
  • coverPhotos
  • emailAddresses
  • wydarzenia
  • externalIds
  • płeć
  • imClients
  • zainteresowania
  • locales
  • lokalizacje
  • kanału
  • metadane
  • miscKeywords
  • names
  • pseudonimy
  • zawody
  • organizations
  • phoneNumbers
  • fotografie
  • relacje
  • sipAddresses
  • umiejętności
  • urls
  • userDefined
sources[]

enum (DirectorySourceType)

To pole jest wymagane. Źródła katalogów do zwrócenia.

mergeSources[]

enum (DirectoryMergeSourceType)

Opcjonalnie. Dodatkowe dane do scalenia ze źródłami z katalogu, jeśli są one połączone za pomocą zweryfikowanych kluczy łączenia, takich jak adresy e-mail lub numery telefonów.

pageSize

integer

Opcjonalnie. Liczba osób, które mają być uwzględnione w odpowiedzi. Prawidłowe wartości mieszczą się w zakresie od 1 do 1000 włącznie. Jeśli zasada jest nieskonfigurowana lub ma wartość 0, domyślna wartość to 100.

pageToken

string

Opcjonalnie. Token strony otrzymany z poprzedniej odpowiedzi nextPageToken. Podaj je, aby pobrać kolejną stronę.

W przypadku podziału na strony wszystkie pozostałe parametry podane w metodzie people.listDirectoryPeople muszą odpowiadać pierwszemu wywołaniu, które dostarczyło token strony.

requestSyncToken

boolean

Opcjonalnie. Określa, czy odpowiedź powinna zwrócić wartość nextSyncToken. Można go użyć, aby uzyskać przyrostowe zmiany od ostatniego żądania, ustawiając je w żądaniu syncToken.

Więcej informacji o synchronizacji znajdziesz na people.listDirectoryPeople.

syncToken

string

Opcjonalnie. Token synchronizacji otrzymany z poprzedniej odpowiedzi nextSyncToken Podaj ten token, aby pobrać tylko zasoby, które zmieniły się od czasu ostatniego żądania.

Podczas synchronizacji wszystkie pozostałe parametry podane do people.listDirectoryPeople muszą odpowiadać pierwszemu wywołaniu, które dostarczyło token synchronizacji.

Więcej informacji o synchronizacji znajdziesz na people.listDirectoryPeople.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

Odpowiedź na żądanie katalogu domeny uwierzytelnionego użytkownika.

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

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

object (Person)

Lista osób w katalogu domeny.

nextPageToken

string

Token, który można wysłać jako pageToken, aby pobrać następną stronę. Jeśli pominiesz to pole, nie będzie kolejnych stron.

nextSyncToken

string

Token, który można wysłać jako syncToken, aby pobrać zmiany od ostatniego żądania. Aby zwracał token synchronizacji, żądanie musi ustawić requestSyncToken.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w przewodniku po autoryzacji.