Method: people.batchUpdateContacts

Обновите пакет контактов и верните карту имен ресурсов в PersonResponses для обновленных контактов.

Запросы на изменение для одного и того же пользователя следует отправлять последовательно, чтобы избежать увеличения задержек и сбоев.

HTTP-запрос

POST https://people.googleapis.com/v1/people:batchUpdateContacts

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

Тело запроса

Тело запроса содержит данные следующей структуры:

JSON-представление
{
  "contacts": {
    string: {
      object (Person)
    },
    ...
  },
  "updateMask": string,
  "readMask": string,
  "sources": [
    enum (ReadSourceType)
  ]
}
Поля
contacts

map (key: string, value: object ( Person ))

Необходимый. Сопоставление названий ресурсов с данными о людях, которые необходимо обновить. Позволяет до 200 контактов в одном запросе.

Объект, содержащий список пар "key": value . Пример: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

updateMask

string ( FieldMask format)

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

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

string ( FieldMask format)

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

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

enum ( ReadSourceType )

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

Тело ответа

В случае неудачи возвращает BatchUpdateContactsErrorDetails — список ошибок, соответствующих каждому контакту.

Ответ на запрос на обновление пакета контактов.

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

JSON-представление
{
  "updateResult": {
    string: {
      object (PersonResponse)
    },
    ...
  }
}
Поля
updateResult

map (key: string, value: object ( PersonResponse ))

Сопоставление имен ресурсов с обновленными контактами, если только запрос readMask не пуст.

Объект, содержащий список пар "key": value . Пример: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

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

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

  • https://www.googleapis.com/auth/contacts

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