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

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