Package google.chat.v1

Индекс

ЧатСервис

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

CompleteImportSpace

rpc CompleteImportSpace( CompleteImportSpaceRequest ) returns ( CompleteImportSpaceResponse )

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

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

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

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

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

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

rpc CreateMembership( CreateMembershipRequest ) returns ( Membership )

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

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

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

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

  • 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 )

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

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

Если вы являетесь участником программы Developer Preview , вы можете создать групповой чат в режиме импорта, используя spaceType.GROUP_CHAT .

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

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

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

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

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

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

rpc DeleteMembership( DeleteMembershipRequest ) returns ( Membership )

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

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

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

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

  • 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.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

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

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

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

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

GetSpaceEvent

rpc GetSpaceEvent( GetSpaceEventRequest ) returns ( SpaceEvent )

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

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

Пример см. в разделе Получение сведений о событии из чата 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

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

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

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

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

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.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.admin.spaces
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.spaces

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

UpdateSpaceReadState

rpc UpdateSpaceReadState( UpdateSpaceReadStateRequest ) returns ( SpaceReadState )

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

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

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

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

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

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

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

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

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

ButtonList

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

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

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

Поля
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

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

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

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

Поля
parent

string

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

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

membership

Membership

Необходимый. Отношение членства для создания. memberType должно содержать пользователя с заполненными полями user.name и user.type . Сервер назначит имя ресурса и перезапишет все указанное. Когда приложение чата создает отношение членства для пользователя-человека, оно должно использовать область chat.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 . Когда приложение чата создает для себя отношение членства, оно должно использовать область chat.memberships.app , установить для user.type значение BOT и задать для user.name users/app .

use_admin_access

bool

Если true , метод запускается с использованием прав администратора Google Workspace пользователя.

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

Требуется область действия OAuth 2.0 chat.admin.memberships .

Создание членства в приложении или создание членства для пользователей за пределами организации Google Workspace, принадлежащей администратору, не поддерживается с использованием доступа администратора.

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

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

Поля
parent

string

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

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

message

Message

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

thread_key
(deprecated)

string

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

request_id

string

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

message_reply_option

MessageReplyOption

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

message_id

string

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

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

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

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

Опция ответа сообщения

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

Перечисления
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

Необходимый. Поля spaceType должны быть заполнены. Поддерживается только SpaceType.SPACE .

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

Если вы являетесь участником программы Developer Preview , можно использовать SpaceType.GROUP_CHAT если для importMode установлено значение true.

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

request_id

string

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

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

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

Поля
uid

string

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

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

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

Поля
name

string

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

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

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

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

use_admin_access

bool

Если true , метод запускается с использованием прав администратора Google Workspace пользователя.

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

Требуется область действия OAuth 2.0 chat.admin.memberships .

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

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

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

Поля
name

string

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

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

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

force

bool

Если true , при удалении сообщения также удаляются вложенные в него ответы. Если false , если сообщение имеет цепочки ответов, удаление не удастся.

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

Удалитьреакционрекуест

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

Поля
name

string

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

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

Удалить спейсрекуест

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

Поля
name

string

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

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

use_admin_access

bool

Если true , метод запускается с использованием прав администратора Google Workspace пользователя.

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

Требуется область действия OAuth 2.0 chat.admin.delete .

Удаление метаданных

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

Поля
deletion_type

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} .

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}

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 chat.admin.spaces.readonly

GetThreadReadStateRequest

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

Поля
name

string

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

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

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

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

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

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

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

Группа

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

Поля
name

string

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

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

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

ИСТОРИЯ

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

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

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 оператор.

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

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

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.readonly chat.admin.memberships

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

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

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

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

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

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 членство соответствует.

Членство

Представляет разрешенные действия пользователя в пространстве чата. Больше значений 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> .

  • Пользовательский эмодзи с использованием формата :{emoji_name}: - например,: :smile: . Это не относится к Emoji Unicode, например U+1F600 для ухмыляющегося лица.

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

cards[]
(deprecated)

Card

Устроенный: используйте cards_v2 вместо этого.

Богатые, отформатированные и интерактивные карты, которые вы можете использовать для отображения элементов пользовательского интерфейса, таких как: форматированные тексты, кнопки и кликабельные изображения. Карты обычно отображаются ниже простого тела сообщения. cards и cards_v2 могут иметь максимальный размер 32 КБ.

cards_v2[]

CardWithId

Множество карт .

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

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

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

Откройте застройщик карт

annotations[]

Annotation

Только вывод. Аннотации, связанные с text в этом сообщении.

thread

Thread

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

space

Space

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

fallback_text

string

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

action_response

ActionResponse

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

argument_text

string

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

slash_command

SlashCommand

Только вывод. Информация о команде SLASH, если применимо.

attachment[]

Attachment

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

matched_url

MatchedUrl

Только вывод. URL в spaces.messages.text , который соответствует шаблону предварительного просмотра ссылки. Для получения дополнительной информации см. Предварительные ссылки .

thread_reply

bool

Только вывод. Когда это true , сообщение является ответом в потоке ответа. Когда false , сообщение видно в разговоре верхнего уровня пространства как первое сообщение потока или сообщение без ответов.

Если пространство не поддерживает ответ в потоках, это поле всегда false .

client_assigned_message_id

string

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

emoji_reaction_summaries[]

EmojiReactionSummary

Только вывод. Список резюме реакции эмодзи на сообщении.

private_message_viewer

User

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

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

deletion_metadata

DeletionMetadata

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

quoted_message_metadata

QuotedMessageMetadata

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

attached_gifs[]

AttachedGif

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

accessory_widgets[]

AccessoryWidget

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

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

MessageBatchCreatedEventData

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

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

Поля
messages[]

MessageCreatedEventData

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

MessageBatchDeleteDeventData

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

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

Поля
messages[]

MessageDeletedEventData

Список удаленных сообщений.

MessageBatchUpdatedEventData

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

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

Поля
messages[]

MessageUpdatedEventData

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

MessageCreatedEventdata

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

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

Поля
message

Message

Новое сообщение.

MessageDetedEventData

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

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

Поля
message

Message

Удаленное сообщение. Только поля name , createTime , deleteTime и deletionMetadata заполняются.

MessageUpdatedEventData

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

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

Поля
message

Message

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

Quytedmessagemetadata

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

Поля
name

string

Только вывод. Имя ресурса цитируемого сообщения.

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

last_update_time

Timestamp

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

Реакция

Реакция на сообщение.

Поля
name

string

Название ресурса реакции.

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

user

User

Только вывод. Пользователь, который создал реакцию.

emoji

Emoji

Эмодзи, используемые в реакции.

Реакция BatchCreatedEventData

Полезная нагрузка на несколько новых реакций.

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

Поля
reactions[]

ReactionCreatedEventData

Список новых реакций.

Реакция BatchDeleteDeventData

Полезная нагрузка на несколько удаленных реакций.

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

Поля
reactions[]

ReactionDeletedEventData

Список удаленных реакций.

Реакция CREATEDEVENTDATA

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

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

Поля
reaction

Reaction

Новая реакция.

Реакция DELETEDEVENTDATA

Полезная нагрузка на удаленную реакцию.

Тип: google.workspace.chat.reaction.v1.deleted

Поля
reaction

Reaction

Удаленная реакция.

Richlinkmetadata

Богатая ссылка на ресурс.

Поля
uri

string

URI этой ссылки.

Объединенные полевые data . Данные для связанного ресурса. data могут быть только одним из следующих:

Richlinktype

Богатый тип ссылки. В будущем может быть добавлено больше типов.

Перечисления
DRIVE_FILE Гугл диск, богатый тип ссылки.
CHAT_SPACE Тип ссылки на просмотр чата. Например, Space Smart Chip.

SearchspacesRequest

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

Поля
use_admin_access

bool

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

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

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

Этот метод в настоящее время поддерживает только доступ администратора, поэтому для этого поля принимается только true .

page_size

int32

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

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

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

page_token

string

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

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

query

string

Необходимый. Поисковый запрос.

Вы можете искать, используя следующие параметры:

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

create_time и last_active_time Принимайте временную метку в формате RFC-3339 , а поддерживаемые операторы сравнения: = , < , > , <= , >= .

customer требуется и используется для указания, из какого клиента приносить места. customers/my_customer - единственная поддерживаемая ценность.

display_name только принимает оператор HAS ( : . Текст, который можно соответствовать, первым токенам, и каждый токен является сопоставлением префиксом, чувствительным к случаям и независимо в качестве подстроения в любом месте в пространстве display_name . Например, Fun Eve Match Match Fun event или The evening was fun , но не notFun event или even .

external_user_allowed принимает либо true , либо false .

space_history_state принимает только значения из поля historyState space ресурса.

space_type требуется, и единственное допустимое значение - SPACE .

В разных областях поддерживаются только AND . Допустимый пример - space_type = "SPACE" AND display_name:"Hello" , а неверный пример - space_type = "SPACE" OR display_name:"Hello" .

Среди той же поля space_type не поддерживает AND или OR операторы. display_name , 'space_history_state' и 'external_user_allowed' только поддержка OR операторы. last_active_time и create_time поддерживают как AND и OR операторы. AND может использоваться только для представления интервала, такого как last_active_time < "2022-01-01T00:00:00+00:00" AND last_active_time > "2023-01-01T00:00:00+00:00" .

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

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

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

Поддерживаемые атрибуты по заказу

  • membership_count.joined_direct_human_user_count - обозначает количество людей, которые непосредственно присоединились к пространству.
  • last_active_time - обозначает время, когда последний подходящий элемент добавляется в любую тему этого пространства.
  • create_time - обозначает время создания пространства.

Допустимые значения операции на заказ:

  • ASC для восхождения. Значение по умолчанию.

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

Поддерживаемый синтаксис:

  • 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

Ответ со списком пробелов, соответствующих запросу поискового пространства.

Поля
spaces[]

Space

Страница запрошенных пространств.

next_page_token

string

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

total_size

int32

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

SetupSpacerequest

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

Поля
space

Space

Необходимый. Требуется поле Space.spaceType .

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

Чтобы создать групповой чат, установите Space.spaceType на GROUP_CHAT . Не устанавливайте Space.displayName .

Чтобы создать разговор между людьми 1: 1, установите пространство false Space.spaceType to DIRECT_MESSAGE и установите Space.singleUserBotDm . Не устанавливайте Space.displayName или Space.spaceDetails .

Чтобы создать разговор 1: 1 между человеком и приложением для призывного чата, установите Space.spaceType на DIRECT_MESSAGE и Space.singleUserBotDm true . Не устанавливайте Space.displayName или Space.spaceDetails .

Если пространство DIRECT_MESSAGE уже существует, это пространство возвращается вместо создания нового пространства.

request_id

string

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

memberships[]

Membership

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

Набор в настоящее время допускает до 20 членов (в дополнение к вызывающему абоненту).

Для человеческого членства в поле Membership.member должно содержать user с заполненным name (формат: users/{user} ) и type установленного на 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.

Fields
command_id

int64

The ID of the slash command invoked.

SlashCommandMetadata

Annotation metadata for slash commands (/).

Fields
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.

Тип

Перечисления
TYPE_UNSPECIFIED Default value for the enum. Don't use.
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.

Fields
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

Только вывод. 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

Только вывод. 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

Неизменяемый. 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

Только вывод. 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.

create_time

Timestamp

Необязательный. Неизменяемый. 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

Только вывод. Timestamp of the last message in the space.

admin_installed

bool

Только вывод. 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

Только вывод. 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

Только вывод. The URI for a user to access the space.

Union field space_permission_settings . Represents the permission settings of a space. Only populated when the space_type is SPACE . space_permission_settings can be only one of the following:
predefined_permission_settings

PredefinedPermissionSettings

Необязательный. Input only. Space permission settings. Input for creating a space, a collaboration space is created if this field is not set. After you create the space, settings are populated in the PermissionSettings field.

permission_settings

PermissionSettings

Необязательный. Exact permission settings which can be set to update the space. Input for updating a space. Otherwise, output only. For space creation, use predefined_permission_settings instead.

AccessSettings

Represents the access setting of the space.

Fields
access_state

AccessState

Только вывод. 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 .

AccessState

Represents the access state of the space.

Перечисления
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 .

MembershipCount

Represents the count of memberships of a space, grouped into categories.

Fields
joined_direct_human_user_count

int32

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

Count of all groups that have directly joined the space.

PermissionSetting

Represents a space permission setting.

Fields
managers_allowed

bool

Whether spaces managers have this permission.

members_allowed

bool

Whether non-manager members have this permission.

PermissionSettings

Permission settings for a named space. To set permission settings when creating a space, specify the PredefinedPermissionSettings field in your request.

Fields
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

Только вывод. Setting for posting messages in a space.

reply_messages

PermissionSetting

Setting for replying to messages in a space.

PredefinedPermissionSettings

The space permission settings that you can 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 .

Перечисления
PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED Не указано. Don't use.
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.

Fields
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.

Перечисления
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.

Перечисления
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.

Перечисления
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

Fields
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 .

Fields
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

SpaceReadState

A user's read state within a space, used to identify read and unread messages.

Fields
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

Fields
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.

Fields
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.

Fields
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.

Fields
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.

Fields
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.

UpdateSpaceReadStateRequest

Request message for UpdateSpaceReadState API.

Fields
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.

Fields
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

  • 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 admin access.

  • 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 admin access.

  • 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 admin access.

  • Developer Preview: Supports changing the permission settings of a space, supported field paths include: permission_settings.manage_members_and_groups , permission_settings.modify_space_details , permission_settings.toggle_history , permission_settings.use_at_mention_all , permission_settings.manage_apps , permission_settings.manage_webhooks , permission_settings.reply_messages (Warning: mutually exclusive with all other non-permission settings field paths). permission_settings is not supported with admin access.

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 .

Fields
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

Только вывод. The user's display name.

domain_id

string

Unique identifier of the user's Google Workspace domain.

type

Type

Тип пользователя.

is_anonymous

bool

Только вывод. When true , the user is deleted or their profile is not visible.

Тип

Перечисления
TYPE_UNSPECIFIED Default value for the enum. НЕ ИСПОЛЬЗУЙТЕ.
HUMAN Human user.
BOT Chat app user.

UserMentionMetadata

Annotation metadata for user mentions (@).

Fields
user

User

The user mentioned.

type

Type

The type of user mention.

Тип

Перечисления
TYPE_UNSPECIFIED Default value for the enum. Don't use.
ADD Add user to space.
MENTION Mention user in space.

WidgetMarkup

A widget is a UI element that presents text and images.

Fields
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.

Fields

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.

Fields
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.

Fields
key

string

The name of the parameter for the action script.

value

string

The value of the parameter.

Икона

The set of supported icons.

Перечисления
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.

Fields
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.

Fields
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.

Fields
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).

Fields

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.

Fields
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 .

Fields
text

string