REST Resource: spaces.members

Ресурс: Членство

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

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

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "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 аутентифицируется как пользователь , поля « name пользователя» и type заполняются только для внутренних и внешних пользователей, если только они не являются членами пространства или не имеют предварительной связи, например, переписки в личных сообщениях (DM), с вызывающим пользователем.

groupMember

object ( Group )

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

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

Конец взаимоисключающих областей.

MembershipState

Указывает на отношение участника к пространству. В будущем может быть добавлена ​​поддержка других вариантов членства.

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

Роль члена

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

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

Участник сообщества. В пользовательском интерфейсе чата эта роль называется «Участник».

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

  • Добавить или удалить участников.
  • Изменить параметры помещения.
  • Включить или выключить историю.
  • Упомяните всех участников сообщества, используя @all .
  • Управляйте приложениями чата и веб-хуками, установленными в этом пространстве.

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

ROLE_MANAGER

Владелец пространства. В пользовательском интерфейсе чата эта роль называется «Владелец».

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

  • Измените роль других участников в этом пространстве на «участник», «менеджер» или «владелец».
  • Удалите пробел.

Поддерживается только в SpaceType.SPACE (именованные пространства).

Чтобы узнать больше, см. раздел «Узнайте больше о вашей роли как владельца или управляющего помещением» .

ROLE_ASSISTANT_MANAGER

Менеджер пространства. В пользовательском интерфейсе чата эта роль называется «Менеджер».

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

  • Удалите пробел.
  • Назначьте другого участника пространства владельцем.
  • Изменить роль владельца.

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

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

Поддерживается только в SpaceType.SPACE (именованные пространства).

Для получения более подробной информации см. раздел «Управление настройками пространства» .

Группа

Группа Google в Google Chat.

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

string

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

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

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

Принадлежность

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

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

Методы

create

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

delete

 Удаляет членство.

get

 Возвращает подробную информацию о членстве.

list

 Отображает список участников в определенном пространстве.

patch

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