Method: people.listDirectoryPeople

Zawiera listę profili domen i kontaktów domeny w katalogu domeny uwierzytelnionego użytkownika.

Jeśli zasada syncToken jest określona, zasoby usunięte od czasu ostatniej synchronizacji są zwracane jako osoba, dla której zasada PersonMetadata.deleted ma wartość Prawda.

Jeśli podasz parametr pageToken lub syncToken, wszystkie pozostałe parametry żądania muszą być zgodne z pierwszym wywołaniem.

W przypadku żądań synchronizacji zapisywanie może być opóźnione o kilka minut. Synchronizacja przyrostowa nie jest przeznaczona do obsługi odczytu po zapisie.

Przykładowe zastosowanie znajdziesz w sekcji Wyświetlanie listy osób, które zostały zmienione w katalogu.

Żą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)

Wymagane. Maska pola, która ogranicza, które pola dotyczące danej osoby mają być zwracane. Aby podać wiele pól, rozdziel 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
  • nazwy
  • pseudonimy
  • zawody
  • organizacje
  • phoneNumbers
  • zdjęcia
  • relacje
  • sipAddresses
  • umiejętności
  • adresy
  • userDefined
sources[]

enum (DirectorySourceType)

Wymagane. Źródła katalogów do zwrócenia.
mergeSources[]

enum (DirectoryMergeSourceType)

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

integer

Opcjonalnie: Liczba osób, które mają zostać uwzględnione w odpowiedzi. Prawidłowe wartości to od 1 do 1000 włącznie. Jeśli nie zostanie ustawiony lub zostanie ustawiony na 0, domyślna wartość to 100.
pageToken

string

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

Podczas podziału na strony wszystkie inne parametry przekazane do funkcji people.listDirectoryPeople muszą być zgodne z pierwszym wywołaniem, które przekazało token strony.
requestSyncToken

boolean

Opcjonalnie: Określa, czy odpowiedź powinna zwracać nextSyncToken. Można go użyć do uzyskania różnicy między ostatnim żądaniem a obecnym stanem, ustawiając je w żądaniu syncToken.

Więcej informacji o sposobie synchronizacji znajdziesz na stronie people.listDirectoryPeople.
syncToken

string

Opcjonalnie: token synchronizacji otrzymany z poprzedniej odpowiedzi (nextSyncToken) – podaj go, aby pobrać tylko zasoby zmienione od czasu ostatniego żądania;

Podczas synchronizacji wszystkie pozostałe parametry podane w usłudze people.listDirectoryPeople muszą być zgodne z pierwszym wywołaniem, które dostarczyło token synchronizacji.

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

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

Odpowiedź na żądanie dotyczące 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że być wysyłany jako pageToken w celu pobrania następnej strony. 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 czasu ostatniego żądania. W żądaniu musi być ustawiona wartość requestSyncToken, aby zwrócić token synchronizacji.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w przewodniku dotyczącym autoryzacji.