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

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