Method: people.searchDirectoryPeople

Zawiera listę profili domen i kontaktów z domeny w katalogu domeny uwierzytelnionego użytkownika, które pasują do zapytania.

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry zapytania

Parametry
query

string

Wymagane. Prefiks zapytania, które pasuje do pól w osobie. Nie używa parametru readMask do określania, które pola mają być dopasowywane.
readMask

string (FieldMask format)

Wymagane. Maska pola ograniczająca, które pola każdej osoby są 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
  • 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 z źródłami katalogu, jeśli są one połączone za pomocą zweryfikowanych kluczy łączenia, np. adresów e-mail lub numerów telefonów;
pageSize

integer

Opcjonalnie: Liczba osób, które mają zostać uwzględnione w odpowiedzi. Prawidłowe wartości to od 1 do 500 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 dzielenia na strony wszystkie pozostałe parametry podane dla [people.searchDirectoryPeople][google.people.v1.SearchDirectoryPeople] muszą być zgodne z pierwszym wywołaniem, które dostarczyło token strony.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

Odpowiedź na żądanie dotyczące osób w katalogu domeny uwierzytelnionego użytkownika, które pasują do określonego zapytania.

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

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

object (Person)

Lista osób w katalogu domeny, które pasują do zapytania.
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.
totalSize

integer

Łączna liczba elementów na liście bez podziału na strony.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

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