REST Resource: contactGroups

Ресурс: Контактная группа

Контактная группа.

JSON-представление
{
  "resourceName": string,
  "etag": string,
  "metadata": {
    object (ContactGroupMetadata)
  },
  "groupType": enum (GroupType),
  "name": string,
  "formattedName": string,
  "memberResourceNames": [
    string
  ],
  "memberCount": integer,
  "clientData": [
    {
      object (GroupClientData)
    }
  ]
}
Поля
resourceName

string

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

etag

string

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

metadata

object ( ContactGroupMetadata )

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

groupType

enum ( GroupType )

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

name

string

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

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

formattedName

string

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

memberResourceNames[]

string

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

memberCount

integer

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

clientData[]

object ( GroupClientData )

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

Контактная группаМетаданные

Метаданные о контактной группе.

JSON-представление
{
  "updateTime": string,
  "deleted": boolean
}
Поля
updateTime

string ( Timestamp format)

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

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

deleted

boolean

Только вывод. True, если ресурс группы контактов был удален. Заполняется только для запросов contactGroups.list , которые включают токен синхронизации.

Тип группы

Тип контактной группы.

Перечисления
GROUP_TYPE_UNSPECIFIED Неопределенные.
USER_CONTACT_GROUP Пользовательская группа контактов.
SYSTEM_CONTACT_GROUP Определенная системой группа контактов.

ГрупповыеКлиентскиеДанные

Произвольные данные клиента, заполняемые клиентами. Допускаются дублирующиеся ключи и значения.

JSON-представление
{
  "key": string,
  "value": string
}
Поля
key

string

Клиент указал ключ данных клиента.

value

string

Клиент указал значение данных клиента.

Методы

batchGet

 Получите список групп контактов, принадлежащих проверенному пользователю, указав список имен ресурсов группы контактов.

create

 Создайте новую группу контактов, принадлежащую авторизованному пользователю.

delete

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

get

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

list

 Перечислите все группы контактов, принадлежащие аутентифицированному пользователю.

update

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