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

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