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

Wymagany. Prefiks zapytania pasujący do pól w danej osobie. NIE korzysta z maski odczytu do określania, które pola należy dopasować.
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 wartości od 1 do 500 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 przypadku podziału na strony wszystkie pozostałe parametry przekazane do [people.searchDirectoryPeople][google.people.v1.SearchDirectoryPeople] muszą odpowiadać pierwszemu wywołaniu tokena strony.

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 osób w katalogu domeny uwierzytelnionego użytkownika, które pasują do określonego zapytania.

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.