Package google.chat.v1

Индекс

ЧатСервис

Позволяет разработчикам создавать приложения Chat и их интеграцию на платформе Google Chat.

CompleteImportSpace

rpc CompleteImportSpace( CompleteImportSpaceRequest ) returns ( CompleteImportSpaceResponse )

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

Требуется аутентификация приложения и делегирование на уровне домена. Дополнительную информацию см. в разделе Разрешение приложениям Google Chat импортировать данные .

Области авторизации

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/chat.import

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

СоздатьПользовательскийEmoji

rpc CreateCustomEmoji( CreateCustomEmojiRequest ) returns ( CustomEmoji )

Создает собственный смайлик.

Требует аутентификации пользователя .

Области авторизации

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/chat.customemojis

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

Создать членство

rpc CreateMembership( CreateMembershipRequest ) returns ( Membership )

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

Поддерживает следующие типы аутентификации :

Пример использования см.:

Области авторизации

Требуется одна из следующих областей OAuth:

  • https://www.googleapis.com/auth/chat.app.memberships
  • https://www.googleapis.com/auth/chat.admin.memberships
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.app

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

Создать сообщение

rpc CreateMessage( CreateMessageRequest ) returns ( Message )

Создает сообщение в чате Google. Пример см. в разделе «Отправить сообщение» .

Метод create() требует либо аутентификации пользователя , либо аутентификации приложения . Chat атрибутирует отправителя сообщения по-разному в зависимости от типа аутентификации, который вы используете в своем запросе.

На следующем изображении показано, как Chat атрибутирует сообщение при использовании аутентификации приложения. Chat отображает приложение Chat в качестве отправителя сообщения. Содержимое сообщения может содержать текст ( text ), карточки ( cardsV2 ) и дополнительные виджеты ( accessoryWidgets ).

Сообщение отправлено с аутентификацией приложения

На следующем изображении показано, как Chat атрибутирует сообщение при использовании аутентификации пользователя. Chat отображает пользователя как отправителя сообщения и связывает приложение Chat с сообщением, отображая его имя. Содержимое сообщения может содержать только текст ( text ).

Сообщение отправлено с аутентификацией пользователя

Максимальный размер сообщения, включая его содержимое, составляет 32 000 байт.

Области авторизации

Требуется одна из следующих областей OAuth:

  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.create

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

Создатьреакцию

rpc CreateReaction( CreateReactionRequest ) returns ( Reaction )

Создает реакцию и добавляет ее в сообщение. Поддерживаются только смайлы Юникода. Пример см. в разделе Добавление реакции на сообщение .

Требует аутентификации пользователя .

Области авторизации

Требуется одна из следующих областей OAuth:

  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.create

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

Создать пространство

rpc CreateSpace( CreateSpaceRequest ) returns ( Space )

Создает пространство. Может использоваться для создания именованного пространства или группового чата в Import mode . Пример см. в разделе Создание пространства .

Поддерживает следующие типы аутентификации :

При аутентификации в качестве приложения в запросе должно быть установлено поле space.customer .

Членство в пространстве при создании зависит от того, создано ли пространство в Import mode :

  • Режим импорта: участники не создаются.
  • Все остальные режимы: вызывающий пользователь добавляется в качестве участника. Это:
    • Само приложение при использовании аутентификации приложения.
    • Пользователь-человек при использовании аутентификации пользователя.

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

Области авторизации

Требуется одна из следующих областей OAuth:

  • https://www.googleapis.com/auth/chat.app.spaces.create
  • https://www.googleapis.com/auth/chat.app.spaces
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.create

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

УдалитьCustomEmoji

rpc DeleteCustomEmoji( DeleteCustomEmojiRequest ) returns ( Empty )

Удаляет собственный эмодзи.

Требует аутентификации пользователя .

Области авторизации

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/chat.customemojis

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

Удалить членство

rpc DeleteMembership( DeleteMembershipRequest ) returns ( Membership )

Удаляет членство. Пример см. в статье Удаление пользователя или приложения Google Chat из пространства .

Поддерживает следующие типы аутентификации :

Области авторизации

Требуется одна из следующих областей OAuth:

  • https://www.googleapis.com/auth/chat.app.memberships
  • https://www.googleapis.com/auth/chat.admin.memberships
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.app

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

Удалить сообщение

rpc DeleteMessage( DeleteMessageRequest ) returns ( Empty )

Удаляет сообщение. Пример см. в разделе Удаление сообщения .

Поддерживает следующие типы аутентификации :

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

Области авторизации

Требуется одна из следующих областей OAuth:

  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages

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

Удалитьреакцию

rpc DeleteReaction( DeleteReactionRequest ) returns ( Empty )

Удаляет реакцию на сообщение. Поддерживаются только смайлы Юникода. Пример см. в разделе Удаление реакции .

Требует аутентификации пользователя .

Области авторизации

Требуется одна из следующих областей OAuth:

  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.reactions

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

Удалить пространство

rpc DeleteSpace( DeleteSpaceRequest ) returns ( Empty )

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

Поддерживает следующие типы аутентификации :

Области авторизации

Требуется одна из следующих областей OAuth:

  • https://www.googleapis.com/auth/chat.app.delete
  • https://www.googleapis.com/auth/chat.admin.delete
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.delete

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

НайтиDirectMessage

rpc FindDirectMessage( FindDirectMessageRequest ) returns ( Space )

Возвращает существующее прямое сообщение указанному пользователю. Если пространство для прямых сообщений не найдено, возвращается ошибка 404 NOT_FOUND . Пример см. в разделе «Найти прямое сообщение» .

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

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

// Поддерживает следующие типы аутентификации :

Области авторизации

Требуется одна из следующих областей OAuth:

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.bot

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

Получить вложение

rpc GetAttachment( GetAttachmentRequest ) returns ( Attachment )

Получает метаданные вложения сообщения. Данные вложения извлекаются с помощью медиа API . Пример см. в разделе Получение метаданных о вложении сообщения . Требуется аутентификация приложения .

Области авторизации

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/chat.bot

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

GetCustomEmoji

rpc GetCustomEmoji( GetCustomEmojiRequest ) returns ( CustomEmoji )

Возвращает сведения о пользовательском эмодзи.

Требует аутентификации пользователя .

Области авторизации

Требуется одна из следующих областей OAuth:

  • https://www.googleapis.com/auth/chat.customemojis
  • https://www.googleapis.com/auth/chat.customemojis.readonly

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

Получить членство

rpc GetMembership( GetMembershipRequest ) returns ( Membership )

Возвращает сведения о членстве. Пример см. в разделе Получение сведений о членстве пользователя или приложения Google Chat .

Поддерживает следующие типы аутентификации :

Области авторизации

Требуется одна из следующих областей OAuth:

  • https://www.googleapis.com/auth/chat.admin.memberships
  • https://www.googleapis.com/auth/chat.admin.memberships.readonly
  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly

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

Получить сообщение

rpc GetMessage( GetMessageRequest ) returns ( Message )

Возвращает сведения о сообщении. Пример см. в разделе Получение сведений о сообщении .

Поддерживает следующие типы аутентификации :

Примечание. Может вернуть сообщение от заблокированного участника или пространства.

Области авторизации

Требуется одна из следующих областей OAuth:

  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly

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

GetSpace

rpc GetSpace( GetSpaceRequest ) returns ( Space )

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

Поддерживает следующие типы аутентификации :

Области авторизации

Требуется одна из следующих областей OAuth:

  • https://www.googleapis.com/auth/chat.admin.spaces
  • https://www.googleapis.com/auth/chat.admin.spaces.readonly
  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.app.spaces

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

GetSpaceEvent

rpc GetSpaceEvent( GetSpaceEventRequest ) returns ( SpaceEvent )

Возвращает событие из пространства Google Chat. Полезные данные события содержат самую последнюю версию измененного ресурса. Например, если вы запрашиваете событие о новом сообщении, но позже оно было обновлено, сервер возвращает обновленный ресурс Message в полезных данных события.

Примечание. Поле permissionSettings не возвращается в объекте Space данных о событиях Space для этого запроса.

Требует аутентификации пользователя . Чтобы получить событие, аутентифицированный пользователь должен быть членом пространства.

Пример см. в разделе Получение сведений о событии из чата Google .

Области авторизации

Требуется одна из следующих областей OAuth:

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.readonly

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

GetSpaceNotificationSetting

rpc GetSpaceNotificationSetting( GetSpaceNotificationSettingRequest ) returns ( SpaceNotificationSetting )

Получает настройки состояния уведомлений о пространстве.

Требует аутентификации пользователя .

Области авторизации

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/chat.users.spacesettings

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

GetSpaceReadState

rpc GetSpaceReadState( GetSpaceReadStateRequest ) returns ( SpaceReadState )

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

Требует аутентификации пользователя .

Области авторизации

Требуется одна из следующих областей OAuth:

  • https://www.googleapis.com/auth/chat.users.readstate
  • https://www.googleapis.com/auth/chat.users.readstate.readonly

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

GetThreadReadState

rpc GetThreadReadState( GetThreadReadStateRequest ) returns ( ThreadReadState )

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

Требует аутентификации пользователя .

Области авторизации

Требуется одна из следующих областей OAuth:

  • https://www.googleapis.com/auth/chat.users.readstate
  • https://www.googleapis.com/auth/chat.users.readstate.readonly

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

СписокПользовательскиеEmojis

rpc ListCustomEmojis( ListCustomEmojisRequest ) returns ( ListCustomEmojisResponse )

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

Требует аутентификации пользователя .

Области авторизации

Требуется одна из следующих областей OAuth:

  • https://www.googleapis.com/auth/chat.customemojis
  • https://www.googleapis.com/auth/chat.customemojis.readonly

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

Список членства

rpc ListMemberships( ListMembershipsRequest ) returns ( ListMembershipsResponse )

Перечисляет членство в пространстве. Пример см. в разделе Список пользователей и приложений Google Chat в пространстве . В списке участников с аутентификацией приложения перечислены участники в пространствах, к которым у приложения Chat есть доступ, но исключаются членства в приложении Chat, включая собственное. В списке участников с аутентификацией пользователя перечислены членства в пространствах, к которым имеет доступ аутентифицированный пользователь.

Поддерживает следующие типы аутентификации :

Области авторизации

Требуется одна из следующих областей OAuth:

  • https://www.googleapis.com/auth/chat.admin.memberships
  • https://www.googleapis.com/auth/chat.admin.memberships.readonly
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly

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

Список сообщений

rpc ListMessages( ListMessagesRequest ) returns ( ListMessagesResponse )

Перечисляет сообщения в пространстве, участником которого является вызывающий абонент, включая сообщения от заблокированных участников и пространств. Если вы перечислите сообщения из пространства, в котором нет сообщений, ответом будет пустой объект. При использовании интерфейса REST/HTTP ответ содержит пустой объект JSON {} . Пример см. в разделе Список сообщений .

Требует аутентификации пользователя .

Области авторизации

Требуется одна из следующих областей OAuth:

  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly

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

Список реакций

rpc ListReactions( ListReactionsRequest ) returns ( ListReactionsResponse )

Перечисляет реакции на сообщение. Пример см. в разделе Список реакций на сообщение .

Требует аутентификации пользователя .

Области авторизации

Требуется одна из следующих областей OAuth:

  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.readonly

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

ListSpaceEvents

rpc ListSpaceEvents( ListSpaceEventsRequest ) returns ( ListSpaceEventsResponse )

Перечисляет события из пространства Google Chat. Для каждого события полезные данные содержат самую последнюю версию ресурса Chat. Например, если вы перечислите события о новых участниках пространства, сервер вернет ресурсы Membership , содержащие последние сведения о членстве. Если новые участники были удалены в течение запрошенного периода, полезные данные события будут содержать пустой ресурс Membership .

Требует аутентификации пользователя . Чтобы составить список событий, аутентифицированный пользователь должен быть участником пространства.

Пример см. в разделе Список событий из чата Google .

Области авторизации

Требуется одна из следующих областей OAuth:

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.readonly

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

Список пространств

rpc ListSpaces( ListSpacesRequest ) returns ( ListSpacesResponse )

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

Поддерживает следующие типы аутентификации :

Чтобы получить список всех именованных пространств по организациям Google Workspace, используйте вместо этого метод spaces.search() с правами администратора Workspace.

Области авторизации

Требуется одна из следующих областей OAuth:

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.bot

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

Поиск пространств

rpc SearchSpaces( SearchSpacesRequest ) returns ( SearchSpacesResponse )

Возвращает список пространств в организации Google Workspace на основе поиска администратора.

Требуется аутентификация пользователя с правами администратора . В запросе установите для use_admin_access значение true .

Области авторизации

Требуется одна из следующих областей OAuth:

  • https://www.googleapis.com/auth/chat.admin.spaces
  • https://www.googleapis.com/auth/chat.admin.spaces.readonly

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

SetUpSpace

rpc SetUpSpace( SetUpSpaceRequest ) returns ( Space )

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

Чтобы указать добавляемых членов-людей, добавьте членство с соответствующим membership.member.name . Чтобы добавить пользователя-человека, используйте users/{user} , где {user} может быть адресом электронной почты пользователя. Для пользователей в одной организации Workspace {user} также может быть id человека из API People или id пользователя в API каталога. Например, если идентификатор профиля пользователя People API для user@example.com — 123456789 , вы можете добавить пользователя в пространство, задав для membership.member.name users/user@example.com илиusers users/123456789 .

Чтобы указать группы Google для добавления, добавьте членство с соответствующим membership.group_member.name . Чтобы добавить или пригласить группу Google, используйте groups/{group} , где {group} — это id группы из Cloud Identity Groups API. Например, вы можете использовать API поиска групп Cloud Identity для получения идентификатора 123456789 для адреса электронной почты группы group@example.com , а затем добавить группу в пространство, установив для membership.group_member.name значение groups/123456789 . Групповая электронная почта не поддерживается, а группы Google можно добавлять только в качестве участников в именованных пространствах.

Если для именованного пространства или группового чата вызывающий абонент блокируется или заблокирован некоторыми участниками или не имеет разрешения на добавление некоторых участников, то эти участники не добавляются в созданное пространство.

Чтобы создать прямое сообщение (DM) между вызывающим пользователем и другим пользователем-человеком, укажите ровно одно членство, которое будет представлять пользователя-человека. Если один пользователь блокирует другого, запрос не выполняется и DM не создается.

Чтобы создать DM между вызывающим пользователем и вызывающим приложением, установите для Space.singleUserBotDm значение true и не указывайте членство. Вы можете использовать этот метод только для настройки DM с вызывающим приложением. Чтобы добавить вызывающее приложение в качестве участника пространства или существующего DM между двумя пользователями-людьми, см. Приглашение или добавление пользователя или приложения в пространство .

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

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

Требует аутентификации пользователя .

Области авторизации

Требуется одна из следующих областей OAuth:

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.create

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

Обновление членства

rpc UpdateMembership( UpdateMembershipRequest ) returns ( Membership )

Обновляет членство. Пример см. в разделе Обновление членства пользователя в пространстве .

Поддерживает следующие типы аутентификации :

Области авторизации

Требуется одна из следующих областей OAuth:

  • https://www.googleapis.com/auth/chat.app.memberships
  • https://www.googleapis.com/auth/chat.admin.memberships
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.memberships

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

Обновление сообщения

rpc UpdateMessage( UpdateMessageRequest ) returns ( Message )

Обновляет сообщение. Существует разница между методами patch и update . Метод patch использует запрос patch , а метод update использует запрос put . Мы рекомендуем использовать метод patch . Пример см. в разделе Обновление сообщения .

Поддерживает следующие типы аутентификации :

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

Области авторизации

Требуется одна из следующих областей OAuth:

  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages

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

ОбновлениеПространство

rpc UpdateSpace( UpdateSpaceRequest ) returns ( Space )

Обновляет пространство. Пример см. в разделе Обновление пространства .

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

Поддерживает следующие типы аутентификации :

Области авторизации

Требуется одна из следующих областей OAuth:

  • https://www.googleapis.com/auth/chat.app.spaces
  • https://www.googleapis.com/auth/chat.admin.spaces
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.spaces

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

UpdateSpaceNotificationSetting

rpc UpdateSpaceNotificationSetting( UpdateSpaceNotificationSettingRequest ) returns ( SpaceNotificationSetting )

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

Требует аутентификации пользователя .

Области авторизации

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/chat.users.spacesettings

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

UpdateSpaceReadState

rpc UpdateSpaceReadState( UpdateSpaceReadStateRequest ) returns ( SpaceReadState )

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

Требует аутентификации пользователя .

Области авторизации

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/chat.users.readstate

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

АксессуарВиджет

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

Поля
Полевые action Союза. Тип действия. action может быть только одним из следующих:
button_ list

ButtonList

Список кнопок.

ДействиеОтвет

Параметры, которые приложение Chat может использовать для настройки способа публикации ответа.

Поля
type

ResponseType

Только ввод. Тип ответа приложения Chat.

url

string

Только ввод. URL-адрес для пользователей для аутентификации или настройки. (Только для типов ответов REQUEST_CONFIG .)

dialog_ action

DialogAction

Только ввод. Ответ на событие взаимодействия, связанное с диалогом . Должен сопровождаться ResponseType.Dialog .

updated_ widget

UpdatedWidget

Только ввод. Ответ обновленного виджета.

Тип ответа

Тип ответа приложения Chat.

Перечисления
TYPE_UNSPECIFIED Тип по умолчанию, который обрабатывается как NEW_MESSAGE .
NEW_MESSAGE Опубликовать как новое сообщение в теме.
UPDATE_MESSAGE Обновите сообщение приложения Chat. Это разрешено только для события CARD_CLICKED , где тип отправителя сообщения — BOT .
UPDATE_USER_MESSAGE_CARDS Обновите карточки в сообщении пользователя. Это разрешено только в качестве ответа на событие MESSAGE с совпадающим URL-адресом или событие CARD_CLICKED , где тип отправителя сообщения — HUMAN . Текст игнорируется.
REQUEST_CONFIG В частном порядке запросите у пользователя дополнительную аутентификацию или настройку.
DIALOG Представляет диалог .
UPDATE_WIDGET Запрос параметров автозаполнения текста виджета.

Элементы выбора

Список результатов автозаполнения виджета.

Поля
items[]

SelectionItem

Массив объектов SelectionItem.

Обновленный виджет

Ответ обновленного виджета. Используется для предоставления параметров автозаполнения для виджета.

Поля
widget

string

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

Поле объединения updated_widget . Виджет обновляется в ответ на действие пользователя. updated_widget может быть только одним из следующих:
suggestions

SelectionItems

Список результатов автозаполнения виджета

Статус действия

Представляет состояние запроса на вызов или отправку диалога .

Поля
status_ code

Code

Код состояния.

user_ facing_ message

string

Сообщение для отправки пользователям о статусе их запроса. Если значение не установлено, отправляется общее сообщение на основе status_code .

Аннотация

Только вывод. Аннотации, связанные с текстовым телом сообщения. Чтобы добавить базовое форматирование к текстовому сообщению, см. раздел Форматирование текстовых сообщений .

Пример текста сообщения:

Hello @FooBot how are you!"

Соответствующие метаданные аннотаций:

"annotations":[{
  "type":"USER_MENTION",
  "startIndex":6,
  "length":7,
  "userMention": {
    "user": {
      "name":"users/{user}",
      "displayName":"FooBot",
      "avatarUrl":"https://goo.gl/aeDtrS",
      "type":"BOT"
    },
    "type":"MENTION"
   }
}]
Поля
type

AnnotationType

Тип этой аннотации.

length

int32

Длина подстроки в теле сообщения в виде обычного текста, которой соответствует эта аннотация.

start_ index

int32

Начальный индекс (отсчитываемый от 0 включительно) в теле текстового сообщения, которому соответствует эта аннотация.

metadata поля объединения. Дополнительные метаданные об аннотации. metadata могут быть только одним из следующих:
user_ mention

UserMentionMetadata

Метаданные упоминания пользователя.

slash_ command

SlashCommandMetadata

Метаданные для косой черты.

Тип аннотации

Тип аннотации.

Перечисления
ANNOTATION_TYPE_UNSPECIFIED Значение по умолчанию для перечисления. Не используйте.
USER_MENTION Упоминается пользователь.
SLASH_COMMAND Вызывается команда косой черты.

ПрикрепленоGif

Изображение GIF, заданное URL-адресом.

Поля
uri

string

Только вывод. URL-адрес, на котором размещено изображение GIF.

Вложение

Вложение в Google Chat.

Поля
name

string

Необязательный. Имя ресурса вложения в форме spaces/{space}/messages/{message}/attachments/{attachment} .

content_ name

string

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

content_ type

string

Только вывод. Тип содержимого (тип MIME) файла.

thumbnail_ uri

string

Только вывод. URL-адрес миниатюры, который следует использовать для предварительного просмотра вложения пользователю-человеку. Приложения чата не должны использовать этот URL-адрес для загрузки содержимого вложений.

download_ uri

string

Только вывод. URL-адрес загрузки, который следует использовать, чтобы позволить пользователю-человеку загрузить вложение. Приложения чата не должны использовать этот URL-адрес для загрузки содержимого вложений.

source

Source

Только вывод. Источник вложения.

Поле объединения data_ref . Ссылка на данные во вложении. data_ref может быть только одним из следующих:
attachment_ data_ ref

AttachmentDataRef

Необязательный. Ссылка на данные вложения. Это поле используется для создания или обновления сообщений с вложениями или с помощью медиа API для загрузки данных вложений.

drive_ data_ ref

DriveDataRef

Только вывод. Ссылка на вложение Google Диска. Это поле используется с API Google Диска.

Источник

Источник вложения.

Перечисления
SOURCE_UNSPECIFIED Сдержанный.
DRIVE_FILE Это файл Google Диска.
UPLOADED_CONTENT Файл будет загружен в чат.

ссылка на вложение данных

Ссылка на данные вложения.

Поля
resource_ name

string

Необязательный. Имя ресурса данных вложения. Это поле используется с медиа-API для загрузки данных вложения.

attachment_ upload_ token

string

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

Картасид

Карточка в сообщении Google Chat.

Только приложения чата могут создавать карточки. Если ваше приложение Chat авторизуется как пользователь , сообщение не может содержать карточки.

Создавайте и просматривайте карты с помощью Card Builder.

Откройте конструктор карточек

Поля
card_ id

string

Требуется, если сообщение содержит несколько карточек. Уникальный идентификатор карты в сообщении.

card

Card

Карта. Максимальный размер — 32 КБ.

ChatSpaceLinkData

Данные для ссылок в чате.

Поля
space

string

Пространство связанного ресурса пространства чата.

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

thread

string

Ветка связанного ресурса чата.

Формат: spaces/{space}/threads/{thread}

message

string

Сообщение связанного ресурса пространства чата.

Формат: spaces/{space}/messages/{message}

Завершить импорт пространства запрос

Сообщение с запросом о завершении процесса импорта пространства.

Поля
name

string

Необходимый. Имя ресурса пространства режима импорта.

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

Комплеимпортспейсереспонс

Ответное сообщение о завершении процесса импорта пространства.

Поля
space

Space

Пространство режима импорта.

Контекстная надстройкаразметка

Этот тип не имеет полей.

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

Карта

Карточка — это элемент пользовательского интерфейса, который может содержать виджеты пользовательского интерфейса, такие как текст и изображения.

Поля
header

CardHeader

Заголовок карты. Заголовок обычно содержит заголовок и изображение.

sections[]

Section

Разделы разделены разделителем строк.

card_ actions[]

CardAction

Действия этой карты.

name

string

Название карты.

КартаДействие

Действие карты — это действие, связанное с картой. Для карточки счета-фактуры типичным действием будет: удалить счет, отправить счет по электронной почте или открыть счет в браузере.

Не поддерживается приложениями Google Chat.

Поля
action_ label

string

Метка раньше отображалась в пункте меню действий.

on_ click

OnClick

Действие onclick для этого элемента действия.

Заголовок карты

Поля
title

string

Должно быть указано название. Заголовок имеет фиксированную высоту: если указаны и заголовок, и подзаголовок, каждый занимает одну строку. Если указан только заголовок, он занимает обе строки.

subtitle

string

Подзаголовок шапки карты.

image_ style

ImageStyle

Тип изображения (например, квадратная рамка или круглая рамка).

image_ url

string

URL-адрес изображения в заголовке карточки.

Стиль изображения

Перечисления
IMAGE_STYLE_UNSPECIFIED
IMAGE Квадратная граница.
AVATAR Круглая граница.

Раздел

Раздел содержит коллекцию виджетов, которые отображаются (вертикально) в указанном порядке. На всех платформах карточки имеют узкую фиксированную ширину, поэтому в настоящее время нет необходимости в свойствах макета (например, float).

Поля
header

string

Заголовок раздела. Поддерживается форматированный текст. Дополнительную информацию о форматировании текста см. в разделах «Форматирование текста в приложениях Google Chat» и «Форматирование текста в надстройках Google Workspace» .

widgets[]

WidgetMarkup

Раздел должен содержать хотя бы один виджет.

CreateCustomEmojiRequest

Просьба создать собственный смайлик.

Поля
custom_ emoji

CustomEmoji

Необходимый. Пользовательский смайлик, который нужно создать.

Создать запрос на членство

Сообщение с запросом на создание членства.

Поля
parent

string

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

Формат: пробелы/{пробел}

membership

Membership

Необходимый. Отношение членства для создания.

memberType должно содержать пользователя с заполненными полями user.name и user.type . Сервер назначит имя ресурса и перезапишет все указанное.

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

  • При аутентификации пользователя требуется область chat.memberships .

  • При аутентификации в качестве приложения требуется область chat.app.memberships . Аутентификация в приложении доступна в

  • Задайте для user.type HUMAN и задайте user.name в формате users/{user} , где {user} может быть адресом электронной почты пользователя. Для пользователей в одной организации Workspace {user} также может быть id человека из API People или id пользователя в API каталога. Например, если идентификатор профиля пользователя People API для user@example.com — 123456789 , вы можете добавить пользователя в пространство, задав для membership.member.name users/user@example.com илиusers users/123456789 .

Для приглашения пользователей, не входящих в организацию Workspace, владеющую пространством, требуется аутентификация пользователя .

Когда приложение чата создает для себя отношение членства, оно должно быть аутентифицировано как пользователь и использовать область chat.memberships.app , установить user.type для BOT и установить user.name для users/app .

use_ admin_ access

bool

Необязательный. Когда true , метод работает с использованием привилегий администратора Google Respace пользователя.

Пользователь по вызову должен быть администратором Google Workspace с привилегией Manage CHAT и Spaces Trantings .

Требует chat.admin.memberships .

Создание членства в приложении или создание участников для пользователей за пределами организации Google Respace Administrator не поддерживается с использованием Admin Access.

CreateMessAgeRequest

Создает сообщение.

Поля
parent

string

Необходимый. Имя ресурса пространства для создания сообщения.

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

message

Message

Необходимый. Тело сообщения.

thread_key
(deprecated)

string

Необязательный. Установите: используйте thread.thread_key вместо этого. ID для потока. Поддерживает до 4000 символов. Чтобы запустить или добавить в поток, создайте сообщение и укажите threadKey или thread.name . Например, используйте, см. Запуск или ответьте на поток сообщения .

request_ id

string

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

message_ reply_ option

MessageReplyOption

Необязательный. Указывает, запускает ли сообщение поток или отвечает на один. Поддерживается только в названных пространствах.

При ответе на взаимодействие с пользователями это поле игнорируется. Для взаимодействия в потоке ответ создается в том же потоке. В противном случае ответ создан как новый поток.

message_ id

string

Необязательный. Пользовательский идентификатор для сообщения. Lets Chat Приложения получают, обновляют или удаляете сообщение без необходимости хранить идентификатор, назначенный системой, в имени ресурса сообщения (представлено в поле name сообщения»).

Значение для этого поля должно соответствовать следующим требованиям:

  • Начинается с client- . Например, client-custom-name -это действительный пользовательский идентификатор, но custom-name -нет.
  • Содержит до 63 символов и только строчные буквы, цифры и дефисы.
  • Уникален в пространстве. Приложение чата не может использовать один и тот же пользовательский идентификатор для разных сообщений.

Для получения подробной информации см. Имя сообщения .

Messagereplyoption

Указывает, как ответить на сообщение. В будущем может быть добавлено больше штатов.

Перечисление
MESSAGE_REPLY_OPTION_UNSPECIFIED По умолчанию. Запускает новую ветку. Использование этой опции игнорирует любой thread ID или thread_key , который включен.
REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD Создает сообщение в качестве ответа на поток, указанный thread ID или thread_key . Если он не удается, сообщение запускает новый поток вместо этого.
REPLY_MESSAGE_OR_FAIL Создает сообщение в качестве ответа на поток, указанный thread ID или thread_key . Если используется новый thread_key , создается новый поток. Если создание сообщения не удается, вместо этого возвращается ошибка NOT_FOUND .

CreatereActionRequest

Создает реакцию на сообщение.

Поля
parent

string

Необходимый. Сообщение, где создается реакция.

Формат: spaces/{space}/messages/{message}

reaction

Reaction

Необходимый. Реакция на создание.

CreateSpacerequest

Запрос на создание названного пространства без участников.

Поля
space

Space

Необходимый. Поля displayName и spaceType должны быть заполнены. Поддерживаются только SpaceType.SPACE и SpaceType.GROUP_CHAT . SpaceType.GROUP_CHAT может использоваться только в том случае, если importMode установлен на true.

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

name пространства назначено на сервере, поэтому все, что указано в этом поле, будет проигнорировано.

request_ id

string

Необязательный. Уникальный идентификатор для этого запроса. Рекомендуется случайный UUID. Указание существующего идентификатора запроса возвращает пространство, созданное с помощью этого идентификатора вместо создания нового пространства. Указание существующего идентификатора запроса из одного и того же приложения чата с другим аутентифицированным пользователем возвращает ошибку.

CustomeMoji

Представляет собой пользовательский смайлик.

Поля
name

string

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

Формат: customEmojis/{customEmoji}

uid

string

Только вывод. Уникальный ключ для пользовательского ресурса эмодзи.

emoji_ name

string

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

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

Имена эмодзи должны начинать и заканчиваться колонами, должны быть строчными и могут содержать только буквенно -цифровые символы, дефисы и подчеркивание. Дефисы и подставки должны использоваться для разделения слов и нельзя использовать последовательно.

Пример:: :valid-emoji-name:

temporary_ image_ uri

string

Только вывод. URL -адрес изображения для пользовательских смайликов, действительный не менее 10 минут. Обратите внимание, что это не заполняется в ответе, когда создается пользовательский смайлик.

payload

CustomEmojiPayload

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

CustomeJipayLoad

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

Поля
file_ content

bytes

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

Полезная нагрузка должна быть менее 256 т.п.н., а измерение изображения должно составлять от 64 до 500 пикселей. Ограничения могут быть изменены.

filename

string

Необходимый. Только вход. Имя файла изображения.

Поддерживаемые расширения файлов: .png , .jpg , .gif .

DeleteCustomejirequest

Запрос на удаление пользовательского смайлика.

Поля
name

string

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

Формат: customEmojis/{customEmoji}

Вы можете использовать имя эмодзи в качестве псевдонима для {customEmoji} . Например, customEmojis/:example-emoji: где :example-emoji: это имя эмодзи для пользовательского смайлика.

DeletemembershipRequest

Запрос удалить членство в пространстве.

Поля
name

string

Необходимый. Название ресурса членства для удаления. Приложения чата могут удалять пользователей людей или их собственное членство. Приложения чата не могут удалить членство других приложений.

При удалении человеческого членства требуется формат chat.memberships и spaces/{space}/members/{member} . Вы можете использовать электронное письмо в качестве псевдонима для {member} . Например, spaces/{space}/members/example@gmail.com , где example@gmail.com - электронное письмо пользователя Google Chat.

При удалении членства в приложении требуется chat.memberships.app Scope и spaces/{space}/members/app Format.

Формат: spaces/{space}/members/{member} или spaces/{space}/members/app .

use_ admin_ access

bool

Необязательный. Когда true , метод работает с использованием привилегий администратора Google Respace пользователя.

Пользователь по вызову должен быть администратором Google Workspace с привилегией Manage CHAT и Spaces Trantings .

Требует chat.admin.memberships .

Удаление членов приложения в пространстве не поддерживается с использованием доступа к администратору.

DeletemessageRequest

Запрос удалить сообщение.

Поля
name

string

Необходимый. Имя ресурса сообщения.

Формат: spaces/{space}/messages/{message}

Если вы установили пользовательский идентификатор для вашего сообщения, вы можете использовать значение из поля clientAssignedMessageId для {message} . Для получения подробной информации см. Имя сообщения .

force

bool

Необязательный. Когда true , удаление сообщения также удаляет свои резьбовые ответы. Когда false , если сообщение имеет резьбовые ответы, удаление не удается.

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

DeletereActionRequest

Удаляет реакцию на сообщение.

Поля
name

string

Необходимый. Название реакции на удаление.

Формат: spaces/{space}/messages/{message}/reactions/{reaction}

DeleteSpacerequest

Запрос на удаление места.

Поля
name

string

Необходимый. Название ресурса пространства для удаления.

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

use_ admin_ access

bool

Необязательный. Когда true , метод работает с использованием привилегий администратора Google Respace пользователя.

Пользователь по вызову должен быть администратором Google Workspace с привилегией Manage CHAT и Spaces Trantings .

Требует chat.admin.delete .

DeletionMetadata

Информация о удаленном сообщении. Сообщение удаляется при установке delete_time .

Поля
deletion_ type

DeletionType

Указывает, кто удалил сообщение.

DeletionType

Кто удалил сообщение и как оно было удалено. В будущем может быть добавлено больше значений.

Перечисление
DELETION_TYPE_UNSPECIFIED Это значение не используется.
CREATOR Пользователь удалил свое собственное сообщение.
SPACE_OWNER Владелец пространства удалил сообщение.
ADMIN Администратор Google Workspace удалил сообщение.
APP_MESSAGE_EXPIRY Приложение чата удалило собственное сообщение, когда оно истек.
CREATOR_VIA_APP Приложение чата удалило сообщение от имени пользователя.
SPACE_OWNER_VIA_APP Приложение чата удалило сообщение от имени владельца пространства.

Диалог

Обертка вокруг корпуса карты диалога.

Поля
body

Card

Только вход. Тело диалога, которое отображается в модале. Приложения Google Chat не поддерживают следующие карты: DateTimePicker , OnChangeAction .

Диалог

Содержит диалог и код состояния запроса.

Поля
action_ status

ActionStatus

Только вход. Статус для запроса либо вызвать, либо отправить диалог . Отображает статус и сообщение пользователям, если это необходимо. Например, в случае ошибки или успеха.

Союзное полевое action . Действие для выполнения. action может быть только одним из следующих:
dialog

Dialog

Только вход. Диалог для запроса.

DRIEDATAREF

Ссылка на данные привязанности к дисков.

Поля
drive_ file_ id

string

Идентификатор для файла диска. Используйте с приводом API.

DRIVELINKDATA

Данные для ссылок на Google Drive.

Поля
drive_ data_ ref

DriveDataRef

DriedAtaref , который ссылается на файл Google Drive.

mime_ type

string

Тип MIME связанного ресурса Google Drive.

Эмодзи

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

Поля
Полевой content союза. Необходимый. Содержание эмодзи. content может быть только одним из следующих:
unicode

string

Необязательный. Основные смайлики, представленные строкой Unicode.

custom_ emoji

CustomEmoji

Только вывод. Пользовательский смайлик.

Эмодзиреатзамман

Количество людей, которые отреагировали на сообщение с определенным смайликом.

Поля
emoji

Emoji

Только вывод. Эмодзи, связанные с реакциями.

reaction_ count

int32

Только вывод. Общее количество реакций с использованием связанных эмодзи.

FindDirectMessAgeRequest

Запрос на получение прямого пространства сообщений на основе пользовательского ресурса.

Поля
name

string

Необходимый. Имя ресурса пользователя, чтобы найти прямое сообщение.

Format: users/{user} , где {user} является либо id для человека из API People, либо id для пользователя в API каталогов. Например, если идентификатор профиля People API составляет 123456789 , вы можете найти прямое сообщение с этим человеком, используя users/123456789 в качестве name . Когда вы аутентифицированы как пользователь , вы можете использовать электронную почту в качестве псевдонима для {user} . Например, users/example@gmail.com , где example@gmail.com - это письмо пользователя Google Chat.

GetAttachmentRequest

Просьба получить вложение.

Поля
name

string

Необходимый. Имя ресурса вложения, в spaces/{space}/messages/{message}/attachments/{attachment} .

GetCustomeJirequest

Запрос на возврат одного пользовательского смайлика.

Поля
name

string

Необходимый. Название ресурса пользовательского смайлика.

Формат: customEmojis/{customEmoji}

Вы можете использовать имя эмодзи в качестве псевдонима для {customEmoji} . Например, customEmojis/:example-emoji: где :example-emoji: это имя эмодзи для пользовательского смайлика.

GetMembershipRequest

Запрос получить членство в пространстве.

Поля
name

string

Необходимый. Название ресурса членства для извлечения.

Чтобы получить собственное членство в приложении с помощью аутентификации пользователя , вы можете при желании использовать spaces/{space}/members/app .

Формат: spaces/{space}/members/{member} или spaces/{space}/members/app

Вы можете использовать электронную почту пользователя в качестве псевдонима для {member} . Например, spaces/{space}/members/example@gmail.com , где example@gmail.com - электронное письмо пользователя Google Chat.

use_ admin_ access

bool

Необязательный. Когда true , метод работает с использованием привилегий администратора Google Respace пользователя.

Пользователь по вызову должен быть администратором Google Workspace с привилегией Manage CHAT и Spaces Trantings .

Требует chat.admin.memberships или chat.admin.memberships.readonly .

Получение членства в приложении в пространстве не поддерживается при использовании доступа к администратору.

GetMessageRequest

Запрос получить сообщение.

Поля
name

string

Необходимый. Имя ресурса сообщения.

Формат: spaces/{space}/messages/{message}

Если вы установили пользовательский идентификатор для вашего сообщения, вы можете использовать значение из поля clientAssignedMessageId для {message} . Для получения подробной информации см. Имя сообщения .

GetSpaceEventRequest

Запросить сообщение о получении космического мероприятия.

Поля
name

string

Необходимый. Название ресурса космического события.

Формат: spaces/{space}/spaceEvents/{spaceEvent}

GetSpacenotificationsettingRequest

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

Поля
name

string

Необходимый. Формат: users/{user}/spaces/{space}/spacenotificationsetting

  • users/me/spaces/{space}/spaceNotificationSetting , или
  • users/user@example.com/spaces/{space}/spaceNotificationSetting /spacenotificationsetting, или
  • users/123456789/spaces/{space}/spaceNotificationSetting . Примечание. На пути разрешен только идентификатор пользователя или электронную почту вызывающего абонента.

GetSpacereadStateRequest

Запросить сообщение для API GetSpacereadState.

Поля
name

string

Необходимый. Название ресурса Космического чтения состояния для извлечения.

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

Чтобы обозначить пользователя по вызову, установите одно из следующих:

  • me псевдоним. Например, users/me/spaces/{space}/spaceReadState .

  • Их адрес электронной почты рабочей области. Например, users/user@example.com/spaces/{space}/spaceReadState /spacereadstate.

  • Их идентификатор пользователя. Например, users/123456789/spaces/{space}/spaceReadState .

Формат: users/{user}/spaces/{space}/spacereadstate

GetSpacerequest

Просьба вернуть одно пространство.

Поля
name

string

Необходимый. Имя ресурса пространства, в формах Form spaces/{space} .

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

use_ admin_ access

bool

Необязательный. Когда true , метод работает с использованием привилегий администратора Google Respace пользователя.

Пользователь по вызову должен быть администратором Google Workspace с привилегией Manage CHAT и Spaces Trantings .

chat.admin.spaces.readonly chat.admin.spaces .

GetThreadReadStateRequest

Запросить сообщение о GetThreadReadStateRequest API.

Поля
name

string

Необходимый. Название ресурса потока считываем состояние для извлечения.

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

Чтобы обозначить пользователя по вызову, установите одно из следующих:

  • me псевдоним. Например, users/me/spaces/{space}/threads/{thread}/threadReadState .

  • Их адрес электронной почты рабочей области. Например, users/user@example.com/spaces/{space}/threads/{thread}/threadReadState /threads/{ the Readure/threadReadState.

  • Их идентификатор пользователя. Например, users/123456789/spaces/{space}/threads/{thread}/threadReadState .

Format: users/{user}/spaces/{space}/threads/{thread}/threadReadState

Группа

Группа Google в чате Google.

Поля
name

string

Имя ресурса для группы Google.

Представляет группу в группе облачных идентификаторов API.

Формат: группы/{группа}

ИСТОРИЯ

Государство истории для сообщений и пространств. Определяет, как долго хранятся сообщения и беседы после создания.

Перечисление
HISTORY_STATE_UNSPECIFIED Значение по умолчанию. Не используйте.
HISTORY_OFF История выключена. Сообщения и потоки хранятся в течение 24 часов .
HISTORY_ON История на. Правила удержания хранилища организации указывают, как долго хранятся сообщения и потоки.

Listcustomejisrequest

Запрос на возврат списка пользовательских смайликов.

Поля
page_ size

int32

Необязательный. Максимальное количество пользовательских смайликов вернулось. Сервис может вернуть меньше пользовательских смайликов, чем это значение. В случае неопределенности значение по умолчанию составляет 25. Максимальное значение составляет 200; Значения выше 200 изменяются на 200.

page_ token

string

Необязательный. (Если возобновить из предыдущего запроса.)

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

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

filter

string

Необязательный. Фильтр запросов.

Поддерживает фильтрацию создателем.

Чтобы фильтровать создателем, вы должны указать достоверное значение. В настоящее время только creator("users/me") , а NOT creator("users/me") принимаются для фильтрации пользовательских смайликов по тому, были ли они созданы звонком или нет.

Например, следующий запрос возвращает пользовательские смайлики, созданные абонентом:

creator("users/me")

Неверные запросы отклоняются сервером с ошибкой INVALID_ARGUMENT .

Listcustomejisresponse

Ответ на список пользовательских смайликов.

Поля
custom_ emojis[]

CustomEmoji

Неупомянутый список. Список пользовательских смайликов на запрошенной (или первой) странице.

next_ page_ token

string

Токен, который вы можете отправить в качестве pageToken , чтобы получить следующую страницу результатов. Если пустые, нет последующих страниц.

Listmembershipsrequest

Запросить сообщение о перечислении членства.

Поля
parent

string

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

Формат: пространства/{пространство}

page_ size

int32

Необязательный. Максимальное количество членов для возврата. Сервис может вернуть меньше этого значения.

В случае неопределенности, не более 100 членов возвращаются.

Максимальное значение составляет 1000. Если вы используете значение более 1000, оно автоматически изменяется на 1000.

Отрицательные значения возвращают ошибку INVALID_ARGUMENT .

page_ token

string

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

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

filter

string

Необязательный. Фильтр запросов.

Вы можете отфильтровать членство с помощью роли ( role ) члена и типа ( member.type ).

Чтобы фильтровать по роли, установить role в ROLE_MEMBER или ROLE_MANAGER .

Чтобы фильтровать по типу, установите member.type на HUMAN или BOT . Вы также можете отфильтровать для member.type с помощью оператора != .

Чтобы отфильтровать как роли, так и типом, используйте AND оператор. Чтобы фильтровать по роли или типу, используйте OR оператор.

Либо use_admin_access member.type = "HUMAN" или member.type != "BOT" Другие фильтры типа участника будут отклонены.

Например, следующие запросы действительны:

role = "ROLE_MANAGER" OR role = "ROLE_MEMBER"
member.type = "HUMAN" AND role = "ROLE_MANAGER"

member.type != "BOT"

Следующие запросы недействительны:

member.type = "HUMAN" AND member.type = "BOT"
role = "ROLE_MANAGER" AND role = "ROLE_MEMBER"

Неверные запросы отклоняются сервером с ошибкой INVALID_ARGUMENT .

show_ groups

bool

Необязательный. Когда true также возвращает членство, связанное с Google Group , в дополнение к другим типам членства. Если установлен filter , членство Google Group , которое не соответствует критериям фильтра, не возвращаются.

show_ invited

bool

Необязательный. Когда true , также возвращает членство, связанное с invited членами, в дополнение к другим типам членства. Если устанавливается фильтр, invited членства, которые не соответствуют критериям фильтра, не возвращаются.

В настоящее время требуется аутентификация пользователя .

use_ admin_ access

bool

Необязательный. Когда true , метод работает с использованием привилегий администратора Google Respace пользователя.

Пользователь по вызову должен быть администратором Google Workspace с привилегией Manage CHAT и Spaces Trantings .

Требует chat.admin.memberships chat.admin.memberships.readonly .

Перечисление участников приложения в пространстве не поддерживается при использовании доступа к администратору.

Listmembershipsresponse

Ответ на членство в списке пространства.

Поля
memberships[]

Membership

Неупомянутый список. Список членов на запрошенной (или первой) странице.

next_ page_ token

string

Токен, который вы можете отправить в качестве pageToken , чтобы получить следующую страницу результатов. Если пустые, нет последующих страниц.

ListMessagesRequest

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

Поля
parent

string

Необходимый. Имя ресурса пространства для перечисления сообщений.

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

page_ size

int32

Необязательный. Максимальное количество сообщений возвращалось. Служба может вернуть меньше сообщений, чем это значение.

Если не указано, не более 25 возвращаются.

Максимальное значение составляет 1000. Если вы используете значение более 1000, оно автоматически изменяется на 1000.

Отрицательные значения возвращают ошибку INVALID_ARGUMENT .

page_ token

string

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

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

filter

string

Необязательный. Фильтр запросов.

Вы можете отфильтровать сообщения по дате ( create_time ) и поток ( thread.name ).

Чтобы отфильтровать сообщения до даты, которую они были созданы, укажите The create_time с временной меткой в ​​формате RFC-3339 и двойных кавычках. Например, "2023-04-21T11:30:00-04:00" . Вы можете использовать больше, чем оператор > для перечисления сообщений, которые были созданы после метки времени, или меньше, чем оператор < для перечисления сообщений, которые были созданы до метки времени. Чтобы отфильтровать сообщения в интервал времени, используйте AND оператор между двумя временными метками.

Чтобы отфильтровать по потоку, укажите thread.name , отформатированный как spaces/{space}/threads/{thread} . Вы можете указать только один thread.name . Название за запрос.

Чтобы фильтровать по потоке и дате, используйте AND оператор в своем запросе.

Например, следующие запросы действительны:

create_time > "2012-04-21T11:30:00-04:00"

create_time > "2012-04-21T11:30:00-04:00" AND
  thread.name = spaces/AAAAAAAAAAA/threads/123

create_time > "2012-04-21T11:30:00+00:00" AND

create_time < "2013-01-01T00:00:00+00:00" AND
  thread.name = spaces/AAAAAAAAAAA/threads/123

thread.name = spaces/AAAAAAAAAAA/threads/123

Неверные запросы отклоняются сервером с ошибкой INVALID_ARGUMENT .

order_ by

string

Необязательный. Как упорядочен список сообщений. Укажите значение по заказу с помощью операции заказа. Допустимые значения операции заказа следующие:

  • ASC для восхождения.

  • DESC для спуска.

Порядок по умолчанию - create_time ASC .

show_ deleted

bool

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

ListMessagesResponse

Ответ Сообщение для перечисления сообщений.

Поля
messages[]

Message

Список сообщений.

next_ page_ token

string

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

ListreactionSrequest

Перечисляет реакцию на сообщение.

Поля
parent

string

Необходимый. Пользователи сообщений отреагировали на.

Формат: spaces/{space}/messages/{message}

page_ size

int32

Необязательный. Максимальное количество реакций возвращается. Служба может вернуть меньше реакций, чем это значение. В случае неопределенности значение по умолчанию составляет 25. Максимальное значение составляет 200; Значения выше 200 изменяются на 200.

page_ token

string

Необязательный. (Если возобновить из предыдущего запроса.)

Токен страницы, полученный из предыдущего вызова реакций списка. Предоставьте это, чтобы получить последующую страницу.

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

filter

string

Необязательный. Фильтр запросов.

Вы можете отфильтровать реакции с помощью Emoji (либо emoji.unicode , либо emoji.custom_emoji.uid ) и user ( user.name ).

Чтобы отфильтровать реакции для нескольких смайликов или пользователей, присоединяйтесь к аналогичным полям с оператором OR оператором, такими как emoji.unicode = "🙂" OR emoji.unicode = "👍" и user.name = "users/AAAAAA" OR user.name = "users/BBBBBB" .

Чтобы отфильтровать реакции с помощью Emoji и пользователя, используйте AND оператор, такой как emoji.unicode = "🙂" AND user.name = "users/AAAAAA" .

Если ваш запрос использует как AND OR , сгруппируйте их с скобками.

Например, следующие запросы действительны:

user.name = "users/{user}"
emoji.unicode = "🙂"
emoji.custom_emoji.uid = "{uid}"
emoji.unicode = "🙂" OR emoji.unicode = "👍"
emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}"
emoji.unicode = "🙂" AND user.name = "users/{user}"
(emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}")
AND user.name = "users/{user}"

Следующие запросы недействительны:

emoji.unicode = "🙂" AND emoji.unicode = "👍"
emoji.unicode = "🙂" AND emoji.custom_emoji.uid = "{uid}"
emoji.unicode = "🙂" OR user.name = "users/{user}"
emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}" OR
user.name = "users/{user}"
emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}"
AND user.name = "users/{user}"

Неверные запросы отклоняются сервером с ошибкой INVALID_ARGUMENT .

ListreactionSresponse

Ответ на запрос на реакцию списка.

Поля
reactions[]

Reaction

Список реакций на запрошенной (или первой) странице.

next_ page_ token

string

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

Listspaceeventsrequest

Запросить сообщение о перечислении космических событий.

Поля
parent

string

Необходимый. Название ресурса в чате Google , где произошли события.

Формат: spaces/{space} .

page_ size

int32

Необязательный. Максимальное количество космических событий возвращалось. Сервис может вернуть меньше этого значения.

Отрицательные значения возвращают ошибку INVALID_ARGUMENT .

page_ token

string

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

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

filter

string

Необходимый. Фильтр запросов.

Вы должны указать хотя бы один тип события ( event_type ), используя оператор HASE : Чтобы отфильтровать по нескольким типам событий, используйте оператор OR . Опустите типы событий партии в вашем фильтре. Запрос автоматически возвращает любые связанные пакетные события. Например, если вы фильтровали новые реакции ( google.workspace.chat.reaction.v1.created ), сервер также возвращает партии новых событий реакций ( google.workspace.chat.reaction.v1.batchCreated ). Список поддерживаемых типов событий см. В справочной документации SpaceEvents .

При желании вы также можете отфильтровать по времени начала ( start_time ) и времени окончания ( end_time ):

  • start_time : Exclusive TimeStamp, с которой можно начать список космических событий. Вы можете перечислить события, которые произошли до 28 дней назад. Если не указано, перечисляет космические события за последние 28 дней.
  • end_time : включающая временная метка до тех пор, пока не будут перечислены космические события. В случае неопределенности перечислены события до времени запроса.

Чтобы указать время начала или окончания, используйте оператор Equals = Format в RFC-3339 . Чтобы отфильтровать как на start_time , так и end_time , используйте AND оператор.

Например, следующие запросы действительны:

start_time="2023-08-23T19:20:33+00:00" AND
end_time="2023-08-23T19:21:54+00:00"

start_time="2023-08-23T19:20:33+00:00" AND
(event_types:"google.workspace.chat.space.v1.updated" OR
event_types:"google.workspace.chat.message.v1.created")

Следующие запросы недействительны: 

start_time="2023-08-23T19:20:33+00:00" OR
end_time="2023-08-23T19:21:54+00:00"

event_types:"google.workspace.chat.space.v1.updated" AND
event_types:"google.workspace.chat.message.v1.created"

Неверные запросы отклоняются сервером с ошибкой INVALID_ARGUMENT .

ListSpaceEventsResponse

Ответ Сообщение для перечисления космических событий.

Поля
space_ events[]

SpaceEvent

Результаты возвращаются в хронологическом порядке (сначала самое старое событие). ПРИМЕЧАНИЕ. Поле permissionSettings не возвращается в объекте Space для запросов списка.

next_ page_ token

string

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

ListspacesRequest

Запрос на перечисление пространств, которым является абонент.

Поля
page_ size

int32

Необязательный. Максимальное количество пробелов для возврата. Сервис может вернуть меньше этого значения.

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

Максимальное значение составляет 1000. Если вы используете значение более 1000, оно автоматически изменяется на 1000.

Отрицательные значения возвращают ошибку INVALID_ARGUMENT .

page_ token

string

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

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

filter

string

Необязательный. Фильтр запросов.

Вы можете отфильтровать пространства по типу пространства ( space_type ).

Чтобы отфильтровать по типу пространства, вы должны указать допустимое значение Enum, такое как SPACE или GROUP_CHAT ( space_type не может быть SPACE_TYPE_UNSPECIFIED ). Чтобы запросить несколько типов пространства, используйте оператор OR .

Например, следующие запросы действительны: 

space_type = "SPACE"
spaceType = "GROUP_CHAT" OR spaceType = "DIRECT_MESSAGE"

Неверные запросы отклоняются сервером с ошибкой INVALID_ARGUMENT .

Listspacesresponse

Ответ на запрос списков.

Поля
spaces[]

Space

Список пробелов на запрошенной (или первой) странице. ПРИМЕЧАНИЕ. Поле permissionSettings не возвращается в объекте Space для запросов списка.

next_ page_ token

string

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

Matchedurl

Соответствующий URL в сообщении в чате. Приложения чата могут предварительно просмотреть соответствующие URL -адреса. Для получения дополнительной информации см. Предварительные ссылки .

Поля
url

string

Только вывод. URL, который был сопоставлен.

Членство

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

Поля
name

string

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

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

state

MembershipState

Только вывод. Состояние членства.

role

MembershipRole

Необязательный. Роль пользователя в пространстве чата, которая определяет их разрешенные действия в пространстве.

Это поле можно использовать только в качестве ввода в UpdateMembership .

create_ time

Timestamp

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

delete_ time

Timestamp

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

Union Field memberType . Участник связан с этим членством. Другие типы участников могут быть поддержаны в будущем. memberType может быть только одним из следующих:
member

User

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

group_ member

Group

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

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

Членство

Представляет разрешенные действия пользователя в пространстве чата. Больше значений Enum может быть добавлено в будущем.

Перечисление
MEMBERSHIP_ROLE_UNSPECIFIED Значение по умолчанию. Для users : они не являются членом пространства, но могут быть приглашены. Для Google Groups : им всегда присваивается эта роль (другие значения перечисления могут использоваться в будущем).
ROLE_MEMBER Член пространства. У пользователя есть основные разрешения, такие как отправка сообщений в пространство. В 1: 1 и безымянных групповых разговорах у каждого есть эта роль.
ROLE_MANAGER Космический менеджер. У пользователя есть все основные разрешения плюс административные разрешения, которые позволяют им управлять пространством, например, добавление или удаление участников. Поддерживается только в SpaceType.SPACE .

Членство

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

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

Членство BATCHCREATEDEVENTDATA

Полезная нагрузка на событие для нескольких новых членов.

Тип события: google.workspace.chat.membership.v1.batchCreated

Поля
memberships[]

MembershipCreatedEventData

Список новых членов.

Членство BatchdeleteDeventData

Полезная нагрузка на событие для нескольких удаленных членов.

Тип события: google.workspace.chat.membership.v1.batchDeleted

Поля
memberships[]

MembershipDeletedEventData

Список удаленных членов.

Членство BBATCHUPDATEDEVENTDATA

Полезная нагрузка на событие для нескольких обновленных членов.

Тип события: google.workspace.chat.membership.v1.batchUpdated

Поля
memberships[]

MembershipUpdatedEventData

Список обновленных членов.

Членство CREATEDEVENTDATA

Полезная нагрузка на событие для нового членства.

Тип события: google.workspace.chat.membership.v1.created .

Поля
membership

Membership

Новое членство.

Членатделевендата

Полезная нагрузка на мероприятие для удаленного членства.

Тип события: google.workspace.chat.membership.v1.deleted

Поля
membership

Membership

Удаленное членство. Только name и state поля заполнены.

Член и поступил

Полезная нагрузка на событие для обновленного членства.

Тип события: google.workspace.chat.membership.v1.updated

Поля
membership

Membership

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

Сообщение

Сообщение в пространстве чата Google.

Поля
name

string

Идентификатор. Имя ресурса сообщения.

Формат: spaces/{space}/messages/{message}

Где {space} -это идентификатор пространства, в котором публикуется сообщение, а {message} -это идентификатор, посвященный системе для сообщения. Например, spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB .

Если вы установите пользовательский идентификатор при создании сообщения, вы можете использовать этот идентификатор для указания сообщения в запросе, заменив {message} на поле clientAssignedMessageId . Например, spaces/AAAAAAAAAAA/messages/client-custom-name . Для получения подробной информации см. Имя сообщения .

sender

User

Только вывод. Пользователь, который создал сообщение. Если ваше приложение в чате аутентифицируется как пользователь , вывод популяет name пользователя и type .

create_ time

Timestamp

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

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

last_ update_ time

Timestamp

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

delete_ time

Timestamp

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

text

string

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

Чтобы узнать о создании текстовых сообщений, см. Отправить сообщение .

formatted_ text

string

Только вывод. Содержит text сообщения с разметками, добавленными для передачи форматирования. Это поле может не захватить все форматирование, видимое в пользовательском интерфейсе, но включает в себя следующее:

  • Синтаксис разметки для жирного шрифта, курсивного, ударного, монопрояжника, блока монопроизводства и списка с маркировкой.

  • Пользователь упоминает, используя формат <users/{user}> .

  • Пользовательские гиперссылки с использованием формата <{url}|{rendered_text}> , где первая строка - URL, а вторая - текст рендеринга - например, <http://example.com|custom text> .

  • Custom emoji using the format :{emoji_name}: —for example, :smile: . This doesn't apply to Unicode emoji, such as U+1F600 for a grinning face emoji.

For more information, see View text formatting sent in a message

cards[]
(deprecated)

Card

Deprecated: Use cards_v2 instead.

Rich, formatted, and interactive cards that you can use to display UI elements such as: formatted texts, buttons, and clickable images. Cards are normally displayed below the plain-text body of the message. cards and cards_v2 can have a maximum size of 32 KB.

cards_ v2[]

CardWithId

Необязательный. An array of cards .

Only Chat apps can create cards. If your Chat app authenticates as a user , the messages can't contain cards.

To learn how to create a message that contains cards, see Send a message .

Design and preview cards with the Card Builder.

Open the Card Builder

annotations[]

Annotation

Output only. Annotations associated with the text in this message.

thread

Thread

The thread the message belongs to. For example usage, see Start or reply to a message thread .

space

Space

Output only. If your Chat app authenticates as a user , the output only populates the space name .

fallback_ text

string

Необязательный. A plain-text description of the message's cards, used when the actual cards can't be displayed—for example, mobile notifications.

action_ response

ActionResponse

Input only. Parameters that a Chat app can use to configure how its response is posted.

argument_ text

string

Output only. Plain-text body of the message with all Chat app mentions stripped out.

slash_ command

SlashCommand

Output only. Slash command information, if applicable.

attachment[]

Attachment

Необязательный. User-uploaded attachment.

matched_ url

MatchedUrl

Output only. A URL in spaces.messages.text that matches a link preview pattern. For more information, see Preview links .

thread_ reply

bool

Output only. When true , the message is a response in a reply thread. When false , the message is visible in the space's top-level conversation as either the first message of a thread or a message with no threaded replies.

If the space doesn't support reply in threads, this field is always false .

client_ assigned_ message_ id

string

Необязательный. A custom ID for the message. You can use field to identify a message, or to get, delete, or update a message. To set a custom ID, specify the messageId field when you create the message. For details, see Name a message .

emoji_ reaction_ summaries[]

EmojiReactionSummary

Output only. The list of emoji reaction summaries on the message.

private_ message_ viewer

User

Необязательный. Immutable. Input for creating a message, otherwise output only. The user that can view the message. When set, the message is private and only visible to the specified user and the Chat app. To include this field in your request, you must call the Chat API using app authentication and omit the following:

For details, see Send a message privately .

deletion_ metadata

DeletionMetadata

Output only. Information about a deleted message. A message is deleted when delete_time is set.

quoted_ message_ metadata

QuotedMessageMetadata

Output only. Information about a message that's quoted by a Google Chat user in a space. Google Chat users can quote a message to reply to it.

attached_ gifs[]

AttachedGif

Output only. GIF images that are attached to the message.

accessory_ widgets[]

AccessoryWidget

Необязательный. One or more interactive widgets that appear at the bottom of a message. You can add accessory widgets to messages that contain text, cards, or both text and cards. Not supported for messages that contain dialogs. For details, see Add interactive widgets at the bottom of a message .

Creating a message with accessory widgets requires app authentication .

MessageBatchCreatedEventData

Event payload for multiple new messages.

Event type: google.workspace.chat.message.v1.batchCreated

Поля
messages[]

MessageCreatedEventData

A list of new messages.

MessageBatchDeletedEventData

Event payload for multiple deleted messages.

Event type: google.workspace.chat.message.v1.batchDeleted

Поля
messages[]

MessageDeletedEventData

A list of deleted messages.

MessageBatchUpdatedEventData

Event payload for multiple updated messages.

Event type: google.workspace.chat.message.v1.batchUpdated

Поля
messages[]

MessageUpdatedEventData

A list of updated messages.

MessageCreatedEventData

Event payload for a new message.

Event type: google.workspace.chat.message.v1.created

Поля
message

Message

The new message.

MessageDeletedEventData

Event payload for a deleted message.

Event type: google.workspace.chat.message.v1.deleted

Поля
message

Message

The deleted message. Only the name , createTime , deleteTime , and deletionMetadata fields are populated.

MessageUpdatedEventData

Event payload for an updated message.

Event type: google.workspace.chat.message.v1.updated

Поля
message

Message

The updated message.

QuotedMessageMetadata

Information about a quoted message.

Поля
name

string

Output only. Resource name of the quoted message.

Format: spaces/{space}/messages/{message}

last_ update_ time

Timestamp

Output only. The timestamp when the quoted message was created or when the quoted message was last updated.

Reaction

A reaction to a message.

Поля
name

string

Идентификатор. The resource name of the reaction.

Format: spaces/{space}/messages/{message}/reactions/{reaction}

user

User

Output only. The user who created the reaction.

emoji

Emoji

Необходимый. The emoji used in the reaction.

ReactionBatchCreatedEventData

Event payload for multiple new reactions.

Event type: google.workspace.chat.reaction.v1.batchCreated

Поля
reactions[]

ReactionCreatedEventData

A list of new reactions.

ReactionBatchDeletedEventData

Event payload for multiple deleted reactions.

Event type: google.workspace.chat.reaction.v1.batchDeleted

Поля
reactions[]

ReactionDeletedEventData

A list of deleted reactions.

ReactionCreatedEventData

Event payload for a new reaction.

Event type: google.workspace.chat.reaction.v1.created

Поля
reaction

Reaction

The new reaction.

ReactionDeletedEventData

Event payload for a deleted reaction.

Type: google.workspace.chat.reaction.v1.deleted

Поля
reaction

Reaction

The deleted reaction.

RichLinkMetadata

A rich link to a resource.

Поля
uri

string

The URI of this link.

Union field data . Data for the linked resource. data can be only one of the following:

RichLinkType

The rich link type. More types might be added in the future.

Enums
DRIVE_FILE A Google Drive rich link type.
CHAT_SPACE A Chat space rich link type. For example, a space smart chip.

SearchSpacesRequest

Request to search for a list of spaces based on a query.

Поля
use_ admin_ access

bool

When true , the method runs using the user's Google Workspace administrator privileges.

The calling user must be a Google Workspace administrator with the manage chat and spaces conversations privilege .

Requires either the chat.admin.spaces.readonly or chat.admin.spaces OAuth 2.0 scope .

This method currently only supports admin access, thus only true is accepted for this field.

page_ size

int32

The maximum number of spaces to return. The service may return fewer than this value.

If unspecified, at most 100 spaces are returned.

The maximum value is 1000. If you use a value more than 1000, it's automatically changed to 1000.

page_ token

string

A token, received from the previous search spaces call. Provide this parameter to retrieve the subsequent page.

When paginating, all other parameters provided should match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results.

query

string

Необходимый. A search query.

You can search by using the following parameters:

  • create_time
  • customer
  • display_name
  • external_user_allowed
  • last_active_time
  • space_history_state
  • space_type

create_time and last_active_time accept a timestamp in RFC-3339 format and the supported comparison operators are: = , < , > , <= , >= .

customer is required and is used to indicate which customer to fetch spaces from. customers/my_customer is the only supported value.

display_name only accepts the HAS ( : ) operator. The text to match is first tokenized into tokens and each token is prefix-matched case-insensitively and independently as a substring anywhere in the space's display_name . For example, Fun Eve matches Fun event or The evening was fun , but not notFun event or even .

external_user_allowed accepts either true or false .

space_history_state only accepts values from the historyState field of a space resource.

space_type is required and the only valid value is SPACE .

Across different fields, only AND operators are supported. A valid example is space_type = "SPACE" AND display_name:"Hello" and an invalid example is space_type = "SPACE" OR display_name:"Hello" .

Among the same field, space_type doesn't support AND or OR operators. display_name , 'space_history_state', and 'external_user_allowed' only support OR operators. last_active_time and create_time support both AND and OR operators. AND can only be used to represent an interval, such as last_active_time < "2022-01-01T00:00:00+00:00" AND last_active_time > "2023-01-01T00:00:00+00:00" .

The following example queries are valid: 

customer = "customers/my_customer" AND space_type = "SPACE"

customer = "customers/my_customer" AND space_type = "SPACE" AND
display_name:"Hello World"

customer = "customers/my_customer" AND space_type = "SPACE" AND
(last_active_time < "2020-01-01T00:00:00+00:00" OR last_active_time >
"2022-01-01T00:00:00+00:00")

customer = "customers/my_customer" AND space_type = "SPACE" AND
(display_name:"Hello World" OR display_name:"Fun event") AND
(last_active_time > "2020-01-01T00:00:00+00:00" AND last_active_time <
"2022-01-01T00:00:00+00:00")

customer = "customers/my_customer" AND space_type = "SPACE" AND
(create_time > "2019-01-01T00:00:00+00:00" AND create_time <
"2020-01-01T00:00:00+00:00") AND (external_user_allowed = "true") AND
(space_history_state = "HISTORY_ON" OR space_history_state = "HISTORY_OFF")
order_ by

string

Необязательный. How the list of spaces is ordered.

Supported attributes to order by are:

  • membership_count.joined_direct_human_user_count — Denotes the count of human users that have directly joined a space.
  • last_active_time — Denotes the time when last eligible item is added to any topic of this space.
  • create_time — Denotes the time of the space creation.

Valid ordering operation values are:

  • ASC for ascending. Default value.

  • DESC for descending.

The supported syntax are:

  • membership_count.joined_direct_human_user_count DESC
  • membership_count.joined_direct_human_user_count ASC
  • last_active_time DESC
  • last_active_time ASC
  • create_time DESC
  • create_time ASC

SearchSpacesResponse

Response with a list of spaces corresponding to the search spaces request.

Поля
spaces[]

Space

A page of the requested spaces.

next_ page_ token

string

A token that can be used to retrieve the next page. If this field is empty, there are no subsequent pages.

total_ size

int32

The total number of spaces that match the query, across all pages. If the result is over 10,000 spaces, this value is an estimate.

SetUpSpaceRequest

Request to create a space and add specified users to it.

Поля
space

Space

Необходимый. The Space.spaceType field is required.

To create a space, set Space.spaceType to SPACE and set Space.displayName . If you receive the error message ALREADY_EXISTS when setting up a space, try a different displayName . An existing space within the Google Workspace organization might already use this display name.

To create a group chat, set Space.spaceType to GROUP_CHAT . Don't set Space.displayName .

To create a 1:1 conversation between humans, set Space.spaceType to DIRECT_MESSAGE and set Space.singleUserBotDm to false . Don't set Space.displayName or Space.spaceDetails .

To create an 1:1 conversation between a human and the calling Chat app, set Space.spaceType to DIRECT_MESSAGE and Space.singleUserBotDm to true . Don't set Space.displayName or Space.spaceDetails .

If a DIRECT_MESSAGE space already exists, that space is returned instead of creating a new space.

request_ id

string

Необязательный. A unique identifier for this request. A random UUID is recommended. Specifying an existing request ID returns the space created with that ID instead of creating a new space. Specifying an existing request ID from the same Chat app with a different authenticated user returns an error.

memberships[]

Membership

Необязательный. The Google Chat users or groups to invite to join the space. Omit the calling user, as they are added automatically.

The set currently allows up to 20 memberships (in addition to the caller).

For human membership, the Membership.member field must contain a user with name populated (format: users/{user} ) and type set to User.Type.HUMAN . You can only add human users when setting up a space (adding Chat apps is only supported for direct message setup with the calling app). You can also add members using the user's email as an alias for {user}. For example, the user.name can be users/example@gmail.com . To invite Gmail users or users from external Google Workspace domains, user's email must be used for {user} .

For Google group membership, the Membership.group_member field must contain a group with name populated (format groups/{group} ). You can only add Google groups when setting Space.spaceType to SPACE .

Optional when setting Space.spaceType to SPACE .

Required when setting Space.spaceType to GROUP_CHAT , along with at least two memberships.

Required when setting Space.spaceType to DIRECT_MESSAGE with a human user, along with exactly one membership.

Must be empty when creating a 1:1 conversation between a human and the calling Chat app (when setting Space.spaceType to DIRECT_MESSAGE and Space.singleUserBotDm to true ).

SlashCommand

A slash command in Google Chat.

Поля
command_ id

int64

The ID of the slash command invoked.

SlashCommandMetadata

Annotation metadata for slash commands (/).

Поля
bot

User

The Chat app whose command was invoked.

type

Type

The type of slash command.

command_ name

string

The name of the invoked slash command.

command_ id

int64

The command ID of the invoked slash command.

triggers_ dialog

bool

Indicates whether the slash command is for a dialog.

Тип

Enums
TYPE_UNSPECIFIED Default value for the enum. Не используйте.
ADD Add Chat app to space.
INVOKE Invoke slash command in space.

Космос

A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app.

Поля
name

string

Идентификатор. Resource name of the space.

Format: spaces/{space}

Where {space} represents the system-assigned ID for the space. You can obtain the space ID by calling the spaces.list() method or from the space URL. For example, if the space URL is https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA , the space ID is AAAAAAAAA .

type
(deprecated)

Type

Output only. Deprecated: Use space_type instead. The type of a space.

space_ type

SpaceType

Необязательный. The type of space. Required when creating a space or updating the space type of a space. Output only for other usage.

single_ user_ bot_ dm

bool

Необязательный. Whether the space is a DM between a Chat app and a single human.

threaded
(deprecated)

bool

Output only. Deprecated: Use spaceThreadingState instead. Whether messages are threaded in this space.

display_ name

string

Необязательный. The space's display name. Required when creating a space with a spaceType of SPACE . If you receive the error message ALREADY_EXISTS when creating a space or updating the displayName , try a different displayName . An existing space within the Google Workspace organization might already use this display name.

For direct messages, this field might be empty.

Supports up to 128 characters.

external_ user_ allowed

bool

Необязательный. Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions:

  • The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user.

For existing spaces, this field is output only.

space_ threading_ state

SpaceThreadingState

Output only. The threading state in the Chat space.

space_ details

SpaceDetails

Необязательный. Details about the space including description and rules.

space_ history_ state

HistoryState

Необязательный. The message history state for messages and threads in this space.

import_ mode

bool

Необязательный. Whether this space is created in Import Mode as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete.

Creating a space in Import Mode requires user authentication .

create_ time

Timestamp

Необязательный. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces.

For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time.

Only populated in the output when spaceType is GROUP_CHAT or SPACE .

last_ active_ time

Timestamp

Output only. Timestamp of the last message in the space.

admin_ installed

bool

Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization.

To support admin install, your Chat app must feature direct messaging.

membership_ count

MembershipCount

Output only. The count of joined memberships grouped by member type. Populated when the space_type is SPACE , DIRECT_MESSAGE or GROUP_CHAT .

access_ settings

AccessSettings

Необязательный. Specifies the access setting of the space. Only populated when the space_type is SPACE .

space_ uri

string

Output only. The URI for a user to access the space.

import_ mode_ expire_ time

Timestamp

Output only. The time when the space will be automatically deleted by the system if it remains in import mode.

Each space created in import mode must exit this mode before this expire time using spaces.completeImport .

This field is only populated for spaces that were created with import mode.

customer

string

Необязательный. Immutable. The customer id of the domain of the space. Required only when creating a space with app authentication and SpaceType is SPACE , otherwise should not be set.

In the format customers/{customer} , where customer is the id from the [Admin SDK customer resource]( https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers) . Private apps can also use the customers/my_customer alias to create the space in the same Google Workspace organization as the app.

For DMs, this field isn't populated.

Union field space_permission_settings . Represents the permission settings of a space. Only populated when the space_type is SPACE .

Requires user authentication . space_permission_settings can be only one of the following:

predefined_ permission_ settings

PredefinedPermissionSettings

Необязательный. Input only. Predefined space permission settings, input only when creating a space. If the field is not set, a collaboration space is created. After you create the space, settings are populated in the PermissionSettings field.

permission_ settings

PermissionSettings

Необязательный. Space permission settings for existing spaces. Input for updating exact space permission settings, where existing permission settings are replaced. Output lists current permission settings.

AccessSettings

Represents the access setting of the space.

Поля
access_ state

AccessState

Output only. Indicates the access state of the space.

audience

string

Необязательный. The resource name of the target audience who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see Make a space discoverable to a target audience .

Format: audiences/{audience}

To use the default target audience for the Google Workspace organization, set to audiences/default .

Reading the target audience supports:

This field is not populated when using the chat.bot scope with app authentication .

Setting the target audience requires user authentication .

AccessState

Represents the access state of the space.

Enums
ACCESS_STATE_UNSPECIFIED Access state is unknown or not supported in this API.
PRIVATE Only users or Google Groups that have been individually added or invited by other users or Google Workspace administrators can discover and access the space.
DISCOVERABLE

A space manager has granted a target audience access to the space. Users or Google Groups that have been individually added or invited to the space can also discover and access the space. To learn more, see Make a space discoverable to specific users .

Creating discoverable spaces requires user authentication .

MembershipCount

Represents the count of memberships of a space, grouped into categories.

Поля
joined_ direct_ human_ user_ count

int32

Output only. Count of human users that have directly joined the space, not counting users joined by having membership in a joined group.

joined_ group_ count

int32

Output only. Count of all groups that have directly joined the space.

PermissionSetting

Represents a space permission setting.

Поля
managers_ allowed

bool

Необязательный. Whether spaces managers have this permission.

members_ allowed

bool

Необязательный. Whether non-manager members have this permission.

PermissionSettings

Permission settings that you can specify when updating an existing named space.

To set permission settings when creating a space, specify the PredefinedPermissionSettings field in your request.

Поля
manage_ members_ and_ groups

PermissionSetting

Необязательный. Setting for managing members and groups in a space.

modify_ space_ details

PermissionSetting

Необязательный. Setting for updating space name, avatar, description and guidelines.

toggle_ history

PermissionSetting

Необязательный. Setting for toggling space history on and off.

use_ at_ mention_ all

PermissionSetting

Необязательный. Setting for using @all in a space.

manage_ apps

PermissionSetting

Необязательный. Setting for managing apps in a space.

manage_ webhooks

PermissionSetting

Необязательный. Setting for managing webhooks in a space.

post_ messages

PermissionSetting

Output only. Setting for posting messages in a space.

reply_ messages

PermissionSetting

Необязательный. Setting for replying to messages in a space.

PredefinedPermissionSettings

Predefined permission settings that you can only specify when creating a named space. More settings might be added in the future. For details about permission settings for named spaces, see Learn about spaces .

Enums
PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED Unspecified. Не используйте.
COLLABORATION_SPACE Setting to make the space a collaboration space where all members can post messages.
ANNOUNCEMENT_SPACE Setting to make the space an announcement space where only space managers can post messages.

SpaceDetails

Details about the space including description and rules.

Поля
description

string

Необязательный. A description of the space. For example, describe the space's discussion topic, functional purpose, or participants.

Supports up to 150 characters.

guidelines

string

Необязательный. The space's rules, expectations, and etiquette.

Supports up to 5,000 characters.

SpaceThreadingState

Specifies the type of threading state in the Chat space.

Enums
SPACE_THREADING_STATE_UNSPECIFIED Сдержанный.
THREADED_MESSAGES Named spaces that support message threads. When users respond to a message, they can reply in-thread, which keeps their response in the context of the original message.
GROUPED_MESSAGES Named spaces where the conversation is organized by topic. Topics and their replies are grouped together.
UNTHREADED_MESSAGES Direct messages (DMs) between two people and group conversations between 3 or more people.

SpaceType

The type of space. Required when creating or updating a space. Output only for other usage.

Enums
SPACE_TYPE_UNSPECIFIED Сдержанный.
SPACE A place where people send messages, share files, and collaborate. A SPACE can include Chat apps.
GROUP_CHAT Group conversations between 3 or more people. A GROUP_CHAT can include Chat apps.
DIRECT_MESSAGE 1:1 messages between two humans or a human and a Chat app.

Тип

Deprecated: Use SpaceType instead.

Enums
TYPE_UNSPECIFIED Сдержанный.
ROOM Conversations between two or more humans.
DM 1:1 Direct Message between a human and a Chat app, where all messages are flat. Note that this doesn't include direct messages between two humans.

SpaceBatchUpdatedEventData

Event payload for multiple updates to a space.

Event type: google.workspace.chat.space.v1.batchUpdated

Поля
spaces[]

SpaceUpdatedEventData

A list of updated spaces.

SpaceEvent

An event that represents a change or activity in a Google Chat space. To learn more, see Work with events from Google Chat .

Поля
name

string

Resource name of the space event.

Format: spaces/{space}/spaceEvents/{spaceEvent}

event_ time

Timestamp

Time when the event occurred.

event_ type

string

Type of space event. Each event type has a batch version, which represents multiple instances of the event type that occur in a short period of time. For spaceEvents.list() requests, omit batch event types in your query filter. By default, the server returns both event type and its batch version.

Supported event types for messages :

  • New message: google.workspace.chat.message.v1.created
  • Updated message: google.workspace.chat.message.v1.updated
  • Deleted message: google.workspace.chat.message.v1.deleted
  • Multiple new messages: google.workspace.chat.message.v1.batchCreated
  • Multiple updated messages: google.workspace.chat.message.v1.batchUpdated
  • Multiple deleted messages: google.workspace.chat.message.v1.batchDeleted

Supported event types for memberships :

  • New membership: google.workspace.chat.membership.v1.created
  • Updated membership: google.workspace.chat.membership.v1.updated
  • Deleted membership: google.workspace.chat.membership.v1.deleted
  • Multiple new memberships: google.workspace.chat.membership.v1.batchCreated
  • Multiple updated memberships: google.workspace.chat.membership.v1.batchUpdated
  • Multiple deleted memberships: google.workspace.chat.membership.v1.batchDeleted

Supported event types for reactions :

  • New reaction: google.workspace.chat.reaction.v1.created
  • Deleted reaction: google.workspace.chat.reaction.v1.deleted
  • Multiple new reactions: google.workspace.chat.reaction.v1.batchCreated
  • Multiple deleted reactions: google.workspace.chat.reaction.v1.batchDeleted

Supported event types about the space :

  • Updated space: google.workspace.chat.space.v1.updated
  • Multiple space updates: google.workspace.chat.space.v1.batchUpdated

Union field payload .

payload can be only one of the following:

message_ created_ event_ data

MessageCreatedEventData

Event payload for a new message.

Event type: google.workspace.chat.message.v1.created

message_ updated_ event_ data

MessageUpdatedEventData

Event payload for an updated message.

Event type: google.workspace.chat.message.v1.updated

message_ deleted_ event_ data

MessageDeletedEventData

Event payload for a deleted message.

Event type: google.workspace.chat.message.v1.deleted

message_ batch_ created_ event_ data

MessageBatchCreatedEventData

Event payload for multiple new messages.

Event type: google.workspace.chat.message.v1.batchCreated

message_ batch_ updated_ event_ data

MessageBatchUpdatedEventData

Event payload for multiple updated messages.

Event type: google.workspace.chat.message.v1.batchUpdated

message_ batch_ deleted_ event_ data

MessageBatchDeletedEventData

Event payload for multiple deleted messages.

Event type: google.workspace.chat.message.v1.batchDeleted

space_ updated_ event_ data

SpaceUpdatedEventData

Event payload for a space update.

Event type: google.workspace.chat.space.v1.updated

space_ batch_ updated_ event_ data

SpaceBatchUpdatedEventData

Event payload for multiple updates to a space.

Event type: google.workspace.chat.space.v1.batchUpdated

membership_ created_ event_ data

MembershipCreatedEventData

Event payload for a new membership.

Event type: google.workspace.chat.membership.v1.created

membership_ updated_ event_ data

MembershipUpdatedEventData

Event payload for an updated membership.

Event type: google.workspace.chat.membership.v1.updated

membership_ deleted_ event_ data

MembershipDeletedEventData

Event payload for a deleted membership.

Event type: google.workspace.chat.membership.v1.deleted

membership_ batch_ created_ event_ data

MembershipBatchCreatedEventData

Event payload for multiple new memberships.

Event type: google.workspace.chat.membership.v1.batchCreated

membership_ batch_ updated_ event_ data

MembershipBatchUpdatedEventData

Event payload for multiple updated memberships.

Event type: google.workspace.chat.membership.v1.batchUpdated

membership_ batch_ deleted_ event_ data

MembershipBatchDeletedEventData

Event payload for multiple deleted memberships.

Event type: google.workspace.chat.membership.v1.batchDeleted

reaction_ created_ event_ data

ReactionCreatedEventData

Event payload for a new reaction.

Event type: google.workspace.chat.reaction.v1.created

reaction_ deleted_ event_ data

ReactionDeletedEventData

Event payload for a deleted reaction.

Event type: google.workspace.chat.reaction.v1.deleted

reaction_ batch_ created_ event_ data

ReactionBatchCreatedEventData

Event payload for multiple new reactions.

Event type: google.workspace.chat.reaction.v1.batchCreated

reaction_ batch_ deleted_ event_ data

ReactionBatchDeletedEventData

Event payload for multiple deleted reactions.

Event type: google.workspace.chat.reaction.v1.batchDeleted

SpaceNotificationSetting

The notification settings of a user in a space.

Поля
name

string

Идентификатор. The resource name of the space notification setting. Format: users/{user}/spaces/{space}/spaceNotificationSetting .

notification_ setting

NotificationSetting

The notification setting.

mute_ setting

MuteSetting

The space notification mute setting.

MuteSetting

The space notification mute setting types.

Enums
MUTE_SETTING_UNSPECIFIED Сдержанный.
UNMUTED The user will receive notifications for the space based on the notification setting.
MUTED The user will not receive any notifications for the space, regardless of the notification setting.

NotificationSetting

The notification setting types.

Enums
NOTIFICATION_SETTING_UNSPECIFIED Сдержанный.
ALL Notifications are triggered by @mentions, followed threads, first message of new threads. All new threads are automatically followed, unless manually unfollowed by the user.
MAIN_CONVERSATIONS The notification is triggered by @mentions, followed threads, first message of new threads. Not available for 1:1 direct messages.
FOR_YOU The notification is triggered by @mentions, followed threads. Not available for 1:1 direct messages.
OFF Notification is off.

SpaceReadState

A user's read state within a space, used to identify read and unread messages.

Поля
name

string

Resource name of the space read state.

Format: users/{user}/spaces/{space}/spaceReadState

last_ read_ time

Timestamp

Необязательный. The time when the user's space read state was updated. Usually this corresponds with either the timestamp of the last read message, or a timestamp specified by the user to mark the last read position in a space.

SpaceUpdatedEventData

Event payload for an updated space.

Event type: google.workspace.chat.space.v1.updated

Поля
space

Space

The updated space.

Нить

A thread in a Google Chat space. For example usage, see Start or reply to a message thread .

If you specify a thread when creating a message, you can set the messageReplyOption field to determine what happens if no matching thread is found.

Поля
name

string

Идентификатор. Resource name of the thread.

Example: spaces/{space}/threads/{thread}

thread_ key

string

Необязательный. Input for creating or updating a thread. Otherwise, output only. ID for the thread. Supports up to 4000 characters.

This ID is unique to the Chat app that sets it. For example, if multiple Chat apps create a message using the same thread key, the messages are posted in different threads. To reply in a thread created by a person or another Chat app, specify the thread name field instead.

ThreadReadState

A user's read state within a thread, used to identify read and unread messages.

Поля
name

string

Resource name of the thread read state.

Format: users/{user}/spaces/{space}/threads/{thread}/threadReadState

last_ read_ time

Timestamp

The time when the user's thread read state was updated. Usually this corresponds with the timestamp of the last read message in a thread.

UpdateMembershipRequest

Request message for updating a membership.

Поля
membership

Membership

Необходимый. The membership to update. Only fields specified by update_mask are updated.

update_ mask

FieldMask

Необходимый. The field paths to update. Separate multiple values with commas or use * to update all field paths.

Currently supported field paths:

  • role
use_ admin_ access

bool

Необязательный. When true , the method runs using the user's Google Workspace administrator privileges.

The calling user must be a Google Workspace administrator with the manage chat and spaces conversations privilege .

Requires the chat.admin.memberships OAuth 2.0 scope .

UpdateMessageRequest

Request to update a message.

Поля
message

Message

Необходимый. Message with fields updated.

update_ mask

FieldMask

Необходимый. The field paths to update. Separate multiple values with commas or use * to update all field paths.

Currently supported field paths:

allow_ missing

bool

Необязательный. If true and the message isn't found, a new message is created and updateMask is ignored. The specified message ID must be client-assigned or the request fails.

UpdateSpaceNotificationSettingRequest

Request to update the space notification settings. Only supports updating notification setting for the calling user.

Поля
space_ notification_ setting

SpaceNotificationSetting

Необходимый. The resource name for the space notification settings must be populated in the form of users/{user}/spaces/{space}/spaceNotificationSetting . Only fields specified by update_mask are updated.

update_ mask

FieldMask

Необходимый. Supported field paths: - notification_setting - mute_setting

UpdateSpaceReadStateRequest

Request message for UpdateSpaceReadState API.

Поля
space_ read_ state

SpaceReadState

Необходимый. The space read state and fields to update.

Only supports updating read state for the calling user.

To refer to the calling user, set one of the following:

  • The me alias. For example, users/me/spaces/{space}/spaceReadState .

  • Their Workspace email address. For example, users/user@example.com/spaces/{space}/spaceReadState .

  • Their user id. For example, users/123456789/spaces/{space}/spaceReadState .

Format: users/{user}/spaces/{space}/spaceReadState

update_ mask

FieldMask

Необходимый. The field paths to update. Currently supported field paths:

  • last_read_time

When the last_read_time is before the latest message create time, the space appears as unread in the UI.

To mark the space as read, set last_read_time to any value later (larger) than the latest message create time. The last_read_time is coerced to match the latest message create time. Note that the space read state only affects the read state of messages that are visible in the space's top-level conversation. Replies in threads are unaffected by this timestamp, and instead rely on the thread read state.

UpdateSpaceRequest

A request to update a single space.

Поля
space

Space

Необходимый. Space with fields to be updated. Space.name must be populated in the form of spaces/{space} . Only fields specified by update_mask are updated.

update_ mask

FieldMask

Необходимый. The updated field paths, comma separated if there are multiple.

You can update the following fields for a space:

space_details : Updates the space's description. Supports up to 150 characters.

display_name : Only supports updating the display name for spaces where spaceType field is SPACE . If you receive the error message ALREADY_EXISTS , try a different value. An existing space within the Google Workspace organization might already use this display name.

space_type : Only supports changing a GROUP_CHAT space type to SPACE . Include display_name together with space_type in the update mask and ensure that the specified space has a non-empty display name and the SPACE space type. Including the space_type mask and the SPACE type in the specified space when updating the display name is optional if the existing space already has the SPACE type. Trying to update the space type in other ways results in an invalid argument error. space_type is not supported with useAdminAccess .

space_history_state : Updates space history settings by turning history on or off for the space. Only supported if history settings are enabled for the Google Workspace organization. To update the space history state, you must omit all other field masks in your request. space_history_state is not supported with useAdminAccess .

access_settings.audience : Updates the access setting of who can discover the space, join the space, and preview the messages in named space where spaceType field is SPACE . If the existing space has a target audience, you can remove the audience and restrict space access by omitting a value for this field mask. To update access settings for a space, the authenticating user must be a space manager and omit all other field masks in your request. You can't update this field if the space is in import mode . To learn more, see Make a space discoverable to specific users . access_settings.audience is not supported with useAdminAccess .

permission_settings : Supports changing the permission settings of a space. When updating permission settings, you can only specify permissionSettings field masks; you cannot update other field masks at the same time. permissionSettings is not supported with useAdminAccess . The supported field masks include:

  • permission_settings.manageMembersAndGroups
  • permission_settings.modifySpaceDetails
  • permission_settings.toggleHistory
  • permission_settings.useAtMentionAll
  • permission_settings.manageApps
  • permission_settings.manageWebhooks
  • permission_settings.replyMessages
use_ admin_ access

bool

Необязательный. When true , the method runs using the user's Google Workspace administrator privileges.

The calling user must be a Google Workspace administrator with the manage chat and spaces conversations privilege .

Requires the chat.admin.spaces OAuth 2.0 scope .

Some FieldMask values are not supported using admin access. For details, see the description of update_mask .

Пользователь

A user in Google Chat. When returned as an output from a request, if your Chat app authenticates as a user , the output for a User resource only populates the user's name and type .

Поля
name

string

Resource name for a Google Chat user .

Format: users/{user} . users/app can be used as an alias for the calling app bot user.

For human users , {user} is the same user identifier as:

  • the id for the Person in the People API. For example, users/123456789 in Chat API represents the same person as the 123456789 Person profile ID in People API.

  • the id for a user in the Admin SDK Directory API.

  • the user's email address can be used as an alias for {user} in API requests. For example, if the People API Person profile ID for user@example.com is 123456789 , you can use users/user@example.com as an alias to reference users/123456789 . Only the canonical resource name (for example users/123456789 ) will be returned from the API.

display_ name

string

Output only. The user's display name.

domain_ id

string

Unique identifier of the user's Google Workspace domain.

type

Type

User type.

is_ anonymous

bool

Output only. When true , the user is deleted or their profile is not visible.

Тип

Enums
TYPE_UNSPECIFIED Default value for the enum. DO NOT USE.
HUMAN Human user.
BOT Chat app user.

UserMentionMetadata

Annotation metadata for user mentions (@).

Поля
user

User

The user mentioned.

type

Type

The type of user mention.

Тип

Enums
TYPE_UNSPECIFIED Default value for the enum. Не используйте.
ADD Add user to space.
MENTION Mention user in space.

WidgetMarkup

A widget is a UI element that presents text and images.

Поля
buttons[]

Button

A list of buttons. Buttons is also oneof data and only one of these fields should be set.

Union field data . A WidgetMarkup can only have one of the following items. You can use multiple WidgetMarkup fields to display more items. data can be only one of the following:
text_ paragraph

TextParagraph

Display a text paragraph in this widget.

image

Image

Display an image in this widget.

key_ value

KeyValue

Display a key value item in this widget.

Кнопка

A button. Can be a text button or an image button.

Поля

Union field type .

type can be only one of the following:

text_ button

TextButton

A button with text and onclick action.

image_ button

ImageButton

A button with image and onclick action.

FormAction

A form action describes the behavior when the form is submitted. For example, you can invoke Apps Script to handle the form.

Поля
action_ method_ name

string

The method name is used to identify which part of the form triggered the form submission. This information is echoed back to the Chat app as part of the card click event. You can use the same method name for several elements that trigger a common behavior.

parameters[]

ActionParameter

List of action parameters.

ActionParameter

List of string parameters to supply when the action method is invoked. For example, consider three snooze buttons: snooze now, snooze one day, snooze next week. You might use action method = snooze() , passing the snooze type and snooze time in the list of string parameters.

Поля
key

string

The name of the parameter for the action script.

value

string

The value of the parameter.

Икона

The set of supported icons.

Enums
ICON_UNSPECIFIED
AIRPLANE
BOOKMARK
BUS
CAR
CLOCK
CONFIRMATION_NUMBER_ICON
DOLLAR
DESCRIPTION
EMAIL
EVENT_PERFORMER
EVENT_SEAT
FLIGHT_ARRIVAL
FLIGHT_DEPARTURE
HOTEL
HOTEL_ROOM_TYPE
INVITE
MAP_PIN
MEMBERSHIP
MULTIPLE_PEOPLE
OFFER
PERSON
PHONE
RESTAURANT_ICON
SHOPPING_CART
STAR
STORE
TICKET
TRAIN
VIDEO_CAMERA
VIDEO_PLAY

Изображение

An image that's specified by a URL and can have an onclick action.

Поля
image_ url

string

The URL of the image.

on_ click

OnClick

The onclick action.

aspect_ ratio

double

The aspect ratio of this image (width and height). This field lets you reserve the right height for the image while waiting for it to load. It's not meant to override the built-in aspect ratio of the image. If unset, the server fills it by prefetching the image.

ImageButton

An image button with an onclick action.

Поля
on_ click

OnClick

The onclick action.

name

string

The name of this image_button that's used for accessibility. Default value is provided if this name isn't specified.

Union field icons . The icon can be specified by an Icon enum or a URL. icons can be only one of the following:
icon

Icon

The icon specified by an enum that indices to an icon provided by Chat API.

icon_ url

string

The icon specified by a URL.

KeyValue

A UI element contains a key (label) and a value (content). This element can also contain some actions such as onclick button.

Поля
top_ label

string

The text of the top label. Formatted text supported. For more information about formatting text, see Formatting text in Google Chat apps and Formatting text in Google Workspace Add-ons .

content

string

The text of the content. Formatted text supported and always required. For more information about formatting text, see Formatting text in Google Chat apps and Formatting text in Google Workspace Add-ons .

content_ multiline

bool

If the content should be multiline.

bottom_ label

string

The text of the bottom label. Formatted text supported. For more information about formatting text, see Formatting text in Google Chat apps and Formatting text in Google Workspace Add-ons .

on_ click

OnClick

The onclick action. Only the top label, bottom label, and content region are clickable.

Union field icons . At least one of icons, top_label and bottom_label must be defined. icons can be only one of the following:
icon

Icon

An enum value that's replaced by the Chat API with the corresponding icon image.

icon_ url

string

The icon specified by a URL.

Union field control . A control widget. You can set either button or switch_widget , but not both. control can be only one of the following:
button

Button

A button that can be clicked to trigger an action.

OnClick

An onclick action (for example, open a link).

Поля

Union field data .

data can be only one of the following:

action

FormAction

A form action is triggered by this onclick action if specified.

TextButton

A button with text and onclick action.

Поля
text

string

The text of the button.

on_ click

OnClick

The onclick action of the button.

TextParagraph

A paragraph of text. Formatted text supported. For more information about formatting text, see Formatting text in Google Chat apps and Formatting text in Google Workspace Add-ons .

Поля
text

string