Method: people.getBatchGet

Предоставляет информацию о списке конкретных людей, указывая список имен запрошенных ресурсов. Используйте people/me чтобы указать аутентифицированного пользователя.

Запрос возвращает ошибку 400, если «personFields» не указан.

HTTP-запрос

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

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

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

Параметры
resourceNames[]

string

Необходимый. Имена ресурсов людей, о которых нужно предоставить информацию. Это повторяемо. Параметр запроса URL должен быть

resourceNames=<name1>&resourceNames=<name2>&...

  • Чтобы получить информацию об аутентифицированном пользователе, укажите people/me .
  • Чтобы получить информацию об аккаунте Google, укажите people/{account_id} .
  • Чтобы получить информацию о контакте, укажите имя ресурса, которое идентифицирует контакт, возвращаемый people.connections.list .

Существует максимум 200 имен ресурсов.

requestMask
(deprecated)

object ( RequestMask )

УСТАРЕЛО (вместо этого используйте personFields )

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

personFields

string ( FieldMask format)

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

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

enum ( ReadSourceType )

Необязательный. Маска того, какие типы источников возвращаются. По умолчанию — READ_SOURCE_TYPE_CONTACT и READ_SOURCE_TYPE_PROFILE если не установлено.

Тело запроса

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

Тело ответа

Ответ на запрос на получение списка людей по имени ресурса.

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

JSON-представление 
{
  "responses": [
    {
      object (PersonResponse)
    }
  ]
}
Поля
responses[]

object ( PersonResponse )

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

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

Для доступа к общедоступным данным не требуется авторизация. Для личных данных требуется одна из следующих областей OAuth:

  • https://www.googleapis.com/auth/contacts
  • https://www.googleapis.com/auth/contacts.readonly
  • https://www.googleapis.com/auth/contacts.other.readonly
  • https://www.googleapis.com/auth/directory.readonly
  • https://www.googleapis.com/auth/profile.agerange.read
  • https://www.googleapis.com/auth/profile.emails.read
  • https://www.googleapis.com/auth/profile.language.read
  • https://www.googleapis.com/auth/user.addresses.read
  • https://www.googleapis.com/auth/user.birthday.read
  • https://www.googleapis.com/auth/user.emails.read
  • https://www.googleapis.com/auth/user.gender.read
  • https://www.googleapis.com/auth/user.organization.read
  • https://www.googleapis.com/auth/user.phonenumbers.read
  • https://www.googleapis.com/auth/userinfo.email
  • https://www.googleapis.com/auth/userinfo.profile
  • https://www.googleapis.com/auth/profile.language.read

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