Method: people.listDirectoryPeople

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

Gdy właściwość syncToken jest określona, zasoby usunięte od ostatniej synchronizacji są zwracane jako osoba z wartością PersonMetadata.deleted ustawioną na „true”.

Po określeniu pageToken lub syncToken wszystkie pozostałe parametry żądania muszą być zgodne z pierwszym wywołaniem.

W przypadku żądań synchronizacji opóźnienie propagacji może potrwać kilka minut. Synchronizacje przyrostowe nie są przeznaczone do przypadków użycia po odczytaniu i zapisie.

Przykładowe zastosowanie znajdziesz w sekcji 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)

Wymagany. Maska pola, która ogranicza pola zwracane przez poszczególne osoby. Możesz określić wiele pól, rozdzielając je przecinkami. Prawidłowe wartości to:

  • adresy
  • przedziały wiekowe
  • biografie
  • urodziny
  • kalendarzUrl
  • daneklienta
  • Zdjęcia na okładkę
  • adresy-e-mail
  • wydarzenia
  • externalIds
  • płeć
  • klienty
  • zainteresowania
  • języki
  • lokalizacje
  • kanału
  • metadane
  • inne słowa kluczowe
  • imiona i nazwiska
  • pseudonimy
  • zawody
  • organizacje
  • numery telefonów
  • zdjęcia
  • relacje
  • adresy sip
  • umiejętności
  • adresy
  • definiowany przez użytkownika
sources[]

enum (DirectorySourceType)

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

enum (DirectoryMergeSourceType)

Opcjonalne. Dodatkowe dane do scalenia ze źródłami katalogu, jeśli są one połączone zweryfikowanymi kluczami łączenia, takimi jak adresy e-mail lub numery telefonów.
pageSize

integer

Opcjonalne. Liczba osób uwzględnionych w odpowiedzi. Prawidłowe wartości to od 1 do 1000 włącznie. Jeśli zasada jest nieskonfigurowana lub ma wartość 0, przyjmuje domyślną wartość 100.
pageToken

string

Opcjonalne. Token strony otrzymany z poprzedniej odpowiedzi nextPageToken. Podaj go, aby pobrać następną stronę.

W podziale na strony wszystkie pozostałe parametry przekazane do people.listDirectoryPeople muszą odpowiadać pierwszemu wywołaniu tokena strony.
requestSyncToken

boolean

Opcjonalne. Określa, czy odpowiedź powinna zwracać wartość nextSyncToken. Można go użyć, by uzyskać przyrostowe zmiany od czasu ostatniego żądania, ustawiając je w żądaniu syncToken.

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

string

Opcjonalne. Token synchronizacji otrzymany z poprzedniej odpowiedzi nextSyncToken – wpisz go, aby pobrać tylko zasoby zmienione od czasu ostatniego żądania.

Podczas synchronizacji wszystkie pozostałe parametry przekazane do people.listDirectoryPeople muszą odpowiadać pierwszemu wywołaniu tokena synchronizacji.

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

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

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

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

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 można było zwrócić token synchronizacji, żądanie musi mieć wartość requestSyncToken.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w przewodniku po autoryzacji.