Method: contactGroups.update

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

Обновленные имена групп контактов должны быть уникальными для групп контактов пользователей. Попытка создать группу с повторяющимся именем приведет к ошибке HTTP 409.

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

HTTP-запрос

PUT https://people.googleapis.com/v1/{contactGroup.resourceName=contactGroups/*}

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

Параметры пути

Параметры
contactGroup.resourceName

string

Имя ресурса для группы контактов, назначенное сервером. Строка ASCII в форме contactGroups/{contactGroupId} .

Тело запроса

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

JSON-представление 
{
  "contactGroup": {
    "resourceName": string,
    "etag": string,
    "metadata": {
      "updateTime": string,
      "deleted": boolean
    },
    "groupType": enum (GroupType),
    "name": string,
    "formattedName": string,
    "memberResourceNames": [
      string
    ],
    "memberCount": integer,
    "clientData": [
      {
        "key": string,
        "value": string
      }
    ]
  },
  "updateGroupFields": string,
  "readGroupFields": string
}
Поля
contactGroup.etag

string

Тег объекта HTTP ресурса. Используется для проверки веб-кеша.

contactGroup.metadata

object ( ContactGroupMetadata )

Только вывод. Метаданные о контактной группе.

contactGroup.groupType

enum ( GroupType )

Только вывод. Тип контактной группы.

contactGroup.name

string

Имя группы контактов, заданное владельцем группы, или имя, предоставленное системой для системных групп.

Для contactGroups.create или contactGroups.update имя должно быть уникальным для групп контактов пользователей. Попытка создать группу с повторяющимся именем приведет к ошибке HTTP 409.

contactGroup.formattedName

string

Только вывод. Имя, переведенное и отформатированное в языковом стандарте учетной записи средства просмотра или языковом стандарте HTTP-заголовка Accept-Language для имен системных групп. Имена групп, заданные владельцем, совпадают с именем.

contactGroup.memberResourceNames[]

string

Только вывод. Список имен ресурсов контактных лиц, которые являются членами группы контактов. Поле заполняется только для запросов GET и возвращает столько членов, сколько maxMembers в запросе на получение.

contactGroup.memberCount

integer

Только вывод. В запросе указывается общее количество контактов в группе независимо от максимального количества участников.

contactGroup.clientData[]

object ( GroupClientData )

Данные о клиентах группы.

updateGroupFields

string ( FieldMask format)

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

  • данные клиента
  • имя
readGroupFields

string ( FieldMask format)

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

  • данные клиента
  • Тип группы
  • MemberCount
  • метаданные
  • имя

Тело ответа

В случае успеха тело ответа содержит экземпляр ContactGroup .

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

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

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

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