Udostępnia listę profili domen i kontaktów w domenie w katalogu domeny uwierzytelnionego użytkownika.
Jeśli określisz właściwość
, zasoby usunięte od ostatniej synchronizacji zostaną zwrócone jako osoba z atrybutem syncToken
ustawionym na wartość Prawda.PersonMetadata.deleted
Jeśli podany jest parametr
lub pageToken
, pozostałe parametry żądania muszą odpowiadać pierwszemu wywołaniu.syncToken
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 |
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:
|
sources[] |
To pole jest wymagane. Źródła katalogów do zwrócenia. |
mergeSources[] |
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 |
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 |
Opcjonalnie. Token strony otrzymany z poprzedniej odpowiedzi W przypadku podziału na strony wszystkie pozostałe parametry podane w metodzie |
requestSyncToken |
Opcjonalnie. Określa, czy odpowiedź powinna zwrócić wartość Więcej informacji o synchronizacji znajdziesz na |
syncToken |
Opcjonalnie. Token synchronizacji otrzymany z poprzedniej odpowiedzi Podczas synchronizacji wszystkie pozostałe parametry podane do Więcej informacji o synchronizacji znajdziesz na |
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 ( |
Pola | |
---|---|
people[] |
Lista osób w katalogu domeny. |
nextPageToken |
Token, który można wysłać jako |
nextSyncToken |
Token, który można wysłać jako |
Zakresy autoryzacji
Wymaga następującego zakresu OAuth:
https://www.googleapis.com/auth/directory.readonly
Więcej informacji znajdziesz w przewodniku po autoryzacji.