REST Resource: spaces.members

Ресурс: Membership

Представляет отношение участия в Google Chat, например, приглашен ли пользователь или приложение Chat в чат-группу, является ли он/оно ее участником или отсутствует в ней.

JSON-представление 
{
  "name": string,
  "state": enum (MembershipState),
  "role": enum (MembershipRole),
  "createTime": string,
  "deleteTime": string,
  "affiliation": enum (Affiliation),

  "member": {
    object (User)
  },
  "groupMember": {
    object (Group)
  }
}
Поля
name

string

Идентификатор. Название ресурса участника, назначенное сервером.

Формат: spaces/{space}/members/{member}
state

enum (MembershipState)

Только для вывода. Статус подписки.
role

enum (MembershipRole)

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

Это поле можно использовать только в качестве входных данных в members.patch.
createTime

string (Timestamp format)

Необязательное поле. Не меняется. Время создания участия, например когда участник присоединился к чат-группе или был приглашен в нее. Это поле предназначено только для вывода, за исключением случаев, когда оно используется для импорта данных об участниках в чат-группы в режиме импорта.
deleteTime

string (Timestamp format)

Необязательное поле. Не меняется. Время удаления участника, например когда участник покинул чат-группу или был удален из нее. Это поле предназначено только для вывода, за исключением случаев, когда оно используется для импорта участников в чат-группы в режиме импорта.
affiliation

enum (Affiliation)

Только для вывода. Отношение пользователя к организации Workspace, которой принадлежит чат-группа. В чат-группах, принадлежащих обычным аккаунтам, все участники имеют статус EXTERNAL.
Участник, связанный с этой подпиской. В будущем могут поддерживаться и другие типы участников. Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей:
member

object (User)

Необязательное поле. Пользователь или приложение Google Chat, к которому относится участие. Если приложение Chat выполняет аутентификацию от имени пользователя, в выходных данных заполняются только поля user name и type как для внутренних, так и для внешних пользователей, если только они не являются участниками чат-группы или не имеют предварительной связи, например прямой переписки, с вызывающим пользователем.
groupMember

object (Group)

Необязательное поле. Группа Google, к которой относится участие.

Для чтения или изменения участников групп Google требуется аутентификация пользователя.
Конец взаимоисключающих полей.

MembershipState

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

Перечисления
MEMBERSHIP_STATE_UNSPECIFIED Значение по умолчанию. Не использовать.
JOINED Пользователь добавляется в чат-группу и может участвовать в ней.
INVITED Пользователь приглашен в чат-группу, но ещё не присоединился к ней.
NOT_A_MEMBER Пользователь не состоит в чат-группе и не имеет ожидающего приглашения присоединиться к ней.

MembershipRole

Представляет разрешенные действия пользователя в чат-группе Chat. В будущем могут быть добавлены другие значения перечисления.

Перечисления
MEMBERSHIP_ROLE_UNSPECIFIED Значение по умолчанию. users не является участником чат-группы, но его можно пригласить. Для Google Groups: им всегда назначается эта роль (в будущем могут использоваться другие значения перечисления).
ROLE_MEMBER

Участник чат-группы. В интерфейсе Chat эта роль называется "Участник".

У пользователя есть базовые разрешения, например на отправку сообщений в чат-группу. Менеджеры и владельцы могут предоставлять участникам дополнительные разрешения в чат-группе, в том числе:

  • Добавлять и удалять участников.
  • менять информацию о чат-группе;
  • включение или выключение истории чата;
  • Упомянуть всех участников чат-группы с помощью @all.
  • Управлять приложениями Chat и вебхуками, установленными в чат-группе.

В прямых переписках и групповых чатах без названия эта роль есть у всех.
ROLE_MANAGER

Владелец чат-группы. В интерфейсе Chat эта роль называется "Владелец".

У пользователя есть полный набор разрешений для управления чат-группой, в том числе:

  • изменять роли других участников чат-группы на "Участник", "Менеджер" или "Владелец";
  • удалить чат-группу.

Поддерживается только в SpaceType.SPACE (чат-группах с названиями).

Подробнее о роли владельца или менеджера чат-группы…
ROLE_ASSISTANT_MANAGER

Менеджер чат-группы. В интерфейсе Chat эта роль называется "Менеджер".

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

  • удалить чат-группу.
  • Изменение роли участника чат группы на владельца.
  • Изменять роль владельца.

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

  • Назначить другого участника менеджером.
  • Удалять сообщения в чат-группе.
  • управлять разрешениями чат-группы;
  • получать уведомления о запросах на присоединение к чат-группе, если у менеджера есть разрешение на управление участниками в настройках чат-группы.
  • Сделайте чат-группу доступной для поиска.

Поддерживается только в SpaceType.SPACE (чат-группах с названиями).

Подробнее об управлении настройками чат-групп…

Группа

Группа Google в Google Chat.

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

string

Название ресурса для группы Google.

Представляет группу в Cloud Identity Groups API.

Формат: groups/{group}

Партнерство

Представляет принадлежность пользователя к организации Google Workspace, которой принадлежит чат-группа. В будущем в это перечисление могут быть добавлены дополнительные значения.

Перечисления
AFFILIATION_UNSPECIFIED Значение по умолчанию. Это значение не используется.
INTERNAL Аккаунт, управляемый той же организацией Google Workspace, которой принадлежит чат-группа.
EXTERNAL Аккаунт, не принадлежащий организации Google Workspace, которая владеет чат-группой (например, обычный аккаунт или аккаунт, управляемый другой организацией Workspace).
MANAGED_EXTERNAL Аккаунт, управляемый организацией Workspace, которой принадлежит чат-группа, но предоставленный пользователю, не входящему в организацию (например, гостевому пользователю). Подробнее https://support.google.com/chat/answer/16997417…

Методы

create

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

delete

 Удаляет участника.

get

 Возвращает сведения о членстве.

list

 Возвращает список участников чат-группы.

patch

 Обновляет членство.