Method: people.searchDirectoryPeople

Udostępnia listę profili domen i kontaktów w domenie 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

To pole jest wymagane. Prefiks zapytania pasującego do pól osoby. NIE używa parametru readMask do określania, które pola mają być dopasowane.
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 500 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ę.

Podczas podziału na strony wszystkie pozostałe parametry podane [people.searchDirectoryPeople][google.people.v1.Search DirectoryPeople] muszą odpowiadać pierwszemu wywołaniu, które podało token strony.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

Odpowiedź na żądanie dotyczące osób z 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żna wysłać jako pageToken, aby pobrać następną stronę. 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 po autoryzacji.