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

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