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 )

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

Чтобы указать добавляемого участника, задайте membership.member.name для человека или участника приложения или задайте membership.group_member.name для члена группы.

  • Чтобы добавить вызывающее приложение в пространство или прямое сообщение между двумя пользователями-людьми, используйтеusers users/app . Невозможно добавить в пространство другие приложения.

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

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

Требуется одна из следующих областей 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. Максимальный размер сообщения, включая текст и карточки, составляет 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.

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

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

Требуется одна из следующих областей 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 )

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

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

Требуется одна из следующих областей 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

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

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

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

Поля
type

ResponseType

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

url

string

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

dialog_action

DialogAction

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

updated_widget

UpdatedWidget

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

Тип ответа

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

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

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

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

Поля
items[]

SelectionItem

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

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

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

Поля
widget

string

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

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

SelectionItems

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

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

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

Поля
status_code

Code

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

user_facing_message

string

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

Аннотация

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

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

Hello @FooBot how are you!"

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

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

AnnotationType

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

length

int32

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

start_index

int32

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

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

UserMentionMetadata

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

slash_command

SlashCommandMetadata

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

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

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

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

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

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

Поля
uri

string

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

Вложение

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

Поля
name

string

Имя ресурса вложения в форме spaces/{space}/messages/{message}/attachments/{attachment} .

content_name

string

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

content_type

string

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

thumbnail_uri

string

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

download_uri

string

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

source

Source

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

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

AttachmentDataRef

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

drive_data_ref

DriveDataRef

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

Источник

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

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

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

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

Поля
resource_name

string

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

attachment_upload_token

string

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

Картасид

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

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

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

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

Поля
card_id

string

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

card

Card

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

ChatSpaceLinkData

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

Поля
space

string

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

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

thread

string

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

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

message

string

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

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

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

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

Поля
name

string

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

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

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

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

Поля
space

Space

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

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

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

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

Карта

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

Поля
header

CardHeader

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

sections[]

Section

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

card_actions[]

CardAction

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

name

string

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

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

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

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

Поля
action_label

string

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

on_click

OnClick

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

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

Поля
title

string

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

subtitle

string

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

image_style

ImageStyle

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

image_url

string

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

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

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

Раздел

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

Поля
header

string

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

widgets[]

WidgetMarkup

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

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

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

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

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

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

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 Приложение Chat удалило сообщение от имени владельца пространства.

Диалог

Обертка вокруг тела карточки диалога.

Поля
body

Card

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

ДиалогДействие

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

Поля
action_status

ActionStatus

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

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

Dialog

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

DriveDataRef

Ссылка на данные о подключении диска.

Поля
drive_file_id

string

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

DriveLinkData

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

Поля
drive_data_ref

DriveDataRef

DriveDataRef , который ссылается на файл Google Диска.

mime_type

string

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

Эмодзи

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

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

string

Базовый смайлик, представленный строкой Юникода.

custom_emoji

CustomEmoji

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

EmojiРеакцияСводка

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

Поля
emoji

Emoji

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

reaction_count

int32

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

FindDirectMessageRequest

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

Поля
name

string

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

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

GetAttachmentRequest

Запрос на получение вложения.

Поля
name

string

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

Получить запрос на членство

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

Поля
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 Workspace пользователя.

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

Требуются области OAuth 2.0 chat.admin.memberships или chat.admin.memberships.readonly .

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

Получить запрос сообщения

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

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

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

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

Формат: пользователи/{user}/spaces/{space}/spaceReadState

GetSpaceRequest

Запрос на возврат одного пробела.

Поля
name

string

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

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

use_admin_access

bool

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

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

Требуются области OAuth 2.0 chat.admin.spaces или chat.admin.spaces.readonly .

GetThreadReadStateRequest

Сообщение запроса для API GetThreadReadStateRequest.

Поля
name

string

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

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

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

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

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

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

Формат: пользователи/{user}/spaces/{space}/threads/{thread}/threadReadState

Группа

Группа Google в Google Chat.

Поля
name

string

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

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

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

Состояние истории

Состояние истории сообщений и пространств. Указывает, как долго сообщения и цепочки разговоров хранятся после создания.

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

СписокЧленствоЗапрос

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

Поля
parent

string

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

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

page_size

int32

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

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

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

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

page_token

string

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

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

filter

string

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

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

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

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

Для фильтрации по роли и типу используйте оператор AND . Для фильтрации по роли или типу используйте оператор OR .

Если для use_admin_access установлено значение true, member.type = "HUMAN" , member.type != "BOT" Фильтры других типов участников будут отклонены.

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

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

member.type != "BOT"

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

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

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

show_groups

bool

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

show_invited

bool

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

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

use_admin_access

bool

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

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

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

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

ListMembershipsResponse

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

Поля
memberships[]

Membership

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

next_page_token

string

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

Список сообщенийЗапрос

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

Поля
parent

string

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

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

page_size

int32

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

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

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

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

page_token

string

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

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

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

filter

string

Фильтр запроса.

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

Чтобы фильтровать сообщения по дате их создания, укажите 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 , чтобы получить следующую страницу результатов. Если пусто, последующих страниц нет.

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

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

Поля
parent

string

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

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

page_size

int32

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

page_token

string

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

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

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

filter

string

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

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

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

Чтобы отфильтровать реакции по смайликам и пользователю, используйте оператор 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 .

СписокРеакцийОтвет

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

Поля
reactions[]

Reaction

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

next_page_token

string

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

ListSpaceEventsRequest

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

Поля
parent

string

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

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

page_size

int32

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

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

page_token

string

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

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

filter

string

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

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

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

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

Чтобы указать время начала или окончания, используйте оператор равенства = и формат в 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 ).

Для фильтрации по типу пространства необходимо указать допустимое значение перечисления, например 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 , чтобы получить следующую страницу результатов. Если пусто, последующих страниц нет.

Соответствующий URL

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

Поля
url

string

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

Членство

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

Поля
name

string

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

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

state

MembershipState

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

role

MembershipRole

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

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

create_time

Timestamp

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

delete_time

Timestamp

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

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

User

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

group_member

Group

Группа Google, которой соответствует членство.

ЧленствоРоль

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

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

Список новых участников.

Членствобатчделетедэвентдата

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

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

Поля
memberships[]

MembershipDeletedEventData

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

Членствобатчупдатевентдата

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

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

Поля
memberships[]

MembershipUpdatedEventData

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

Членствокреатедевентдата

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

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

Поля
membership

Membership

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

ЧленствоDeletedEventData

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

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

Поля
membership

Membership

Удаленное членство. Заполняются только поля name и state .

ЧленствоUpdatedEventData

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

Тип события: 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

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

create_time

Timestamp

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

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

last_update_time

Timestamp

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

delete_time

Timestamp

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

text

string

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

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

formatted_text

string

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

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

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

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

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

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

cards[]
(deprecated)

Card

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

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

cards_v2[]

CardWithId

Массив карт .

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

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

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

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

annotations[]

Annotation

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

thread

Thread

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

space

Space

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

fallback_text

string

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

action_response

ActionResponse

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

argument_text

string

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

slash_command

SlashCommand

Только вывод. Слэш-команда, если применимо.

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

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

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

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

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

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

СообщениеDeletedEventData

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

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

Поля
message

Message

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

СообщениеUpdatedEventData

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

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

Поля
message

Message

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

ЦитируемоеСообщениеМетаданные

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

Поля
name

string

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

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

last_update_time

Timestamp

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

Реакция

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

Поля
name

string

Имя ресурса реакции.

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

user

User

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

emoji

Emoji

Смайлик, использованный в реакции.

Реакциябатчкреатедевентдата

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

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

Поля
reactions[]

ReactionCreatedEventData

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

Реакциябатчделетедэвентдата

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

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

Поля
reactions[]

ReactionDeletedEventData

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

Реакциякреатедевентдата

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

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

Поля
reaction

Reaction

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

РеакцияDeletedEventData

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

Введите: google.workspace.chat.reaction.v1.deleted

Поля
reaction

Reaction

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

РичЛинкМетаданные

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

Поля
uri

string

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

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

РичЛинкТип

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

Перечисления
DRIVE_FILE Тип расширенной ссылки Google Диска.
CHAT_SPACE Тип расширенной ссылки в пространстве чата. Например, космический смарт-чип.

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

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

Поля
use_admin_access

bool

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

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

Требуется область действия OAuth 2.0 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 соответствует 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

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

SetUpSpaceRequest

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

Поля
space

Space

Необходимый. Поле Space.spaceType является обязательным.

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

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

Чтобы создать диалог 1:1 между людьми, установите для Space.spaceType значение DIRECT_MESSAGE и установите для Space.singleUserBotDm значение false . Не устанавливайте 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 . Вы можете добавлять пользователей только при настройке пространства (добавление приложений чата поддерживается только для настройки прямого сообщения с помощью вызывающего приложения). Вы также можете добавлять участников, используя адрес электронной почты пользователя в качестве псевдонима для {user}. Например, user.name может быть users/example@gmail.com . Чтобы пригласить пользователей Gmail или пользователей из внешних доменов Google Workspace, необходимо использовать адрес электронной почты пользователя для {user} .

Для членства в группах Google поле Membership.group_member должно содержать group с заполненным name (формат groups/{group} ). Вы можете добавлять группы Google только при установке для Space.spaceType значения SPACE .

Необязательно, если для Space.spaceType задано SPACE .

Требуется при установке для Space.spaceType значения GROUP_CHAT вместе с как минимум двумя членствами.

Требуется при установке для Space.spaceType значения DIRECT_MESSAGE с пользователем-человеком и ровно с одним членом.

Должно быть пустым при создании разговора 1:1 между человеком и вызывающим приложением чата (при установке для Space.spaceType значения DIRECT_MESSAGE и Space.singleUserBotDm в true ).

СлэшКоманда

Косая черта в Google Chat.

Поля
command_id

int64

Идентификатор вызванной косой черты.

СлэшКомандаМетаданные

Метаданные аннотаций для команд с косой чертой (/).

Поля
bot

User

Приложение чата, команда которого была вызвана.

type

Type

Тип косой черты.

command_name

string

Имя вызванной косой черты.

command_id

int64

Идентификатор вызванной команды с косой чертой.

triggers_dialog

bool

Указывает, предназначена ли косая черта для диалога.

Тип

Перечисления
TYPE_UNSPECIFIED Значение по умолчанию для перечисления. Не используйте.
ADD Добавьте приложение «Чат» в пространство.
INVOKE Вызовите команду косой черты в пространстве.

Космос

Место в Google Chat. Пространства — это разговоры между двумя или более пользователями или сообщения один на один между пользователем и приложением чата.

Поля
name

string

Имя ресурса пространства.

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

type
(deprecated)

Type

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

space_type

SpaceType

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

single_user_bot_dm

bool

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

threaded
(deprecated)

bool

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

display_name

string

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

Для прямых сообщений это поле может быть пустым.

Поддерживает до 128 символов.

external_user_allowed

bool

Неизменяемый. Разрешается ли в этом пространстве любому пользователю Google Chat быть участником. Ввод при создании пространства в организации Google Workspace. Пропустите это поле при создании пространств в следующих условиях:

  • Аутентифицированный пользователь использует учетную запись потребителя (неуправляемую учетную запись пользователя). По умолчанию пространство, созданное потребительской учетной записью, разрешено любому пользователю Google Chat.

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

space_threading_state

SpaceThreadingState

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

space_details

SpaceDetails

Подробная информация о пространстве, включая описание и правила.

space_history_state

HistoryState

Состояние истории сообщений и потоков в этом пространстве.

import_mode

bool

Необязательный. Создано ли это пространство в Import Mode в рамках переноса данных в Google Workspace. Во время импорта пространств они не видны пользователям до завершения импорта.

create_time

Timestamp

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

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

Заполняется в выходных данных только в том случае, если spaceType имеет значение GROUP_CHAT или SPACE .

last_active_time

Timestamp

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

admin_installed

bool

Только вывод. Для пространств прямого обмена сообщениями (DM) с приложением Chat: было ли пространство создано администратором Google Workspace. Администраторы могут установить и настроить прямое сообщение с помощью приложения Chat от имени пользователей в своей организации.

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

membership_count

MembershipCount

Только вывод. Количество присоединившихся участников, сгруппированных по типу участников. Заполняется, когда space_type имеет значение SPACE , DIRECT_MESSAGE или GROUP_CHAT .

access_settings

AccessSettings

Необязательный. Указывает настройки доступа к пространству. Заполняется только в том случае, если space_type равен SPACE .

space_uri

string

Только вывод. URI для доступа пользователя к пространству.

Поле объединения space_permission_settings . Представляет настройки разрешений пространства. Заполняется только в том случае, если space_type равен SPACE . space_permission_settings может быть только одним из следующих:
predefined_permission_settings

PredefinedPermissionSettings

Необязательный. Только ввод. Настройки разрешения пространства. Входные данные для создания пространства. Если это поле не задано, создается пространство для совместной работы. После создания пространства параметры заполняются в поле PermissionSettings .

permission_settings

PermissionSettings

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

Доступ к настройкам

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

Поля
access_state

AccessState

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

audience

string

Необязательный. Имя ресурса целевой аудитории , которая может обнаружить пространство, присоединиться к нему и просмотреть сообщения в пространстве. Если этот параметр не установлен, доступ к нему смогут получить только пользователи или группы Google, которые были индивидуально приглашены или добавлены в пространство. Подробную информацию см. в разделе «Как сделать пространство доступным для обнаружения целевой аудиторией» .

Формат: audiences/{audience}

Чтобы использовать целевую аудиторию по умолчанию для организации Google Workspace, установите audiences/default .

Аксессстате

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

Перечисления
ACCESS_STATE_UNSPECIFIED Состояние доступа неизвестно или не поддерживается в этом API.
PRIVATE Только пользователи или группы Google, которые были индивидуально добавлены или приглашены другими пользователями или администраторами Google Workspace, могут находить пространство и получать к нему доступ.
DISCOVERABLE Менеджер пространства предоставил целевой аудитории доступ к пространству. Пользователи или группы Google, которые были индивидуально добавлены или приглашены в пространство, также могут находить его и получать к нему доступ. Дополнительные сведения см. в разделе Как сделать пространство доступным для просмотра определенным пользователям .

ЧленствоКаунт

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

Поля
joined_direct_human_user_count

int32

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

joined_group_count

int32

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

Настройка разрешений

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

Поля
managers_allowed

bool

Есть ли у менеджеров пространств это разрешение.

members_allowed

bool

Имеют ли участники, не являющиеся менеджерами, это разрешение.

Настройки разрешений

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

Поля
manage_members_and_groups

PermissionSetting

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

modify_space_details

PermissionSetting

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

toggle_history

PermissionSetting

Настройка включения и выключения истории пространства.

use_at_mention_all

PermissionSetting

Настройка использования @all в пространстве.

manage_apps

PermissionSetting

Настройка управления приложениями в пространстве.

manage_webhooks

PermissionSetting

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

post_messages

PermissionSetting

Только вывод. Настройка публикации сообщений в пространстве.

reply_messages

PermissionSetting

Настройка ответа на сообщения в пространстве.

Предопределенные параметры разрешений

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

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

ПространствоДетали

Подробная информация о пространстве, включая описание и правила.

Поля
description

string

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

Поддерживает до 150 символов.

guidelines

string

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

Поддерживает до 5000 символов.

SpaceThreadingState

Указывает тип состояния потока в пространстве чата.

Перечисления
SPACE_THREADING_STATE_UNSPECIFIED Сдержанный.
THREADED_MESSAGES Именованные пространства, поддерживающие потоки сообщений. Когда пользователи отвечают на сообщение, они могут ответить в цепочке, что сохраняет их ответ в контексте исходного сообщения.
GROUPED_MESSAGES Именованные пространства, где беседа организована по темам. Темы и ответы на них сгруппированы вместе.
UNTHREADED_MESSAGES Прямые сообщения (DM) между двумя людьми и групповые беседы между 3 или более людьми.

Тип пространства

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

Перечисления
SPACE_TYPE_UNSPECIFIED Сдержанный.
SPACE Место, где люди отправляют сообщения, обмениваются файлами и сотрудничают. SPACE может включать в себя приложения чата.
GROUP_CHAT Групповые беседы между 3 и более людьми. GROUP_CHAT может включать приложения чата.
DIRECT_MESSAGE Сообщения 1:1 между двумя людьми или человеком и приложением чата.

Тип

Устарело: вместо этого используйте SpaceType .

Перечисления
TYPE_UNSPECIFIED Сдержанный.
ROOM Разговоры между двумя и более людьми.
DM 1:1 Прямое сообщение между человеком и приложением чата, где все сообщения однородны. Обратите внимание, что сюда не входят прямые сообщения между двумя людьми.

Спейсбатчупдатедевентдата

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

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

Поля
spaces[]

SpaceUpdatedEventData

Список обновленных пространств.

SpaceEvent

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

Поля
name

string

Имя ресурса космического события.

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

event_time

Timestamp

Время, когда произошло событие.

event_type

string

Тип космического события. У каждого типа события есть пакетная версия, которая представляет несколько экземпляров события типа, происходящих за короткий период времени. Для запросов spaceEvents.list() опустите типы пакетных событий в фильтре запроса. По умолчанию сервер возвращает как тип события, так и его пакетную версию.

Поддерживаемые типы событий для сообщений :

  • Новое сообщение: google.workspace.chat.message.v1.created
  • Обновленное сообщение: google.workspace.chat.message.v1.updated
  • Удаленное сообщение: google.workspace.chat.message.v1.deleted
  • Несколько новых сообщений: google.workspace.chat.message.v1.batchCreated
  • Несколько обновленных сообщений: google.workspace.chat.message.v1.batchUpdated
  • Несколько удаленных сообщений: google.workspace.chat.message.v1.batchDeleted

Поддерживаемые типы событий для членства :

  • Новое членство: google.workspace.chat.membership.v1.created
  • Обновленное членство: google.workspace.chat.membership.v1.updated
  • Удалено членство: google.workspace.chat.membership.v1.deleted
  • Несколько новых участников: google.workspace.chat.membership.v1.batchCreated
  • Несколько обновленных членств: google.workspace.chat.membership.v1.batchUpdated
  • Несколько удаленных членств: google.workspace.chat.membership.v1.batchDeleted

Поддерживаемые типы событий для реакций :

  • Новая реакция: google.workspace.chat.reaction.v1.created
  • Удалена реакция: google.workspace.chat.reaction.v1.deleted
  • Несколько новых реакций: google.workspace.chat.reaction.v1.batchCreated
  • Несколько удаленных реакций: google.workspace.chat.reaction.v1.batchDeleted

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

  • Обновленное пространство: google.workspace.chat.space.v1.updated
  • Несколько обновлений в пространстве: google.workspace.chat.space.v1.batchUpdated

payload Union Field.

payload может быть только одной из следующих:

message_created_event_data

MessageCreatedEventData

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

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

message_updated_event_data

MessageUpdatedEventData

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

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

message_deleted_event_data

MessageDeletedEventData

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

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

message_batch_created_event_data

MessageBatchCreatedEventData

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

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

message_batch_updated_event_data

MessageBatchUpdatedEventData

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

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

message_batch_deleted_event_data

MessageBatchDeletedEventData

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

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

space_updated_event_data

SpaceUpdatedEventData

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

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

space_batch_updated_event_data

SpaceBatchUpdatedEventData

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

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

membership_created_event_data

MembershipCreatedEventData

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

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

membership_updated_event_data

MembershipUpdatedEventData

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

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

membership_deleted_event_data

MembershipDeletedEventData

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

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

membership_batch_created_event_data

MembershipBatchCreatedEventData

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

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

membership_batch_updated_event_data

MembershipBatchUpdatedEventData

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

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

membership_batch_deleted_event_data

MembershipBatchDeletedEventData

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

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

reaction_created_event_data

ReactionCreatedEventData

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

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

reaction_deleted_event_data

ReactionDeletedEventData

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

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

reaction_batch_created_event_data

ReactionBatchCreatedEventData

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

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

reaction_batch_deleted_event_data

ReactionBatchDeletedEventData

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

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

Пространствочтениестате

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

Поля
name

string

Имя ресурса состояния чтения пространства.

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

last_read_time

Timestamp

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

Спейсупдатевентдата

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

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

Поля
space

Space

Обновленное пространство.

Нить

Обсуждение в чате Google. Пример использования см . в разделе «Начать цепочку сообщений или ответить на нее» .

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

Поля
name

string

Имя ресурса потока.

Пример: spaces/{space}/threads/{thread}

thread_key

string

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

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

ThreadReadState

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

Поля
name

string

Имя ресурса состояния чтения потока.

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

last_read_time

Timestamp

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

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

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

Поля
membership

Membership

Необходимый. Членство для обновления. Обновляются только поля, указанные в update_mask .

update_mask

FieldMask

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

В настоящее время поддерживаются пути к полям:

  • role
use_admin_access

bool

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

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

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

Запрос обновления сообщения

Запрос на обновление сообщения.

Поля
message

Message

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

update_mask

FieldMask

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

В настоящее время поддерживаются пути к полям:

allow_missing

bool

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

UpdateSpaceReadStateRequest

Сообщение запроса для API UpdateSpaceReadState.

Поля
space_read_state

SpaceReadState

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

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

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

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

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

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

Формат: пользователи/{user}/spaces/{space}/spaceReadState

update_mask

FieldMask

Необходимый. Пути к полям для обновления. В настоящее время поддерживаются пути к полям:

  • last_read_time

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

Чтобы пометить пространство как прочитанное, установите для last_read_time любое значение позднее (большее), чем время создания последнего сообщения. last_read_time принудительно соответствует времени создания последнего сообщения. Обратите внимание, что состояние чтения пространства влияет только на состояние чтения сообщений, которые видны в диалоге верхнего уровня пространства. Эта временная метка не влияет на ответы в потоках, а вместо этого они зависят от состояния чтения потока.

Обновить космический запрос

Запрос на обновление отдельного пространства.

Поля
space

Space

Необходимый. Пространство с полями для обновления. Space.name должно быть заполнено в виде spaces/{space} . Обновляются только поля, указанные в update_mask .

update_mask

FieldMask

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

Вы можете обновить следующие поля для пространства:

  • space_details

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

  • space_type : поддерживает только изменение типа пространства GROUP_CHAT на SPACE . Включите display_name вместе с space_type в маску обновления и убедитесь, что указанное пространство имеет непустое отображаемое имя и тип пространства SPACE . Включение маски space_type и типа SPACE в указанное пространство при обновлении отображаемого имени не является обязательным, если существующее пространство уже имеет тип SPACE . Попытка обновить тип пространства другими способами приводит к ошибке недопустимого аргумента. space_type не поддерживается при доступе администратора.

  • space_history_state : обновляет настройки истории пространства , включая или отключая историю для пространства. Поддерживается только в том случае, если для организации Google Workspace включены настройки истории. Чтобы обновить состояние истории пространства, вы должны опустить все остальные маски полей в своем запросе. space_history_state не поддерживается при доступе администратора.

  • access_settings.audience : обновляет настройки доступа для тех, кто может обнаруживать пространство, присоединяться к нему и просматривать сообщения в именованном пространстве, где поле spaceType равно SPACE . Если у существующего пространства есть целевая аудитория, вы можете удалить аудиторию и ограничить доступ к пространству, опустив значение для этой маски поля. Чтобы обновить настройки доступа для пространства, аутентифицирующий пользователь должен быть менеджером пространства и опустить все остальные маски полей в вашем запросе. Вы не можете обновить это поле, если пространство находится в режиме импорта . Дополнительные сведения см. в разделе Как сделать пространство доступным для просмотра определенным пользователям . access_settings.audience не поддерживается при доступе администратора.

  • Предварительная версия для разработчиков: поддерживает изменение настроек разрешений пространства, поддерживаемые пути к полям включают: 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 (Предупреждение: взаимоисключающее с все остальные пути к полям настроек без разрешений). permission_settings не поддерживается при доступе администратора.

use_admin_access

bool

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

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

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

Некоторые значения FieldMask не поддерживаются при доступе администратора. Подробности смотрите в описании update_mask .

Пользователь

Пользователь в Google Chat. При возврате в качестве выходных данных запроса, если ваше приложение Chat проходит аутентификацию как пользователь , выходные данные для ресурса User содержат только name и type пользователя.

Поля
name

string

Название ресурса для user Google Chat .

Формат: users/{user} . users/app можно использовать в качестве псевдонима для вызывающего пользователя bot приложения.

Для human users {user} — это тот же идентификатор пользователя, что и:

  • id человека в API People. Например, users/123456789 в Chat API представляют того же человека, что и идентификатор профиля человека 123456789 в People API.

  • id пользователя в API каталога Admin SDK.

  • адрес электронной почты пользователя можно использовать в качестве псевдонима для {user} в запросах API. Например, если идентификатор профиля пользователя People API для user@example.com равен 123456789 , вы можете users/user@example.com в качестве псевдонима для ссылки users/123456789 . Из API будет возвращено только каноническое имя ресурса (например, users/123456789 ).

display_name

string

Только вывод. Отображаемое имя пользователя.

domain_id

string

Уникальный идентификатор домена Google Workspace пользователя.

type

Type

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

is_anonymous

bool

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

Тип

Перечисления
TYPE_UNSPECIFIED Значение по умолчанию для перечисления. НЕ ИСПОЛЬЗУЙТЕ.
HUMAN Пользователь-человек.
BOT Пользователь приложения чата.

UserMentionМетаданные

Метаданные аннотаций для упоминаний пользователей (@).

Поля
user

User

Пользователь упомянул.

type

Type

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

Тип

Перечисления
TYPE_UNSPECIFIED Значение по умолчанию для перечисления. Не используйте.
ADD Добавьте пользователя в пространство.
MENTION Упомяните пользователя в космосе.

Разметка виджета

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

Поля
buttons[]

Button

Список кнопок. Кнопки также являются oneof data , и должно быть установлено только одно из этих полей.

data поля объединения. WidgetMarkup может содержать только один из следующих элементов. Вы можете использовать несколько полей WidgetMarkup для отображения большего количества элементов. data могут быть только одним из следующих:
text_paragraph

TextParagraph

Отобразите текстовый абзац в этом виджете.

image

Image

Отобразите изображение в этом виджете.

key_value

KeyValue

Отобразите элемент ключевого значения в этом виджете.

Кнопка

Кнопка. Это может быть текстовая кнопка или кнопка изображения.

Поля

type поля объединения.

type может быть только одним из следующих:

text_button

TextButton

Кнопка с текстом и действием onclick .

image_button

ImageButton

Кнопка с изображением и действием onclick .

ФормаДействие

Действие формы описывает поведение при отправке формы. Например, вы можете вызвать Apps Script для обработки формы.

Поля
action_method_name

string

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

parameters[]

ActionParameter

Список параметров действия.

Параметр действия

Список строковых параметров, которые необходимо указать при вызове метода действия. Например, рассмотрим три кнопки повтора: отложить сейчас, отложить один день, отложить на следующей неделе. Вы можете использовать action method = snooze() , передав тип и время повтора в списке строковых параметров.

Поля
key

string

Имя параметра сценария действия.

value

string

Значение параметра.

Икона

Набор поддерживаемых иконок.

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

Изображение

Изображение, заданное URL-адресом и может иметь действие onclick .

Поля
image_url

string

URL-адрес изображения.

on_click

OnClick

Действие onclick .

aspect_ratio

double

Соотношение сторон этого изображения (ширина и высота). Это поле позволяет вам зарезервировать нужную высоту изображения во время ожидания его загрузки. Он не предназначен для переопределения встроенного соотношения сторон изображения. Если этот параметр не установлен, сервер заполняет его, предварительно загружая изображение.

Кнопка изображения

Кнопка изображения с действием onclick .

Поля
on_click

OnClick

Действие onclick .

name

string

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

icons полей Союза. Значок можно указать с помощью enum Icon или URL-адреса. icons могут быть только одним из следующих:
icon

Icon

Значок, заданный enum , которое индексирует значок, предоставленный Chat API.

icon_url

string

Значок, заданный URL-адресом.

КлючЗначение

Элемент пользовательского интерфейса содержит ключ (метку) и значение (содержимое). Этот элемент также может содержать некоторые действия, такие как кнопка onclick .

Поля
top_label

string

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

content

string

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

content_multiline

bool

Если контент должен быть многострочным.

bottom_label

string

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

on_click

OnClick

Действие onclick . Щелкать можно только по верхней метке, нижней метке и области содержимого.

icons полей Союза. Должен быть определен хотя бы один из значков: top_label и bottom_label . icons могут быть только одним из следующих:
icon

Icon

Значение перечисления, которое API Chat заменяет соответствующим изображением значка.

icon_url

string

Значок, заданный URL-адресом.

Полевой control Союза. Виджет управления. Вы можете установить либо button , либо switch_widget , но не оба сразу. control может быть только одним из следующих:
button

Button

Кнопка, по которой можно нажать, чтобы вызвать действие.

OnClick

Действие onclick (например, открытие ссылки).

Поля

data поля объединения.

data могут быть только одним из следующих:

action

FormAction

Действие формы запускается этим действием onclick если оно указано.

ТекстКнопка

Кнопка с текстом и действием onclick .

Поля
text

string

Текст кнопки.

on_click

OnClick

Действие onclick .

Текстовый абзац

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

Поля
text

string