Method: people.searchDirectoryPeople

Предоставляет список профилей домена и контактов домена в каталоге домена прошедшего проверку подлинности пользователя, соответствующих поисковому запросу.

HTTP-запрос

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

URL-адрес использует синтаксис транскодирования gRPC .

Параметры запроса

Параметры
query

string

Необходимый. Префиксный запрос, соответствующий полям человека. НЕ использует readMask для определения того, какие поля сопоставляться.

readMask

string ( FieldMask format)

Необходимый. Маска поля, позволяющая ограничить возвращаемые поля для каждого человека. Можно указать несколько полей, разделив их запятыми. Допустимые значения:

  • адреса
  • ВозрастДиапазоны
  • биографии
  • дни рождения
  • календарные URL-адреса
  • данные клиента
  • обложкаФотографии
  • электронная почтаАдреса
  • события
  • внешние идентификаторы
  • полы
  • imClients
  • интересы
  • локали
  • локации
  • членство
  • метаданные
  • РазноеКлючевые слова
  • имена
  • прозвища
  • занятия
  • организации
  • ТелефонНомера
  • фотографии
  • отношения
  • sipАдреса
  • навыки
  • URL-адреса
  • определяемый пользователем
sources[]

enum ( DirectorySourceType )

Необходимый. Источники каталогов для возврата.

mergeSources[]

enum ( DirectoryMergeSourceType )

Необязательный. Дополнительные данные для объединения с источниками каталога, если они подключены через проверенные ключи присоединения, такие как адреса электронной почты или номера телефонов.

pageSize

integer

Необязательный. Количество людей, которые будут включены в ответ. Допустимые значения: от 1 до 500 включительно. По умолчанию 100, если не установлено или установлено значение 0.

pageToken

string

Необязательный. Токен страницы, полученный из предыдущего ответа nextPageToken . Предоставьте это, чтобы получить следующую страницу.

При разбиении на страницы все остальные параметры, предоставленные для [ people.searchDirectoryPeople ][google.people.v1.SearchDirectoryPeople], должны соответствовать первому вызову, который предоставил токен страницы.

Тело запроса

Тело запроса должно быть пустым.

Тело ответа

Ответ на запрос людей в каталоге домена аутентифицированного пользователя, соответствующих указанному запросу.

В случае успеха тело ответа содержит данные следующей структуры:

JSON-представление 
{
  "people": [
    {
      object (Person)
    }
  ],
  "nextPageToken": string,
  "totalSize": integer
}
Поля
people[]

object ( Person )

Список людей в каталоге домена, соответствующих запросу.

nextPageToken

string

Токен, который можно отправить как pageToken для получения следующей страницы. Если это поле опущено, последующие страницы отсутствуют.

totalSize

integer

Общее количество элементов в списке без нумерации страниц.

Области авторизации

Требуется следующая область действия OAuth:

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

Дополнительную информацию см. в руководстве по авторизации .