Индекс
-
ChatService
(интерфейс) -
AccessoryWidget
(сообщение) -
ActionResponse
(сообщение) -
ActionResponse.ResponseType
(перечисление) -
ActionResponse.SelectionItems
(сообщение) -
ActionResponse.UpdatedWidget
(сообщение) -
ActionStatus
(сообщение) -
Annotation
(сообщение) -
AnnotationType
(перечисление) -
AttachedGif
(сообщение) -
Attachment
(сообщение) -
Attachment.Source
(перечисление) -
AttachmentDataRef
(сообщение) -
CardWithId
(сообщение) -
ChatSpaceLinkData
(сообщение) -
CompleteImportSpaceRequest
(сообщение) -
CompleteImportSpaceResponse
(сообщение) -
ContextualAddOnMarkup
(сообщение) -
ContextualAddOnMarkup.Card
(сообщение) -
ContextualAddOnMarkup.Card.CardAction
(сообщение) -
ContextualAddOnMarkup.Card.CardHeader
(сообщение) -
ContextualAddOnMarkup.Card.CardHeader.ImageStyle
(перечисление) -
ContextualAddOnMarkup.Card.Section
(сообщение) -
CreateMembershipRequest
(сообщение) -
CreateMessageRequest
(сообщение) -
CreateMessageRequest.MessageReplyOption
(перечисление) -
CreateReactionRequest
(сообщение) -
CreateSpaceRequest
(сообщение) -
CustomEmoji
(сообщение) -
DeleteMembershipRequest
(сообщение) -
DeleteMessageRequest
(сообщение) -
DeleteReactionRequest
(сообщение) -
DeleteSpaceRequest
(сообщение) -
DeletionMetadata
(сообщение) -
DeletionMetadata.DeletionType
(перечисление) -
Dialog
(сообщение) -
DialogAction
(сообщение) -
DriveDataRef
(сообщение) -
DriveLinkData
(сообщение) -
Emoji
(сообщение) -
EmojiReactionSummary
(сообщение) -
FindDirectMessageRequest
(сообщение) -
GetAttachmentRequest
(сообщение) -
GetMembershipRequest
(сообщение) -
GetMessageRequest
(сообщение) -
GetSpaceEventRequest
(сообщение) -
GetSpaceReadStateRequest
(сообщение) -
GetSpaceRequest
(сообщение) -
GetThreadReadStateRequest
(сообщение) -
Group
(сообщение) -
HistoryState
(перечисление) -
ListMembershipsRequest
(сообщение) -
ListMembershipsResponse
(сообщение) -
ListMessagesRequest
(сообщение) -
ListMessagesResponse
(сообщение) -
ListReactionsRequest
(сообщение) -
ListReactionsResponse
(сообщение) -
ListSpaceEventsRequest
(сообщение) -
ListSpaceEventsResponse
(сообщение) -
ListSpacesRequest
(сообщение) -
ListSpacesResponse
(сообщение) -
MatchedUrl
(сообщение) -
Membership
(сообщение) -
Membership.MembershipRole
(перечисление) -
Membership.MembershipState
(перечисление) -
MembershipBatchCreatedEventData
(сообщение) -
MembershipBatchDeletedEventData
(сообщение) -
MembershipBatchUpdatedEventData
(сообщение) -
MembershipCreatedEventData
(сообщение) -
MembershipDeletedEventData
(сообщение) -
MembershipUpdatedEventData
(сообщение) -
Message
(сообщение) -
MessageBatchCreatedEventData
(сообщение) -
MessageBatchDeletedEventData
(сообщение) -
MessageBatchUpdatedEventData
(сообщение) -
MessageCreatedEventData
(сообщение) -
MessageDeletedEventData
(сообщение) -
MessageUpdatedEventData
(сообщение) -
QuotedMessageMetadata
(сообщение) -
Reaction
(сообщение) -
ReactionBatchCreatedEventData
(сообщение) -
ReactionBatchDeletedEventData
(сообщение) -
ReactionCreatedEventData
(сообщение) -
ReactionDeletedEventData
(сообщение) -
RichLinkMetadata
(сообщение) -
RichLinkMetadata.RichLinkType
(перечисление) -
SearchSpacesRequest
(сообщение) -
SearchSpacesResponse
(сообщение) -
SetUpSpaceRequest
(сообщение) -
SlashCommand
(сообщение) -
SlashCommandMetadata
(сообщение) -
SlashCommandMetadata.Type
(перечисление) -
Space
(сообщение) -
Space.AccessSettings
(сообщение) -
Space.AccessSettings.AccessState
(перечисление) -
Space.MembershipCount
(сообщение) -
Space.PermissionSetting
(сообщение) -
Space.PermissionSettings
(сообщение) -
Space.PredefinedPermissionSettings
(перечисление) -
Space.SpaceDetails
(сообщение) -
Space.SpaceThreadingState
(перечисление) -
Space.SpaceType
(перечисление) -
Space.Type
(перечисление) -
SpaceBatchUpdatedEventData
(сообщение) -
SpaceEvent
(сообщение) -
SpaceReadState
(сообщение) -
SpaceUpdatedEventData
(сообщение) -
Thread
(сообщение) -
ThreadReadState
(сообщение) -
UpdateMembershipRequest
(сообщение) -
UpdateMessageRequest
(сообщение) -
UpdateSpaceReadStateRequest
(сообщение) -
UpdateSpaceRequest
(сообщение) -
User
(сообщение) -
User.Type
(перечисление) -
UserMentionMetadata
(сообщение) -
UserMentionMetadata.Type
(перечисление) -
WidgetMarkup
(сообщение) -
WidgetMarkup.Button
(сообщение) -
WidgetMarkup.FormAction
(сообщение) -
WidgetMarkup.FormAction.ActionParameter
(сообщение) -
WidgetMarkup.Icon
(перечисление) -
WidgetMarkup.Image
(сообщение) -
WidgetMarkup.ImageButton
(сообщение) -
WidgetMarkup.KeyValue
(сообщение) -
WidgetMarkup.OnClick
(сообщение) -
WidgetMarkup.OpenLink
(сообщение) -
WidgetMarkup.TextButton
(сообщение) -
WidgetMarkup.TextParagraph
(сообщение)
ЧатСервис
Позволяет разработчикам создавать приложения Chat и их интеграцию на платформе Google Chat.
CompleteImportSpace |
---|
Завершает процесс импорта указанного пространства и делает его видимым для пользователей. Требуется аутентификация приложения и делегирование на уровне домена. Дополнительную информацию см. в разделе Разрешение приложениям Google Chat импортировать данные .
|
Создать членство |
---|
Создает членство для вызывающего приложения Chat, пользователя или группы Google. Создание членства для других приложений Chat не поддерживается. Если при создании членства у указанного участника отключена политика автоматического принятия, он будет приглашен и должен принять приглашение в пространство, прежде чем присоединиться. В противном случае при создании членства участник добавляется непосредственно в указанное пространство. Требует аутентификации пользователя . Пример использования см.:
|
Создать сообщение |
---|
Создает сообщение в чате Google. Пример см. в разделе «Отправить сообщение» . Метод На следующем изображении показано, как Chat атрибутирует сообщение при использовании аутентификации приложения. Chat отображает приложение Chat в качестве отправителя сообщения. Содержимое сообщения может содержать текст ( На следующем изображении показано, как Chat атрибутирует сообщение при использовании аутентификации пользователя. Chat отображает пользователя как отправителя сообщения и связывает приложение Chat с сообщением, отображая его имя. Содержимое сообщения может содержать только текст ( Максимальный размер сообщения, включая его содержимое, составляет 32 000 байт.
|
Создатьреакцию |
---|
Создает реакцию и добавляет ее в сообщение. Поддерживаются только смайлы Юникода. Пример см. в разделе Добавление реакции на сообщение . Требует аутентификации пользователя .
|
Создать пространство |
---|
Создает именованное пространство. Пространства, сгруппированные по темам, не поддерживаются. Пример см. в разделе Создание пространства . Если при создании пространства вы получаете сообщение об ошибке Требует аутентификации пользователя .
|
Удалить членство |
---|
Удаляет членство. Пример см. в статье Удаление пользователя или приложения Google Chat из пространства . Требует аутентификации пользователя .
|
Удалить сообщение |
---|
Удаляет сообщение. Пример см. в разделе Удаление сообщения . Требует аутентификации . Поддерживает аутентификацию приложений и аутентификацию пользователей . При использовании аутентификации приложения запросы могут удалять только сообщения, созданные вызывающим приложением чата.
|
Удалитьреакцию |
---|
Удаляет реакцию на сообщение. Поддерживаются только смайлы Юникода. Пример см. в разделе Удаление реакции . Требует аутентификации пользователя .
|
Удалить пространство |
---|
Удаляет именованное пространство. Всегда выполняет каскадное удаление, что означает, что дочерние ресурсы пространства, такие как сообщения, опубликованные в пространстве, и членство в пространстве, также удаляются. Пример см. в разделе Удаление пробела . Требуется аутентификация пользователя от пользователя, у которого есть разрешение на удаление пространства.
|
НайтиDirectMessage |
---|
Возвращает существующее прямое сообщение указанному пользователю. Если пространство для прямых сообщений не найдено, возвращается ошибка При аутентификации пользователя возвращает пространство прямого сообщения между указанным пользователем и пользователем, прошедшим проверку подлинности. При проверке подлинности приложения возвращает пространство прямого сообщения между указанным пользователем и вызывающим приложением чата. Требуется аутентификация пользователя или аутентификация приложения .
|
Получить вложение |
---|
Получает метаданные вложения сообщения. Данные вложения извлекаются с помощью медиа API . Пример см. в разделе Получение метаданных о вложении сообщения . Требуется аутентификация приложения .
|
Получить членство |
---|
Возвращает сведения о членстве. Пример см. в разделе Получение сведений о членстве пользователя или приложения Google Chat . Требует аутентификации . Поддерживает аутентификацию приложений и аутентификацию пользователей .
|
Получить сообщение |
---|
Возвращает сведения о сообщении. Пример см. в разделе Получение сведений о сообщении . Требует аутентификации . Поддерживает аутентификацию приложений и аутентификацию пользователей . Примечание. Может вернуть сообщение от заблокированного участника или пространства.
|
GetSpace |
---|
Возвращает подробную информацию о пространстве. Пример см. в разделе Получение сведений о пространстве . Требует аутентификации . Поддерживает аутентификацию приложений и аутентификацию пользователей .
|
GetSpaceEvent |
---|
Возвращает событие из пространства Google Chat. Полезные данные события содержат самую последнюю версию измененного ресурса. Например, если вы запрашиваете событие о новом сообщении, но позже оно было обновлено, сервер возвращает обновленный ресурс Требует аутентификации пользователя . Чтобы получить событие, аутентифицированный пользователь должен быть членом пространства. Пример см. в разделе Получение сведений о событии из чата Google .
|
GetSpaceReadState |
---|
Возвращает сведения о состоянии чтения пользователя в пространстве, используемые для идентификации прочитанных и непрочитанных сообщений. Пример см. в разделе Получение сведений о состоянии чтения пространства пользователя . Требует аутентификации пользователя .
|
GetThreadReadState |
---|
Возвращает сведения о состоянии чтения пользователя в потоке, используемые для идентификации прочитанных и непрочитанных сообщений. Пример см. в разделе Получение сведений о состоянии чтения потока пользователя . Требует аутентификации пользователя .
|
Список членства |
---|
Перечисляет членство в пространстве. Пример см. в разделе Список пользователей и приложений Google Chat в пространстве . В списке участников с проверкой подлинности приложения перечислены участники в пространствах, к которым у приложения Chat есть доступ, но исключаются членства в приложении Chat, включая собственное. В списке участников с аутентификацией пользователя перечислены членства в пространствах, к которым имеет доступ аутентифицированный пользователь. Требует аутентификации . Поддерживает аутентификацию приложений и аутентификацию пользователей .
|
Список сообщений |
---|
Перечисляет сообщения в пространстве, участником которого является вызывающий абонент, включая сообщения от заблокированных участников и пространств. Если вы перечислите сообщения из пространства, в котором нет сообщений, ответом будет пустой объект. При использовании интерфейса REST/HTTP ответ содержит пустой объект JSON
|
Список реакций |
---|
Перечисляет реакции на сообщение. Пример см. в разделе Список реакций на сообщение . Требует аутентификации пользователя .
|
ListSpaceEvents |
---|
Перечисляет события из пространства Google Chat. Для каждого события полезные данные содержат самую последнюю версию ресурса Chat. Например, если вы перечислите события о новых участниках пространства, сервер вернет ресурсы Требует аутентификации пользователя . Чтобы составить список событий, аутентифицированный пользователь должен быть участником пространства. Пример см. в разделе Список событий из чата Google .
|
Список пространств |
---|
Перечисляет пространства, членом которых является вызывающий абонент. Групповые чаты и личные сообщения не отображаются в списке до тех пор, пока не будет отправлено первое сообщение. Пример см. в разделе Пространства списков . Требует аутентификации . Поддерживает аутентификацию приложений и аутентификацию пользователей . Перечисляет пространства, видимые вызывающему абоненту или аутентифицированному пользователю. Групповые чаты и личные сообщения не отображаются в списке до тех пор, пока не будет отправлено первое сообщение. Чтобы получить список всех именованных пространств по организациям Google Workspace, используйте вместо этого метод
|
Поиск пространств |
---|
Возвращает список пространств на основе поиска пользователя. Требует аутентификации пользователя . Пользователь должен быть администратором организации Google Workspace. В запросе установите для
|
SetUpSpace |
---|
Создает пространство и добавляет в него указанных пользователей. Вызывающий пользователь автоматически добавляется в пространство и не должен указываться как член в запросе. Пример см. в разделе «Настройка пространства с первоначальными участниками» . Чтобы указать добавляемых участников-людей, добавьте членство с соответствующим Чтобы указать группы Google для добавления, добавьте членство с соответствующим Если для именованного пространства или группового чата вызывающий абонент блокируется или заблокирован некоторыми участниками или не имеет разрешения на добавление некоторых участников, то эти участники не добавляются в созданное пространство. Чтобы создать прямое сообщение (DM) между вызывающим пользователем и другим пользователем-человеком, укажите ровно одно членство, которое будет представлять пользователя-человека. Если один пользователь блокирует другого, запрос не выполняется и DM не создается. Чтобы создать DM между вызывающим пользователем и вызывающим приложением, установите для Если DM уже существует между двумя пользователями, даже если один пользователь блокирует другого во время запроса, тогда возвращается существующая DM. Темы с цепочками ответов не поддерживаются. Если при настройке пространства вы получаете сообщение об ошибке Требует аутентификации пользователя .
|
Обновление членства |
---|
Обновляет членство. Пример см. в разделе Обновление членства пользователя в пространстве . Требует аутентификации пользователя .
|
Обновление сообщения |
---|
Обновляет сообщение. Существует разница между методами Требует аутентификации . Поддерживает аутентификацию приложений и аутентификацию пользователей . При использовании аутентификации приложения запросы могут обновлять только сообщения, созданные вызывающим приложением чата.
|
ОбновлениеПространство |
---|
Обновляет пространство. Пример см. в разделе Обновление пространства . Если вы обновляете поле Требует аутентификации пользователя .
|
UpdateSpaceReadState |
---|
Обновляет состояние чтения пользователя в пространстве, используемое для идентификации прочитанных и непрочитанных сообщений. Пример см . в разделе Обновление состояния чтения пространства пользователя . Требует аутентификации пользователя .
|
АксессуарВиджет
Один или несколько интерактивных виджетов, которые появляются внизу сообщения. Подробности см. в разделе Добавление интерактивных виджетов внизу сообщения .
Поля | |
---|---|
Полевые action Союза. Тип действия. action может быть только одним из следующих: | |
button_list | Список кнопок. |
ДействиеОтвет
Параметры, которые приложение чата может использовать для настройки способа публикации ответа.
Поля | |
---|---|
type | Только ввод. Тип ответа приложения Chat. |
url | Только ввод. URL-адрес для пользователей для аутентификации или настройки. (Только для типов ответов |
dialog_action | Только ввод. Ответ на событие взаимодействия, связанное с диалогом . Должен сопровождаться |
updated_widget | Только ввод. Ответ обновленного виджета. |
Тип ответа
Тип ответа приложения 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. |
Обновленный виджет
Ответ обновленного виджета. Используется для предоставления параметров автозаполнения для виджета.
Поля | |
---|---|
widget | Идентификатор обновленного виджета. Идентификатор должен совпадать с идентификатором виджета, который инициировал запрос на обновление. |
Поле объединения updated_widget . Виджет обновляется в ответ на действие пользователя. updated_widget может быть только одним из следующих: | |
suggestions | Список результатов автозаполнения виджета |
Статус действия
Представляет состояние запроса на вызов или отправку диалога .
Поля | |
---|---|
status_code | Код состояния. |
user_facing_message | Сообщение для отправки пользователям о статусе их запроса. Если значение не установлено, отправляется общее сообщение на основе |
Аннотация
Только вывод. Аннотации, связанные с текстовым телом сообщения. Чтобы добавить базовое форматирование к текстовому сообщению, см. раздел Форматирование текстовых сообщений .
Пример тела сообщения в виде обычного текста:
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 | Тип этой аннотации. |
length | Длина подстроки в теле сообщения в виде обычного текста, которой соответствует эта аннотация. |
start_index | Начальный индекс (отсчитываемый от 0 включительно) в теле текстового сообщения, которому соответствует эта аннотация. |
metadata поля объединения. Дополнительные метаданные об аннотации. metadata могут быть только одним из следующих: | |
user_mention | Метаданные упоминания пользователя. |
slash_command | Метаданные для косой черты. |
rich_link_metadata | Метаданные для расширенной ссылки. |
Тип аннотации
Тип аннотации.
Перечисления | |
---|---|
ANNOTATION_TYPE_UNSPECIFIED | Значение по умолчанию для перечисления. Не используйте. |
USER_MENTION | Упоминается пользователь. |
SLASH_COMMAND | Вызывается команда косой черты. |
RICH_LINK | Богатая аннотация ссылок. |
ПрикрепленоGif
Изображение GIF, заданное URL-адресом.
Поля | |
---|---|
uri | Только вывод. URL-адрес, на котором размещено изображение GIF. |
Вложение
Вложение в Google Chat.
Поля | |
---|---|
name | Имя ресурса вложения в форме |
content_name | Только вывод. Исходное имя файла содержимого, а не полный путь. |
content_type | Только вывод. Тип содержимого (тип MIME) файла. |
thumbnail_uri | Только вывод. URL-адрес миниатюры, который следует использовать для предварительного просмотра вложения пользователю-человеку. Приложения чата не должны использовать этот URL-адрес для загрузки содержимого вложений. |
download_uri | Только вывод. URL-адрес загрузки, который следует использовать, чтобы позволить пользователю-человеку загрузить вложение. Приложения чата не должны использовать этот URL-адрес для загрузки содержимого вложений. |
source | Только вывод. Источник вложения. |
Поле объединения data_ref . Ссылка на данные во вложении. data_ref может быть только одним из следующих: | |
attachment_data_ref | Ссылка на данные вложения. Это поле используется с медиа-API для загрузки данных вложения. |
drive_data_ref | Только вывод. Ссылка на вложение Google Диска. Это поле используется с API Google Диска. |
Источник
Источник вложения.
Перечисления | |
---|---|
SOURCE_UNSPECIFIED | Сдержанный. |
DRIVE_FILE | Это файл Google Диска. |
UPLOADED_CONTENT | Файл будет загружен в чат. |
ссылка на вложение данных
Ссылка на данные вложения.
Поля | |
---|---|
resource_name | Имя ресурса данных вложения. Это поле используется с медиа-API для загрузки данных вложения. |
attachment_upload_token | Непрозрачный токен, содержащий ссылку на загруженный вложение. Рассматривается клиентами как непрозрачная строка и используется для создания или обновления сообщений чата с вложениями. |
Картасид
Карточка в сообщении Google Chat.
Только приложения чата могут создавать карточки. Если ваше приложение Chat авторизуется как пользователь , сообщение не может содержать карточки.
Создавайте и просматривайте карты с помощью Card Builder.
Откройте конструктор карточекПоля | |
---|---|
card_id | Требуется, если сообщение содержит несколько карточек. Уникальный идентификатор карты в сообщении. |
card | Карта. Максимальный размер — 32 КБ. |
ChatSpaceLinkData
Данные для ссылок в чате.
Поля | |
---|---|
space | Пространство связанного ресурса пространства чата. Формат: |
thread | Ветка связанного ресурса чата. Формат: |
message | Сообщение связанного ресурса пространства чата. Формат: |
Завершить импорт пространства запрос
Сообщение с запросом о завершении процесса импорта пространства.
Поля | |
---|---|
name | Необходимый. Имя ресурса пространства режима импорта. Формат: |
Комплеимпортспейсереспонс
Ответное сообщение о завершении процесса импорта пространства.
Поля | |
---|---|
space | Пространство режима импорта. |
Контекстная надстройкаразметка
Этот тип не имеет полей.
Разметка, позволяющая разработчикам указывать содержимое контекстного дополнения.
Карта
Карточка — это элемент пользовательского интерфейса, который может содержать виджеты пользовательского интерфейса, такие как текст и изображения.
Поля | |
---|---|
header | Заголовок карты. Заголовок обычно содержит заголовок и изображение. |
sections[] | Разделы разделены разделителем строк. |
card_actions[] | Действия этой карты. |
name | Название карты. |
КартаДействие
Действие карты — это действие, связанное с картой. Для карточки счета-фактуры типичным действием будет: удалить счет, отправить счет по электронной почте или открыть счет в браузере.
Не поддерживается приложениями Google Chat.
Поля | |
---|---|
action_label | Метка раньше отображалась в пункте меню действий. |
on_click | Действие onclick для этого элемента действия. |
Заголовок карты
Поля | |
---|---|
title | Должно быть указано название. Заголовок имеет фиксированную высоту: если указаны и заголовок, и подзаголовок, каждый занимает одну строку. Если указан только заголовок, он занимает обе строки. |
subtitle | Подзаголовок шапки карты. |
image_style | Тип изображения (например, квадратная или круглая рамка). |
image_url | URL-адрес изображения в заголовке карты. |
Стиль изображения
Перечисления | |
---|---|
IMAGE_STYLE_UNSPECIFIED | |
IMAGE | Квадратная граница. |
AVATAR | Круглая граница. |
Раздел
Раздел содержит коллекцию виджетов, которые отображаются (вертикально) в том порядке, в котором они указаны. На всех платформах карточки имеют узкую фиксированную ширину, поэтому в настоящее время нет необходимости в свойствах макета (например, float).
Поля | |
---|---|
header | Заголовок раздела. Поддерживается форматированный текст. Дополнительную информацию о форматировании текста см. в разделах «Форматирование текста в приложениях Google Chat» и «Форматирование текста в надстройках Google Workspace» . |
widgets[] | Раздел должен содержать хотя бы один виджет. |
Создать запрос на членство
Сообщение с запросом на создание членства.
Поля | |
---|---|
parent | Необходимый. Имя ресурса пространства, для которого необходимо создать членство. Формат: пробелы/{пробел} |
membership | Необходимый. Отношение членства для создания. |
use_admin_access | Если Вызывающий пользователь должен быть администратором Google Workspace с правом управления чатом и беседами в чат-группах . Требуется область действия OAuth 2.0 Создание членства в приложении или членство для пользователей за пределами организации Google Workspace, принадлежащей администратору, не поддерживается с использованием доступа администратора. |
Создать запрос сообщения
Создает сообщение.
Поля | |
---|---|
parent | Необходимый. Имя ресурса пространства, в котором создается сообщение. Формат: |
message | Необходимый. Тело сообщения. |
thread_key | Необязательный. Устарело: вместо этого используйте |
request_id | Необязательный. Уникальный идентификатор запроса для этого сообщения. Указание существующего идентификатора запроса возвращает сообщение, созданное с этим идентификатором, вместо создания нового сообщения. |
message_reply_option | Необязательный. Указывает, запускает ли сообщение цепочку или отвечает на нее. Поддерживается только в именованных пространствах. |
message_id | Необязательный. Пользовательский идентификатор сообщения. Позволяет приложениям чата получать, обновлять или удалять сообщения без необходимости сохранять назначенный системой идентификатор в имени ресурса сообщения (представленном в поле Значение этого поля должно соответствовать следующим требованиям:
Подробности см. в разделе Назовите сообщение . |
Опция ответа сообщения
Указывает, как ответить на сообщение. В будущем могут быть добавлены и другие штаты.
Перечисления | |
---|---|
MESSAGE_REPLY_OPTION_UNSPECIFIED | По умолчанию. Начинает новую тему. Использование этой опции игнорирует любой включенный thread ID или . |
REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD | Создает сообщение как ответ на поток, указанный thread ID или . Если это не удается, вместо этого сообщение запускает новый поток. |
REPLY_MESSAGE_OR_FAIL | Создает сообщение как ответ на поток, указанный thread ID или . Если используется новый thread_key , создается новый поток. Если создать сообщение не удалось, вместо этого возвращается ошибка NOT_FOUND . |
CreateReactionRequest
Создает реакцию на сообщение.
Поля | |
---|---|
parent | Необходимый. Сообщение, в котором создается реакция. Формат: |
reaction | Необходимый. Реакция на создание. |
CreateSpaceRequest
Запрос на создание именованного пространства.
Поля | |
---|---|
space | Необходимый. Поля Если вы получили сообщение об ошибке |
request_id | Необязательный. Уникальный идентификатор этого запроса. Рекомендуется использовать случайный UUID. Указание существующего идентификатора запроса возвращает пространство, созданное с этим идентификатором, вместо создания нового пространства. Указание существующего идентификатора запроса из того же приложения чата с другим пользователем, прошедшим проверку подлинности, возвращает ошибку. |
ПользовательскиеEmoji
Представляет пользовательский эмодзи.
Поля | |
---|---|
uid | Только вывод. Уникальный ключ для пользовательского ресурса смайлов. |
Удалить запрос на членство
Запрос на удаление членства в пространстве.
Поля | |
---|---|
name | Необходимый. Имя ресурса членства, которое требуется удалить. Приложения чата могут удалять пользователей-людей или их собственные членства. Приложения чата не могут удалять членство других приложений. При удалении человеческого членства требуется область действия При удалении членства в приложении требуется область действия Формат: |
use_admin_access | Если Вызывающий пользователь должен быть администратором Google Workspace с правом управления чатом и беседами в чат-группах . Требуется область действия OAuth 2.0 Удаление членства в приложении в пространстве не поддерживается с использованием доступа администратора. |
Удалить сообщениезапрос
Просьба удалить сообщение.
Поля | |
---|---|
name | Необходимый. Имя ресурса сообщения. Формат: Если вы установили собственный идентификатор для своего сообщения, вы можете использовать значение из поля |
force | Если Применяется только при аутентификации пользователя . Не имеет эффекта при аутентификации в приложении чата . |
Удалитьреакционрекуест
Удаляет реакцию на сообщение.
Поля | |
---|---|
name | Необходимый. Название реакции, которую нужно удалить. Формат: |
Удалить спейсрекуест
Запрос на удаление пространства.
Поля | |
---|---|
name | Необходимый. Имя ресурса пространства, которое требуется удалить. Формат: |
use_admin_access | Если Вызывающий пользователь должен быть администратором Google Workspace с правом управления чатом и беседами в чат-группах . Требуется область действия OAuth 2.0 |
Удаление метаданных
Информация об удаленном сообщении. Сообщение удаляется, если установлено delete_time
.
Поля | |
---|---|
deletion_type | Указывает, кто удалил сообщение. |
Тип удаления
Кто удалил сообщение и как оно было удалено.
Перечисления | |
---|---|
DELETION_TYPE_UNSPECIFIED | Это значение не используется. |
CREATOR | Пользователь удалил собственное сообщение. |
SPACE_OWNER | Владелец темы удалил сообщение. |
ADMIN | Администратор Google Workspace удалил сообщение. |
APP_MESSAGE_EXPIRY | Приложение чата удалило собственное сообщение по истечении срока его действия. |
CREATOR_VIA_APP | Приложение чата удалило сообщение от имени пользователя. |
SPACE_OWNER_VIA_APP | Приложение чата удалило сообщение от имени владельца чат-группы. |
Диалог
Обертка вокруг тела карточки диалога.
Поля | |
---|---|
body | Только ввод. Тело диалога, отображаемое в модальном режиме. Приложения Google Chat не поддерживают следующие объекты карточек: |
ДиалогДействие
Содержит диалоговое окно и код состояния запроса.
Поля | |
---|---|
action_status | Только ввод. Статус запроса на вызов или отправку диалога . Отображает статус и сообщение пользователям, если это необходимо. Например, в случае ошибки или успеха. |
Полевые action Союза. Действие, которое необходимо выполнить. action может быть только одним из следующих: | |
dialog | Только ввод. Диалог запроса. |
DriveDataRef
Ссылка на данные о подключении диска.
Поля | |
---|---|
drive_file_id | Идентификатор файла диска. Используйте с API Диска. |
DriveLinkData
Данные для ссылок на Google Диск.
Поля | |
---|---|
drive_data_ref | DriveDataRef , который ссылается на файл Google Диска. |
mime_type | Тип MIME связанного ресурса Google Диска. |
Эмодзи
Эмодзи, который используется как реакция на сообщение.
Поля | |
---|---|
content поля объединения. Содержание смайлика. content может быть только одним из следующих: | |
unicode | Базовый смайлик, представленный строкой Юникода. |
custom_emoji | Только вывод. Пользовательский смайлик. |
EmojiРеакцияСводка
Количество людей, которые отреагировали на сообщение определенным смайлом.
Поля | |
---|---|
emoji | Эмодзи, связанные с реакциями. |
reaction_count | Общее количество реакций с использованием соответствующего смайла. |
FindDirectMessageRequest
Запрос на получение места для прямых сообщений на основе пользовательского ресурса.
Поля | |
---|---|
name | Необходимый. Имя ресурса пользователя, с которым можно найти прямое сообщение. Формат: |
GetAttachmentRequest
Запрос на получение вложения.
Поля | |
---|---|
name | Необходимый. Имя ресурса вложения в форме |
Получить запрос на членство
Запрос на членство в пространстве.
Поля | |
---|---|
name | Необходимый. Имя ресурса членства, которое требуется получить. Чтобы получить собственное членство приложения с помощью аутентификации пользователя , вы можете дополнительно использовать Формат: После аутентификации пользователя вы можете использовать адрес электронной почты пользователя в качестве псевдонима для |
use_admin_access | Если Вызывающий пользователь должен быть администратором Google Workspace с правом управления чатом и беседами в чат-группах . Требуются области OAuth 2.0 Получение членства приложений в пространстве не поддерживается при использовании доступа администратора. |
Получить запрос сообщения
Запрос на получение сообщения.
Поля | |
---|---|
name | Необходимый. Имя ресурса сообщения. Формат: Если вы установили собственный идентификатор для своего сообщения, вы можете использовать значение из поля |
GetSpaceEventRequest
Сообщение запроса на получение космического события.
Поля | |
---|---|
name | Необходимый. Имя ресурса космического события. Формат: |
GetSpaceReadStateRequest
Сообщение запроса для API GetSpaceReadState.
Поля | |
---|---|
name | Необходимый. Имя ресурса состояния чтения пространства, которое требуется получить. Поддерживается получение состояния чтения только для вызывающего пользователя. Чтобы обратиться к вызывающему пользователю, установите одно из следующих значений:
Формат: users/{user}/spaces/{space}/spacereadstate |
GetSpacerequest
Просьба вернуть одно пространство.
Поля | |
---|---|
name | Необходимый. Имя ресурса пространства, в формах Form Формат: |
use_admin_access | Когда Пользователь по вызову должен быть администратором Google Workspace с привилегией Manage CHAT и Spaces Trantings . Требует |
GetThreadReadStateRequest
Запросить сообщение о GetThreadReadStateRequest API.
Поля | |
---|---|
name | Необходимый. Название ресурса потока считываем состояние для извлечения. Поддерживает только получение состояния чтения для звонящего пользователя. Чтобы обозначить пользователя по вызову, установите одно из следующих:
Формат: users/{user}/spaces/{space}/threads/{thread}/threadReadState |
Группа
Группа Google в чате Google.
Поля | |
---|---|
name | Имя ресурса для группы Google. Представляет группу в группе облачных идентификаторов API. Формат: группы/{группа} |
ИСТОРИЯ
Государство истории для сообщений и пространств. Определяет, как долго хранятся сообщения и беседы после создания.
Перечисления | |
---|---|
HISTORY_STATE_UNSPECIFIED | Значение по умолчанию. Не используйте. |
HISTORY_OFF | История выключена. Сообщения и потоки хранятся в течение 24 часов . |
HISTORY_ON | История на. Правила удержания хранилища организации указывают, как долго хранятся сообщения и потоки. |
Listmembershipsrequest
Запросить сообщение о перечислении членства.
Поля | |
---|---|
parent | Необходимый. Название ресурса пространства, для которого можно получить список членов. Формат: пространства/{пространство} |
page_size | Необязательный. Максимальное количество членов для возврата. Служба может вернуть меньше этого значения. В случае неопределенности, не более 100 членов возвращаются. Максимальное значение составляет 1000. Если вы используете значение более 1000, оно автоматически изменяется на 1000. Отрицательные значения возвращают ошибку |
page_token | Необязательный. Токен страницы, полученный от предыдущего вызова для перечисления членов. Предоставьте этот параметр, чтобы получить последующую страницу. При нанесении на страницу все другие предоставленные параметры должны соответствовать вызову, который предоставил токен страницы. Передача различных значений к другим параметрам может привести к неожиданным результатам. |
filter | Необязательный. Фильтр запросов. Вы можете отфильтровать членство с помощью роли ( Чтобы фильтровать по роли, установить Чтобы фильтровать по типу, установите Чтобы отфильтровать как роли, так и типом, используйте Либо Например, следующие запросы действительны:
Следующие запросы недействительны:
Неверные запросы отклоняются сервером с ошибкой |
show_groups | Необязательный. Когда |
show_invited | Необязательный. Когда В настоящее время требуется аутентификация пользователя . |
use_admin_access | Когда Пользователь по вызову должен быть администратором Google Workspace с привилегией Manage CHAT и Spaces Trantings . Требует либо Перечисление участников приложения в пространстве не поддерживается при использовании доступа к администратору. |
Listmembershipsresponse
Ответ на членство в списке пространства.
Поля | |
---|---|
memberships[] | Неупомянутый список. Список членов на запрошенной (или первой) странице. |
next_page_token | Токен, который вы можете отправить в качестве |
ListMessagesRequest
Перечисляет сообщения в указанном пространстве, что пользователь является членом.
Поля | |
---|---|
parent | Необходимый. Имя ресурса пространства для перечисления сообщений. Формат: |
page_size | Максимальное количество сообщений возвращалось. Служба может вернуть меньше сообщений, чем это значение. Если не указано, не более 25 возвращаются. Максимальное значение составляет 1000. Если вы используете значение более 1000, оно автоматически изменяется на 1000. Отрицательные значения возвращают ошибку |
page_token | Необязательно, если возобновить из предыдущего запроса. Токен страницы, полученный из предыдущего вызова сообщений списка. Предоставьте этот параметр, чтобы получить последующую страницу. При нанесении на страницу все другие предоставленные параметры должны соответствовать вызову, который предоставил токен страницы. Передача различных значений к другим параметрам может привести к неожиданным результатам. |
filter | Фильтр запросов. Вы можете отфильтровать сообщения по дате ( Чтобы отфильтровать сообщения до даты, которую они были созданы, укажите The Чтобы отфильтровать по потоку, укажите Чтобы фильтровать по потоке и дате, используйте Например, следующие запросы действительны:
Неверные запросы отклоняются сервером с ошибкой |
order_by | Необязательно, если возобновить из предыдущего запроса. Как упорядочен список сообщений. Укажите значение по заказу с помощью операции заказа. Допустимые значения операции заказа следующие:
Порядок по умолчанию - |
show_deleted | Должны ли включать удаленные сообщения. Удаленные сообщения включают удаленное время и метаданные об их удалении, но содержание сообщений недоступно. |
ListMessagesResponse
Ответ Сообщение для перечисления сообщений.
Поля | |
---|---|
messages[] | Список сообщений. |
next_page_token | Вы можете отправить токен в качестве |
ListreactionSrequest
Перечисляет реакцию на сообщение.
Поля | |
---|---|
parent | Необходимый. Пользователи сообщений отреагировали на. Формат: |
page_size | Необязательный. Максимальное количество реакций возвращается. Служба может вернуть меньше реакций, чем это значение. В случае неопределенности значение по умолчанию составляет 25. Максимальное значение составляет 200; Значения выше 200 изменяются на 200. |
page_token | Необязательный. (Если возобновить из предыдущего запроса.) Токен страницы, полученный из предыдущего вызова реакций списка. Предоставьте это, чтобы получить следующую страницу. При разбиении на страницы значение фильтра должно соответствовать вызову, который предоставил токен страницы. Передача другого значения может привести к неожиданным результатам. |
filter | Необязательный. Фильтр запросов. Вы можете отфильтровать реакции с помощью Emoji (либо Чтобы отфильтровать реакции для нескольких смайликов или пользователей, присоединяйтесь к аналогичным полям с оператором Чтобы отфильтровать реакции с помощью Emoji и пользователя, используйте Если ваш запрос использует Например, следующие запросы действительны:
Следующие запросы недействительны:
Неверные запросы отклоняются сервером с ошибкой |
ListreactionSresponse
Ответ на запрос на реакцию списка.
Поля | |
---|---|
reactions[] | Список реакций на запрошенной (или первой) странице. |
next_page_token | Продолжение токена, чтобы получить следующую страницу результатов. Это пусто для последней страницы результатов. |
Listspaceeventsrequest
Запросить сообщение о перечислении космических событий.
Поля | |
---|---|
parent | Необходимый. Название ресурса в чате Google , где произошли события. Формат: |
page_size | Необязательный. Максимальное количество космических событий возвращалось. Служба может вернуть меньше этого значения. Отрицательные значения возвращают ошибку |
page_token | Токен страницы, полученный из предыдущего звонка космических событий списка. Предоставьте это, чтобы получить следующую страницу. При нанесении на страницу все остальные параметры, предоставленные для перечисления пространственных событий, должны соответствовать вызову, который предоставил токен страницы. Передача различных значений к другим параметрам может привести к неожиданным результатам. |
filter | Необходимый. Фильтр запросов. Вы должны указать хотя бы один тип события ( При желании вы также можете отфильтровать по времени начала (
Чтобы указать время начала или окончания, используйте оператор Equals Например, следующие запросы действительны:
Следующие запросы недействительны:
Неверные запросы отклоняются сервером с ошибкой |
ListSpaceEventsResponse
Ответ Сообщение для перечисления космических событий.
Поля | |
---|---|
space_events[] | Результаты возвращаются в хронологическом порядке (сначала самое старое событие). |
next_page_token | Токен продолжения, используемый для получения большего количества событий. Если это поле опущено, последующие страницы отсутствуют. |
ListspacesRequest
Запрос на перечисление пространств, которым является абонент.
Поля | |
---|---|
page_size | Необязательный. Максимальное количество пробелов для возврата. Служба может вернуть меньше этого значения. Если не указано, возвращается не более 100 пробелов. Максимальное значение составляет 1000. Если вы используете значение более 1000, оно автоматически изменяется на 1000. Отрицательные значения возвращают ошибку |
page_token | Необязательный. Токен страницы, полученный из предыдущего звонка в списках. Предоставьте этот параметр, чтобы получить последующую страницу. При разбиении на страницы значение фильтра должно соответствовать вызову, который предоставил токен страницы. Прохождение другого значения может привести к неожиданным результатам. |
filter | Необязательный. Фильтр запросов. Вы можете отфильтровать пространства по типу пространства ( Чтобы отфильтровать по типу пространства, вы должны указать допустимое значение Enum, такое как Например, следующие запросы действительны:
Неверные запросы отклоняются сервером с ошибкой |
Listspacesresponse
Ответ на запрос списков.
Поля | |
---|---|
spaces[] | Список пробелов на запрошенной (или первой) странице. |
next_page_token | Вы можете отправить токен в качестве |
Matchedurl
Соответствующий URL в сообщении в чате. Приложения чата могут предварительно просмотреть соответствующие URL -адреса. Дополнительную информацию см. в разделе Ссылки для предварительного просмотра .
Поля | |
---|---|
url | Только вывод. URL, который был сопоставлен. |
Членство
Представляет собой отношение членства в чате Google, например, приглашается ли пользователь или приложение чата, часть или отсутствует в пространстве.
Поля | |
---|---|
name | Имя ресурса членства, назначенное сервером. Формат: |
state | Только вывод. Состояние членства. |
role | Необязательный. Роль пользователя в пространстве чата, которая определяет их разрешенные действия в пространстве. Это поле можно использовать только в качестве ввода в |
create_time | Необязательный. Неизменен. Время создания членства, например, когда член присоединился или был приглашен присоединиться к пространству. Это поле выводится только, за исключением случаев, когда используется для импорта исторического членства в местах импорта. |
delete_time | Необязательный. Неизменен. Время удаления членства, например, когда член ушел или был удален из пространства. Это поле выводится только, за исключением случаев, когда используется для импорта исторического членства в местах импорта. |
Union Field memberType . Участник связан с этим членством. Другие типы участников могут быть поддержаны в будущем. memberType может быть только одним из следующих: | |
member | Пользователь или приложение Google Chat, которому соответствует членство. Если ваше приложение в чате аутентифицируется как пользователь , вывод популяет |
group_member | Группа Google членство соответствует. |
Членство
Представляет разрешенные действия пользователя в пространстве чата. Больше значений Enum может быть добавлено в будущем.
Перечисления | |
---|---|
MEMBERSHIP_ROLE_UNSPECIFIED | Значение по умолчанию. Для users : они не являются членом пространства, но могут быть приглашены. Для Google Groups : им всегда присваивается эта роль (другие значения перечисления могут использоваться в будущем). |
ROLE_MEMBER | Член пространства. У пользователя есть основные разрешения, такие как отправка сообщений в пространство. В 1: 1 и безымянных групповых разговорах у каждого есть эта роль. |
ROLE_MANAGER | Космический менеджер. У пользователя есть все основные разрешения плюс административные разрешения, которые позволяют им управлять пространством, например, добавление или удаление участников. Поддерживается только в SpaceType.SPACE . |
Членство
Определяет отношения участника с пространством. Другие государства членства могут быть поддержаны в будущем.
Перечисления | |
---|---|
MEMBERSHIP_STATE_UNSPECIFIED | Значение по умолчанию. Не используйте. |
JOINED | Пользователь добавляется в пространство и может участвовать в пространстве. |
INVITED | Пользователь предлагается присоединиться к пространству, но не присоединился к нему. |
NOT_A_MEMBER | Пользователь не принадлежит к пространству и не имеет ожидающего приглашения присоединиться к пространству. |
Членство BATCHCREATEDEVENTDATA
Полезная нагрузка на событие для нескольких новых членов.
Тип события: google.workspace.chat.membership.v1.batchCreated
Поля | |
---|---|
memberships[] | Список новых членов. |
Членство BatchdeleteDeventData
Полезная нагрузка на событие для нескольких удаленных членов.
Тип события: google.workspace.chat.membership.v1.batchDeleted
Поля | |
---|---|
memberships[] | Список удаленных членов. |
Членство BBATCHUPDATEDEVENTDATA
Полезная нагрузка на событие для нескольких обновленных членов.
Тип события: google.workspace.chat.membership.v1.batchUpdated
Поля | |
---|---|
memberships[] | Список обновленных членов. |
Членство CREATEDEVENTDATA
Полезная нагрузка на событие для нового членства.
Тип события: google.workspace.chat.membership.v1.created
.
Поля | |
---|---|
membership | Новое членство. |
Членатделевендата
Полезная нагрузка на мероприятие для удаленного членства.
Тип события: google.workspace.chat.membership.v1.deleted
Поля | |
---|---|
membership | Удаленное членство. Только |
Член и поступил
Полезная нагрузка на событие для обновленного членства.
Тип события: google.workspace.chat.membership.v1.updated
Поля | |
---|---|
membership | Обновленное членство. |
Сообщение
Сообщение в пространстве чата Google.
Поля | |
---|---|
name | Имя ресурса сообщения. Формат: Где Если вы установите пользовательский идентификатор при создании сообщения, вы можете использовать этот идентификатор для указания сообщения в запросе, заменив |
sender | Только вывод. Пользователь, который создал сообщение. Если ваше приложение в чате аутентифицируется как пользователь , вывод популяет |
create_time | Необязательный. Неизменен. Для пробелов, созданных в чате, время, в которое было создано сообщение. Это поле только вывод, за исключением случаев, когда используется в пространствах режима импорта. Для мест импорта, установите это поле на историческую метку времени, на которой было создано сообщение в источнике, чтобы сохранить исходное время создания. |
last_update_time | Только вывод. Время, в которое сообщение было в последний раз отредактировано пользователем. Если сообщение никогда не было отредактировано, это поле пустое. |
delete_time | Только вывод. Время, в которое сообщение было удалено в чате Google. Если сообщение никогда не удалено, это поле пустое. |
text | Простые текстовые тела сообщения. Первая ссылка на изображение, видео или веб -страницу генерирует чип предварительного просмотра . Вы также можете принять пользователя Google Chat или всех в пространстве. Чтобы узнать о создании текстовых сообщений, см. Отправить сообщение . |
formatted_text | Только вывод. Содержит
Для получения дополнительной информации см. Просмотр форматирования текста, отправленного в сообщении |
cards[] | Устроенный: используйте Богатые, отформатированные и интерактивные карты, которые вы можете использовать для отображения элементов пользовательского интерфейса, таких как: форматированные тексты, кнопки и кликабельные изображения. Карты обычно отображаются ниже простого тела сообщения. |
cards_v2[] | Множество карт . Только приложения чата могут создавать карты. Если ваше приложение в чате аутентифицируется как пользователь , сообщения не могут содержать карты. Чтобы узнать, как создать сообщение, которое содержит карты, см. Отправить сообщение . Проектируйте и предварительно просмотрите карты с помощью каркового строителя. Откройте конструктор карточек |
annotations[] | Только вывод. Аннотации, связанные с |
thread | Поток, к которому принадлежит сообщение. Например, используйте, см. Запуск или ответьте на поток сообщения . |
space | Если ваше приложение в чате аутентифицируется как пользователь , вывод населяет |
fallback_text | Простой текстовое описание карт сообщения, используемое, когда фактические карты не могут быть отображены, например, мобильные уведомления. |
action_response | Только ввод. Параметры, которые приложение чата может использовать для настройки того, как публикуется его ответ. |
argument_text | Только вывод. Простые текстовые тела сообщения со всеми приложениями для чата разбросаны. |
slash_command | Только вывод. Информация о команде SLASH, если применимо. |
attachment[] | Пользовательская загруженная вложение. |
matched_url | Только вывод. URL в |
thread_reply | Только вывод. Когда Если пространство не поддерживает ответ в потоках, это поле всегда |
client_assigned_message_id | Необязательный. Пользовательский идентификатор для сообщения. Вы можете использовать поле для определения сообщения или для получения, удаления или обновления сообщения. Чтобы установить пользовательский идентификатор, укажите поле |
emoji_reaction_summaries[] | Только вывод. Список резюме реакции эмодзи на сообщении. |
private_message_viewer | Неизменен. Ввод для создания сообщения, в противном случае только вывод. Пользователь, который может просматривать сообщение. При установке сообщение является приватным и видимым только для указанного пользователя и приложения чата. Предварительные просмотра ссылок и вложения не поддерживаются для частных сообщений. Только приложения чата могут отправлять личные сообщения. Если ваше приложение для чата является аутентификацией как пользователь для отправки сообщения, сообщение не может быть частным и должно опустить это поле. Для получения подробной информации см. Отправить сообщение в частном порядке . |
deletion_metadata | Только вывод. Информация о удаленном сообщении. Сообщение удаляется при установке |
quoted_message_metadata | Только вывод. Информация о сообщении, которое цитируется пользователем Google Chat в пространстве. Пользователи Google Chat могут процитировать сообщение, чтобы ответить на него. |
attached_gifs[] | Только вывод. GIF -изображения, которые прикреплены к сообщению. |
accessory_widgets[] | Один или несколько интерактивных виджетов, которые появляются в нижней части сообщения. Вы можете добавить вспомогательные виджеты в сообщения, которые содержат текст, карты или текст и карты. Не поддерживается для сообщений, которые содержат диалоги. Для получения подробной информации см. Добавьте интерактивные виджеты внизу сообщения . Создание сообщения с помощью аксессуаров требует аутентификации приложений . |
MessageBatchCreatedEventData
Полезная нагрузка на событие для нескольких новых сообщений.
Тип события: google.workspace.chat.message.v1.batchCreated
Поля | |
---|---|
messages[] | Список новых сообщений. |
MessageBatchDeleteDeventData
Полезная нагрузка на несколько удаленных сообщений.
Тип события: google.workspace.chat.message.v1.batchDeleted
Поля | |
---|---|
messages[] | Список удаленных сообщений. |
MessageBatchUpdatedEventData
Полезная нагрузка на событие для нескольких обновленных сообщений.
Тип события: google.workspace.chat.message.v1.batchUpdated
Поля | |
---|---|
messages[] | Список обновленных сообщений. |
MessageCreatedEventdata
Полезная нагрузка на событие для нового сообщения.
Тип события: google.workspace.chat.message.v1.created
Поля | |
---|---|
message | Новое сообщение. |
MessageDetedEventData
Полезная нагрузка на событие для удаленного сообщения.
Тип события: google.workspace.chat.message.v1.deleted
Поля | |
---|---|
message | Удаленное сообщение. Только поля |
MessageUpdatedEventData
Полезная нагрузка на событие для обновленного сообщения.
Тип события: google.workspace.chat.message.v1.updated
Поля | |
---|---|
message | Обновленное сообщение. |
Quytedmessagemetadata
Информация о цитируемом сообщении.
Поля | |
---|---|
name | Только вывод. Имя ресурса цитируемого сообщения. Формат: |
last_update_time | Только вывод. Неэппаратная метка, когда цитируемое сообщение было создано или когда цитируемое сообщение была в последний раз обновлена. |
Реакция
Реакция на сообщение.
Поля | |
---|---|
name | Название ресурса реакции. Формат: |
user | Только вывод. Пользователь, который создал реакцию. |
emoji | Эмодзи, используемые в реакции. |
Реакция BatchCreatedEventData
Полезная нагрузка на несколько новых реакций.
Тип события: google.workspace.chat.reaction.v1.batchCreated
Поля | |
---|---|
reactions[] | Список новых реакций. |
Реакция BatchDeleteDeventData
Полезная нагрузка на несколько удаленных реакций.
Тип события: google.workspace.chat.reaction.v1.batchDeleted
Поля | |
---|---|
reactions[] | Список удаленных реакций. |
Реакция CREATEDEVENTDATA
Полезная нагрузка на событие для новой реакции.
Тип события: google.workspace.chat.reaction.v1.created
Поля | |
---|---|
reaction | Новая реакция. |
Реакция DELETEDEVENTDATA
Полезная нагрузка на удаленную реакцию.
Тип: google.workspace.chat.reaction.v1.deleted
Поля | |
---|---|
reaction | Удаленная реакция. |
Richlinkmetadata
Богатая ссылка на ресурс.
Поля | |
---|---|
uri | URI этой ссылки. |
rich_link_type | Богатый тип ссылки. |
Объединенные полевые data . Данные для связанного ресурса. data могут быть только одним из следующих: | |
drive_link_data | Данные для приводной ссылки. |
chat_space_link_data | Данные для пробела в чате. |
Richlinktype
Богатый тип ссылки. В будущем может быть добавлено больше типов.
Перечисления | |
---|---|
RICH_LINK_TYPE_UNSPECIFIED | Значение по умолчанию для перечисления. Не используйте. |
DRIVE_FILE | Гугл диск, богатый тип ссылки. |
CHAT_SPACE | Тип ссылки на просмотр чата. Например, Space Smart Chip. |
SearchspacesRequest
Запрос на поиск списка мест на основе запроса.
Поля | |
---|---|
use_admin_access | Когда Пользователь по вызову должен быть администратором Google Workspace с привилегией Manage CHAT и Spaces Trantings . Требует либо Этот метод в настоящее время поддерживает только доступ администратора, поэтому для этого поля принимается только |
page_size | Максимальное количество пробелов для возврата. Служба может возвращать меньшее значение, чем это значение. Если не указано, возвращается не более 100 пробелов. Максимальное значение составляет 1000. Если вы используете значение более 1000, оно автоматически изменяется на 1000. |
page_token | Токен, полученный от предыдущего вызова поискового пространства. Предоставьте этот параметр, чтобы получить последующую страницу. При нанесении на страницу все другие предоставленные параметры должны соответствовать вызову, который предоставил токен страницы. Передача различных значений к другим параметрам может привести к неожиданным результатам. |
query | Необходимый. Поисковый запрос. Вы можете искать, используя следующие параметры:
В разных областях поддерживаются только Среди той же поля Следующий пример запросов действительны:
|
order_by | Необязательный. Как упорядочен список пространств. Поддерживаемые атрибуты по заказу
Допустимые значения операции на заказ:
Поддерживаемый синтаксис:
|
SearchSpacesResponse
Ответ со списком пробелов, соответствующих запросу поискового пространства.
Поля | |
---|---|
spaces[] | Страница запрошенных пространств. |
next_page_token | Токен, который можно использовать для получения следующей страницы. Если это поле пустое, нет последующих страниц. |
total_size | Общее количество пробелов, которые соответствуют запросу на всех страницах. Если результат составляет более 10000 мест, это значение является оценкой. |
SetupSpacerequest
Запрос на создание места и добавить к нему указанных пользователей.
Поля | |
---|---|
space | Необходимый. Требуется поле Чтобы создать пространство, установите Чтобы создать групповой чат, установите Чтобы создать разговор между людьми 1: 1, установите пространство Чтобы создать разговор 1: 1 между человеком и приложением для призывного чата, установите Если пространство |
request_id | Необязательный. Уникальный идентификатор для этого запроса. Рекомендуется случайный UUID. Указание существующего идентификатора запроса возвращает пространство, созданное с помощью этого идентификатора вместо создания нового пространства. Указание существующего идентификатора запроса из одного и того же приложения чата с другим аутентифицированным пользователем возвращает ошибку. |
memberships[] | Необязательный. Пользователи или группы Google Chat приглашают присоединиться к пространству. Опустите зовущего пользователя, так как он добавляется автоматически. Набор в настоящее время допускает до 20 членов (в дополнение к вызывающему абоненту). Для человеческого членства в поле Для членства в группе Google в поле Необязательно при установке Требуется при установке Требуется при установке Должен быть пустым при создании разговора 1: 1 между человеком и приложением призывного чата (при установке |
Слэшкомманд
Команда Slash в чате Google.
Поля | |
---|---|
command_id | Идентификатор команды SLASH призван. |
Slashcommammametadata
Метаданные аннотации для команд SLASH (/).
Поля | |
---|---|
bot | Приложение чата, чья команда была вызвана. |
type | Тип команды SLASH. |
command_name | Имя вызываемой команды Slash. |
command_id | Идентификатор команды вызываемой команды SLASH. |
triggers_dialog | Указывает, является ли команда SLASH для диалога. |
Тип
Перечисления | |
---|---|
TYPE_UNSPECIFIED | Значение по умолчанию для перечисления. Не используйте. |
ADD | Добавьте приложение чата в космос. |
INVOKE | Вызок команды Slash в космосе. |
Космос
Пространство в чате Google. Пространства - это разговоры между двумя или более пользователями или сообщением 1: 1 между пользователем и приложением чата.
Поля | |
---|---|
name | Название ресурса пространства. Формат: Где |
type | Только вывод. Установите: используйте |
space_type | Тип пространства. Требуется при создании места или обновлении пространства пространства. Вывод только для другого использования. |
single_user_bot_dm | Необязательный. Является ли пространство DM между приложением для чата и одним человеком. |
threaded | Только вывод. Установите: используйте |
display_name | Имя отображения пространства. Требуется при создании места . Если вы получаете сообщение об ошибке Для прямых сообщений это поле может быть пустым. Поддерживает до 128 символов. |
external_user_allowed | Неизменен. Позволяет ли это пространство любому пользователю Google Chat в качестве участника. Ввод при создании места в организации Google Workspace. Опустите это поле при создании пространств в следующих условиях:
Для существующих пространств это поле только вывод. |
space_threading_state | Только вывод. Состояние резьбы в пространстве чата. |
space_details | Подробная информация о пространстве, включая описание и правила. |
space_history_state | История сообщений утверждает сообщения и потоки в этом пространстве. |
import_mode | Необязательный. Создается ли это пространство в |
create_time | Необязательный. Неизменен. Для пространств, созданных в чате, время было создано пространство. Это поле только вывод, за исключением случаев, когда используется в пространствах режима импорта. Для пробелов в режиме импорта установите это поле на историческую метку времени, в которой пространство было создано в источнике, чтобы сохранить исходное время создания. Заполнен выходом только при |
last_active_time | Только вывод. Временная метка последнего сообщения в пространстве. |
admin_installed | Только вывод. Для прямых сообщений (DM) с приложением чата, независимо от того, было ли пространство создано администратором Google Workspace. Администраторы могут установить и настроить прямое сообщение с приложением чата от имени пользователей в их организации. Чтобы поддержать установку администратора, ваше приложение для чата должно иметь прямые сообщения. |
membership_count | Только вывод. Подсчет объединенных членов, сгруппированный типом участника. Заполнено, когда |
access_settings | Необязательный. Указывает настройку доступа пространства. Заполнено только тогда, когда |
space_uri | Только вывод. URI для пользователя, чтобы получить доступ к пространству. |
Объединение поля space_permission_settings . Представляет настройки разрешения пространства. Заполнено только тогда, когда space_type - это SPACE . space_permission_settings может быть только одним из следующих: | |
predefined_permission_settings | Необязательный. Только ввод. Настройки разрешения пространства. Ввод для создания пространства, пространство для сотрудничества создается, если это поле не установлено. После создания пространства настройки заполняются в поле |
permission_settings | Необязательный. Точные настройки разрешения, которые можно настроить для обновления пространства. Ввод для обновления места. В противном случае только вывод. Для создания пространства используйте вместо этого |
Доступ
Представляет настройку доступа пространства.
Поля | |
---|---|
access_state | Только вывод. Указывает состояние доступа пространства. |
audience | Необязательный. Название ресурса целевой аудитории , которая может обнаружить пространство, присоединиться к пространству и предварительно просмотреть сообщения в пространстве. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see Make a space discoverable to a target audience . Format: To use the default target audience for the Google Workspace organization, set to |
AccessState
Represents the access state of the space.
Перечисления | |
---|---|
ACCESS_STATE_UNSPECIFIED | Access state is unknown or not supported in this API. |
PRIVATE | Only users or Google Groups that have been individually added or invited by other users or Google Workspace administrators can discover and access the space. |
DISCOVERABLE | A space manager has granted a target audience access to the space. Users or Google Groups that have been individually added or invited to the space can also discover and access the space. To learn more, see Make a space discoverable to specific users . |
MembershipCount
Represents the count of memberships of a space, grouped into categories.
Поля | |
---|---|
joined_direct_human_user_count | Count of human users that have directly joined the space, not counting users joined by having membership in a joined group. |
joined_group_count | Count of all groups that have directly joined the space. |
PermissionSetting
Represents a space permission setting.
Поля | |
---|---|
managers_allowed | Whether spaces managers have this permission. |
members_allowed | Whether non-manager members have this permission. |
PermissionSettings
Permission settings for a named space. To set permission settings when creating a space, specify the PredefinedPermissionSettings
field in your request.
Поля | |
---|---|
manage_members_and_groups | Setting for managing members and groups in a space. |
modify_space_details | Setting for updating space name, avatar, description and guidelines. |
toggle_history | Setting for toggling space history on and off. |
use_at_mention_all | Setting for using @all in a space. |
manage_apps | Setting for managing apps in a space. |
manage_webhooks | Setting for managing webhooks in a space. |
post_messages | Только вывод. Setting for posting messages in a space. |
reply_messages | Setting for replying to messages in a space. |
PredefinedPermissionSettings
The space permission settings that you can specify when creating a named space. More settings might be added in the future. For details about permission settings for named spaces, see Learn about spaces .
Перечисления | |
---|---|
PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED | Не указано. Don't use. |
COLLABORATION_SPACE | Setting to make the space a collaboration space where all members can post messages. |
ANNOUNCEMENT_SPACE | Setting to make the space an announcement space where only space managers can post messages. |
SpaceDetails
Details about the space including description and rules.
Поля | |
---|---|
description | Необязательный. A description of the space. For example, describe the space's discussion topic, functional purpose, or participants. Supports up to 150 characters. |
guidelines | Необязательный. The space's rules, expectations, and etiquette. Supports up to 5,000 characters. |
SpaceThreadingState
Specifies the type of threading state in the Chat space.
Перечисления | |
---|---|
SPACE_THREADING_STATE_UNSPECIFIED | Сдержанный. |
THREADED_MESSAGES | Named spaces that support message threads. When users respond to a message, they can reply in-thread, which keeps their response in the context of the original message. |
GROUPED_MESSAGES | Named spaces where the conversation is organized by topic. Topics and their replies are grouped together. |
UNTHREADED_MESSAGES | Direct messages (DMs) between two people and group conversations between 3 or more people. |
SpaceType
The type of space. Required when creating or updating a space. Output only for other usage.
Перечисления | |
---|---|
SPACE_TYPE_UNSPECIFIED | Сдержанный. |
SPACE | A place where people send messages, share files, and collaborate. A SPACE can include Chat apps. |
GROUP_CHAT | Group conversations between 3 or more people. A GROUP_CHAT can include Chat apps. |
DIRECT_MESSAGE | 1:1 messages between two humans or a human and a Chat app. |
Тип
Deprecated: Use SpaceType
instead.
Перечисления | |
---|---|
TYPE_UNSPECIFIED | Сдержанный. |
ROOM | Conversations between two or more humans. |
DM | 1:1 Direct Message between a human and a Chat app, where all messages are flat. Note that this doesn't include direct messages between two humans. |
SpaceBatchUpdatedEventData
Event payload for multiple updates to a space.
Event type: google.workspace.chat.space.v1.batchUpdated
Поля | |
---|---|
spaces[] | A list of updated spaces. |
SpaceEvent
An event that represents a change or activity in a Google Chat space. To learn more, see Work with events from Google Chat .
Поля | |
---|---|
name | Resource name of the space event. Format: |
event_time | Time when the event occurred. |
event_type | Type of space event. Each event type has a batch version, which represents multiple instances of the event type that occur in a short period of time. For Supported event types for messages :
Supported event types for memberships :
Supported event types for reactions :
Supported event types about the space :
|
Union field | |
message_created_event_data | Event payload for a new message. Event type: |
message_updated_event_data | Event payload for an updated message. Event type: |
message_deleted_event_data | Event payload for a deleted message. Event type: |
message_batch_created_event_data | Event payload for multiple new messages. Event type: |
message_batch_updated_event_data | Event payload for multiple updated messages. Event type: |
message_batch_deleted_event_data | Event payload for multiple deleted messages. Event type: |
space_updated_event_data | Event payload for a space update. Event type: |
space_batch_updated_event_data | Event payload for multiple updates to a space. Event type: |
membership_created_event_data | Event payload for a new membership. Event type: |
membership_updated_event_data | Event payload for an updated membership. Event type: |
membership_deleted_event_data | Event payload for a deleted membership. Event type: |
membership_batch_created_event_data | Event payload for multiple new memberships. Event type: |
membership_batch_updated_event_data | Event payload for multiple updated memberships. Event type: |
membership_batch_deleted_event_data | Event payload for multiple deleted memberships. Event type: |
reaction_created_event_data | Event payload for a new reaction. Event type: |
reaction_deleted_event_data | Event payload for a deleted reaction. Event type: |
reaction_batch_created_event_data | Event payload for multiple new reactions. Event type: |
reaction_batch_deleted_event_data | Event payload for multiple deleted reactions. Event type: |
SpaceReadState
A user's read state within a space, used to identify read and unread messages.
Поля | |
---|---|
name | Resource name of the space read state. Format: |
last_read_time | Необязательный. The time when the user's space read state was updated. Обычно это соответствует либо временной метке последнего прочитанного сообщения, либо временной метке, указанной пользователем для обозначения последней прочитанной позиции в пробеле. |
SpaceUpdatedEventData
Event payload for an updated space.
Event type: google.workspace.chat.space.v1.updated
Поля | |
---|---|
space | The updated space. |
Нить
A thread in a Google Chat space. For example usage, see Start or reply to a message thread .
If you specify a thread when creating a message, you can set the messageReplyOption
field to determine what happens if no matching thread is found.
Поля | |
---|---|
name | Resource name of the thread. Example: |
thread_key | Необязательный. Input for creating or updating a thread. Otherwise, output only. ID for the thread. Supports up to 4000 characters. This ID is unique to the Chat app that sets it. For example, if multiple Chat apps create a message using the same thread key, the messages are posted in different threads. To reply in a thread created by a person or another Chat app, specify the thread |
ThreadReadState
A user's read state within a thread, used to identify read and unread messages.
Поля | |
---|---|
name | Resource name of the thread read state. Format: |
last_read_time | The time when the user's thread read state was updated. Usually this corresponds with the timestamp of the last read message in a thread. |
UpdateMembershipRequest
Request message for updating a membership.
Поля | |
---|---|
membership | Необходимый. The membership to update. Only fields specified by |
update_mask | Необходимый. The field paths to update. Separate multiple values with commas or use Currently supported field paths:
|
use_admin_access | When The calling user must be a Google Workspace administrator with the manage chat and spaces conversations privilege . Requires the |
UpdateMessageRequest
Request to update a message.
Поля | |
---|---|
message | Необходимый. Message with fields updated. |
update_mask | Необходимый. The field paths to update. Separate multiple values with commas or use Currently supported field paths:
|
allow_missing | Необязательный. If |
UpdateSpaceReadStateRequest
Request message for UpdateSpaceReadState API.
Поля | |
---|---|
space_read_state | Необходимый. The space read state and fields to update. Only supports updating read state for the calling user. To refer to the calling user, set one of the following:
Format: users/{user}/spaces/{space}/spaceReadState |
update_mask | Необходимый. The field paths to update. Currently supported field paths:
When the To mark the space as read, set |
UpdateSpaceRequest
A request to update a single space.
Поля | |
---|---|
space | Необходимый. Space with fields to be updated. |
update_mask | Необходимый. The updated field paths, comma separated if there are multiple. You can update the following fields for a space:
|
use_admin_access | When The calling user must be a Google Workspace administrator with the manage chat and spaces conversations privilege . Requires the Some |
Пользователь
A user in Google Chat. When returned as an output from a request, if your Chat app authenticates as a user , the output for a User
resource only populates the user's name
and type
.
Поля | |
---|---|
name | Resource name for a Google Chat Format: For
|
display_name | Только вывод. The user's display name. |
domain_id | Unique identifier of the user's Google Workspace domain. |
type | User type. |
is_anonymous | Только вывод. When |
Тип
Перечисления | |
---|---|
TYPE_UNSPECIFIED | Default value for the enum. НЕ ИСПОЛЬЗУЙТЕ. |
HUMAN | Human user. |
BOT | Chat app user. |
UserMentionMetadata
Annotation metadata for user mentions (@).
Поля | |
---|---|
user | The user mentioned. |
type | The type of user mention. |
Тип
Перечисления | |
---|---|
TYPE_UNSPECIFIED | Default value for the enum. Don't use. |
ADD | Add user to space. |
MENTION | Mention user in space. |
WidgetMarkup
A widget is a UI element that presents text and images.
Поля | |
---|---|
buttons[] | A list of buttons. Buttons is also |
Union field data . A WidgetMarkup can only have one of the following items. You can use multiple WidgetMarkup fields to display more items. data can be only one of the following: | |
text_paragraph | Display a text paragraph in this widget. |
image | Display an image in this widget. |
key_value | Display a key value item in this widget. |
Кнопка
A button. Can be a text button or an image button.
Поля | |
---|---|
| |
text_button | A button with text and |
image_button | A button with image and |
FormAction
A form action describes the behavior when the form is submitted. For example, you can invoke Apps Script to handle the form.
Поля | |
---|---|
action_method_name | The method name is used to identify which part of the form triggered the form submission. This information is echoed back to the Chat app as part of the card click event. You can use the same method name for several elements that trigger a common behavior. |
parameters[] | List of action parameters. |
ActionParameter
List of string parameters to supply when the action method is invoked. For example, consider three snooze buttons: snooze now, snooze one day, snooze next week. You might use action method = snooze()
, passing the snooze type and snooze time in the list of string parameters.
Поля | |
---|---|
key | The name of the parameter for the action script. |
value | The value of the parameter. |
Икона
The set of supported icons.
Перечисления | |
---|---|
ICON_UNSPECIFIED | |
AIRPLANE | |
BOOKMARK | |
BUS | |
CAR | |
CLOCK | |
CONFIRMATION_NUMBER_ICON | |
DOLLAR | |
DESCRIPTION | |
EMAIL | |
EVENT_PERFORMER | |
EVENT_SEAT | |
FLIGHT_ARRIVAL | |
FLIGHT_DEPARTURE | |
HOTEL | |
HOTEL_ROOM_TYPE | |
INVITE | |
MAP_PIN | |
MEMBERSHIP | |
MULTIPLE_PEOPLE | |
OFFER | |
PERSON | |
PHONE | |
RESTAURANT_ICON | |
SHOPPING_CART | |
STAR | |
STORE | |
TICKET | |
TRAIN | |
VIDEO_CAMERA | |
VIDEO_PLAY |
Изображение
An image that's specified by a URL and can have an onclick
action.
Поля | |
---|---|
image_url | The URL of the image. |
on_click | The |
aspect_ratio | The aspect ratio of this image (width and height). This field lets you reserve the right height for the image while waiting for it to load. It's not meant to override the built-in aspect ratio of the image. If unset, the server fills it by prefetching the image. |
ImageButton
An image button with an onclick
action.
Поля | |
---|---|
on_click | The |
name | The name of this |
Union field icons . The icon can be specified by an Icon enum or a URL. icons can be only one of the following: | |
icon | The icon specified by an |
icon_url | The icon specified by a URL. |
KeyValue
A UI element contains a key (label) and a value (content). This element can also contain some actions such as onclick
button.
Поля | |
---|---|
top_label | The text of the top label. Formatted text supported. For more information about formatting text, see Formatting text in Google Chat apps and Formatting text in Google Workspace Add-ons . |
content | The text of the content. Formatted text supported and always required. For more information about formatting text, see Formatting text in Google Chat apps and Formatting text in Google Workspace Add-ons . |
content_multiline | If the content should be multiline. |
bottom_label | The text of the bottom label. Formatted text supported. For more information about formatting text, see Formatting text in Google Chat apps and Formatting text in Google Workspace Add-ons . |
on_click | The |
Union field icons . At least one of icons, top_label and bottom_label must be defined. icons can be only one of the following: | |
icon | An enum value that's replaced by the Chat API with the corresponding icon image. |
icon_url | The icon specified by a URL. |
Union field control . A control widget. You can set either button or switch_widget , but not both. control can be only one of the following: | |
button | A button that can be clicked to trigger an action. |
OnClick
An onclick
action (for example, open a link).
Поля | |
---|---|
Union field | |
action | A form action is triggered by this |
open_link | This |
OpenLink
A link that opens a new window.
Поля | |
---|---|
url | The URL to open. |
TextButton
A button with text and onclick
action.
Fields | |
---|---|
text | The text of the button. |
on_click | The |
TextParagraph
A paragraph of text. Formatted text supported. For more information about formatting text, see Formatting text in Google Chat apps and Formatting text in Google Workspace Add-ons .
Поля | |
---|---|
text | |