Method: people.listDirectoryPeople

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

Если syncToken , ресурсы, удаленные с момента последней синхронизации, будут возвращены как человек с PersonMetadata.deleted , для которого задано значение true.

Когда pageToken или syncToken , все остальные параметры запроса должны соответствовать первому вызову.

Запись может иметь задержку распространения в несколько минут для запросов синхронизации. Добавочная синхронизация не предназначена для случаев чтения после записи.

См. пример использования в списке людей из каталога, которые изменились .

HTTP-запрос

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

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

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

Параметры
readMask

string ( FieldMask format)

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

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

enum ( DirectorySourceType )

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

mergeSources[]

enum ( DirectoryMergeSourceType )

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

pageSize

integer

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

pageToken

string

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

При разбиении на страницы все остальные параметры, предоставленные для people.listDirectoryPeople должны соответствовать первому вызову, предоставившему токен страницы.

requestSyncToken

boolean

По желанию. Должен ли ответ возвращать nextSyncToken . Его можно использовать для получения добавочных изменений с момента последнего запроса, установив его в запросе syncToken .

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

syncToken

string

По желанию. Маркер синхронизации, полученный из предыдущего ответа nextSyncToken Укажите это, чтобы получить только ресурсы, измененные с момента последнего запроса.

При синхронизации все остальные параметры, предоставленные для people.listDirectoryPeople должны соответствовать первому вызову, предоставившему токен синхронизации.

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

Тело запроса

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

Тело ответа

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

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

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

object ( Person )

Список людей в каталоге домена.

nextPageToken

string

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

nextSyncToken

string

Маркер, который можно отправить как syncToken для получения изменений с момента последнего запроса. Запрос должен установить requestSyncToken для возврата токена синхронизации.

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

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

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

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