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 "Zulu" с разрешением в наносекунды и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

deleted

boolean

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

Тип группы

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

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

GroupClientData

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

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

string

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

value

string

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

Методы

batchGet

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

create

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

delete

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

get

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

list

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

update

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