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/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

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