Индекс
-
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
(сообщение) -
CreateCustomEmojiRequest
(сообщение) -
CreateMembershipRequest
(сообщение) -
CreateMessageRequest
(сообщение) -
CreateMessageRequest.MessageReplyOption
(перечисление) -
CreateReactionRequest
(сообщение) -
CreateSpaceRequest
(сообщение) -
CustomEmoji
(сообщение) -
CustomEmoji.CustomEmojiPayload
(сообщение) -
DeleteCustomEmojiRequest
(сообщение) -
DeleteMembershipRequest
(сообщение) -
DeleteMessageRequest
(сообщение) -
DeleteReactionRequest
(сообщение) -
DeleteSpaceRequest
(сообщение) -
DeletionMetadata
(сообщение) -
DeletionMetadata.DeletionType
(перечисление) -
Dialog
(сообщение) -
DialogAction
(сообщение) -
DriveDataRef
(сообщение) -
DriveLinkData
(сообщение) -
Emoji
(сообщение) -
EmojiReactionSummary
(сообщение) -
FindDirectMessageRequest
(сообщение) -
GetAttachmentRequest
(сообщение) -
GetCustomEmojiRequest
(сообщение) -
GetMembershipRequest
(сообщение) -
GetMessageRequest
(сообщение) -
GetSpaceEventRequest
(сообщение) -
GetSpaceNotificationSettingRequest
(сообщение) -
GetSpaceReadStateRequest
(сообщение) -
GetSpaceRequest
(сообщение) -
GetThreadReadStateRequest
(сообщение) -
Group
(сообщение) -
HistoryState
(перечисление) -
ListCustomEmojisRequest
(сообщение) -
ListCustomEmojisResponse
(сообщение) -
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
(сообщение) -
SpaceNotificationSetting
(сообщение) -
SpaceNotificationSetting.MuteSetting
(перечисление) -
SpaceNotificationSetting.NotificationSetting
(перечисление) -
SpaceReadState
(сообщение) -
SpaceUpdatedEventData
(сообщение) -
Thread
(сообщение) -
ThreadReadState
(сообщение) -
UpdateMembershipRequest
(сообщение) -
UpdateMessageRequest
(сообщение) -
UpdateSpaceNotificationSettingRequest
(сообщение) -
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 импортировать данные .
|
СоздатьПользовательскийEmoji |
---|
Создает собственный смайлик. Требует аутентификации пользователя .
|
Создать членство |
---|
Создает членство для вызывающего приложения Chat, пользователя или группы Google. Создание членства для других приложений Chat не поддерживается. Если при создании членства у указанного участника отключена политика автоматического принятия, он будет приглашен и должен принять приглашение в пространство, прежде чем присоединиться. В противном случае при создании членства участник добавляется непосредственно в указанное пространство. Поддерживает следующие типы аутентификации :
Пример использования см.:
|
Создать сообщение |
---|
Создает сообщение в чате Google. Пример см. в разделе «Отправить сообщение» . Метод На следующем изображении показано, как Chat атрибутирует сообщение при использовании аутентификации приложения. Chat отображает приложение Chat в качестве отправителя сообщения. Содержимое сообщения может содержать текст ( На следующем изображении показано, как Chat атрибутирует сообщение при использовании аутентификации пользователя. Chat отображает пользователя как отправителя сообщения и связывает приложение Chat с сообщением, отображая его имя. Содержимое сообщения может содержать только текст ( Максимальный размер сообщения, включая его содержимое, составляет 32 000 байт.
|
Создатьреакцию |
---|
Создает реакцию и добавляет ее в сообщение. Поддерживаются только смайлы Юникода. Пример см. в разделе Добавление реакции на сообщение . Требует аутентификации пользователя .
|
Создать пространство |
---|
Создает пространство. Может использоваться для создания именованного пространства или группового чата в Поддерживает следующие типы аутентификации : При аутентификации в качестве приложения в запросе должно быть установлено поле Членство в пространстве при создании зависит от того, создано ли пространство в
Если при создании пространства вы получаете сообщение об ошибке
|
УдалитьCustomEmoji |
---|
Удаляет собственный эмодзи. Требует аутентификации пользователя .
|
Удалить членство |
---|
Удаляет членство. Пример см. в статье Удаление пользователя или приложения Google Chat из пространства . Поддерживает следующие типы аутентификации :
|
Удалить сообщение |
---|
Удаляет сообщение. Пример см. в разделе Удаление сообщения . Поддерживает следующие типы аутентификации : При использовании аутентификации приложения запросы могут удалять только сообщения, созданные вызывающим приложением чата.
|
Удалитьреакцию |
---|
Удаляет реакцию на сообщение. Поддерживаются только смайлы Юникода. Пример см. в разделе Удаление реакции . Требует аутентификации пользователя .
|
Удалить пространство |
---|
Удаляет именованное пространство. Всегда выполняет каскадное удаление, что означает, что дочерние ресурсы пространства, такие как сообщения, опубликованные в пространстве, и членство в пространстве, также удаляются. Пример см. в разделе Удаление пробела . Поддерживает следующие типы аутентификации :
|
НайтиDirectMessage |
---|
Возвращает существующее прямое сообщение указанному пользователю. Если пространство для прямых сообщений не найдено, возвращается ошибка При проверке подлинности приложения возвращает пространство прямого сообщения между указанным пользователем и вызывающим приложением чата. При аутентификации пользователя возвращает пространство прямого сообщения между указанным пользователем и пользователем, прошедшим проверку подлинности. // Поддерживает следующие типы аутентификации :
|
Получить вложение |
---|
Получает метаданные вложения сообщения. Данные вложения извлекаются с помощью медиа API . Пример см. в разделе Получение метаданных о вложении сообщения . Требуется аутентификация приложения .
|
GetCustomEmoji |
---|
Возвращает сведения о пользовательском эмодзи. Требует аутентификации пользователя .
|
Получить членство |
---|
Возвращает сведения о членстве. Пример см. в разделе Получение сведений о членстве пользователя или приложения Google Chat . Поддерживает следующие типы аутентификации :
|
Получить сообщение |
---|
Возвращает сведения о сообщении. Пример см. в разделе Получение сведений о сообщении . Поддерживает следующие типы аутентификации : Примечание. Может вернуть сообщение от заблокированного участника или пространства.
|
GetSpace |
---|
Возвращает подробную информацию о пространстве. Пример см. в разделе Получение сведений о пространстве . Поддерживает следующие типы аутентификации :
|
GetSpaceEvent |
---|
Возвращает событие из пространства Google Chat. Полезные данные события содержат самую последнюю версию измененного ресурса. Например, если вы запрашиваете событие о новом сообщении, но позже оно было обновлено, сервер возвращает обновленный ресурс Примечание. Поле Требует аутентификации пользователя . Чтобы получить событие, аутентифицированный пользователь должен быть членом пространства. Пример см. в разделе Получение сведений о событии из чата Google .
|
GetSpaceNotificationSetting |
---|
Получает настройки состояния уведомлений о пространстве. Требует аутентификации пользователя .
|
GetSpaceReadState |
---|
Возвращает сведения о состоянии чтения пользователя в пространстве, используемые для идентификации прочитанных и непрочитанных сообщений. Пример см. в разделе Получение сведений о состоянии чтения пространства пользователя . Требует аутентификации пользователя .
|
GetThreadReadState |
---|
Возвращает сведения о состоянии чтения пользователя в потоке, используемые для идентификации прочитанных и непрочитанных сообщений. Пример см. в разделе Получение сведений о состоянии чтения потока пользователя . Требует аутентификации пользователя .
|
СписокПользовательскиеEmojis |
---|
Перечисляет пользовательские смайлы, видимые авторизованному пользователю. Требует аутентификации пользователя .
|
Список членства |
---|
Перечисляет членство в пространстве. Пример см. в разделе Список пользователей и приложений Google Chat в пространстве . В списке участников с аутентификацией приложения перечислены участники в пространствах, к которым у приложения Chat есть доступ, но исключаются членства в приложении Chat, включая собственное. В списке участников с аутентификацией пользователя перечислены членства в пространствах, к которым имеет доступ аутентифицированный пользователь. Поддерживает следующие типы аутентификации :
|
Список сообщений |
---|
Перечисляет сообщения в пространстве, участником которого является вызывающий абонент, включая сообщения от заблокированных участников и пространств. Если вы перечислите сообщения из пространства, в котором нет сообщений, ответом будет пустой объект. При использовании интерфейса REST/HTTP ответ содержит пустой объект JSON Требует аутентификации пользователя .
|
Список реакций |
---|
Перечисляет реакции на сообщение. Пример см. в разделе Список реакций на сообщение . Требует аутентификации пользователя .
|
ListSpaceEvents |
---|
Перечисляет события из пространства Google Chat. Для каждого события полезные данные содержат самую последнюю версию ресурса Chat. Например, если вы перечислите события о новых участниках пространства, сервер вернет ресурсы Требует аутентификации пользователя . Чтобы составить список событий, аутентифицированный пользователь должен быть участником пространства. Пример см. в разделе Список событий из чата Google .
|
Список пространств |
---|
Перечисляет пространства, членом которых является вызывающий абонент. Групповые чаты и личные сообщения не отображаются в списке до тех пор, пока не будет отправлено первое сообщение. Пример см. в разделе Пространства списков . Поддерживает следующие типы аутентификации : Чтобы получить список всех именованных пространств по организациям Google Workspace, используйте вместо этого метод
|
Поиск пространств |
---|
Возвращает список пространств в организации Google Workspace на основе поиска администратора. Требуется аутентификация пользователя с правами администратора . В запросе установите для
|
SetUpSpace |
---|
Создает пространство и добавляет в него указанных пользователей. Вызывающий пользователь автоматически добавляется в пространство и не должен указываться как член в запросе. Пример см. в разделе «Настройка пространства с первоначальными участниками» . Чтобы указать добавляемых участников-людей, добавьте членство с соответствующим Чтобы указать группы Google для добавления, добавьте членство с соответствующим Если для именованного пространства или группового чата вызывающий абонент блокируется или заблокирован некоторыми участниками или не имеет разрешения на добавление некоторых участников, то эти участники не добавляются в созданное пространство. Чтобы создать прямое сообщение (DM) между вызывающим пользователем и другим пользователем-человеком, укажите ровно одно членство, которое будет представлять пользователя-человека. Если один пользователь блокирует другого, запрос не выполняется и DM не создается. Чтобы создать DM между вызывающим пользователем и вызывающим приложением, установите для Если DM уже существует между двумя пользователями, даже если один пользователь блокирует другого во время запроса, тогда возвращается существующая DM. Темы с цепочками ответов не поддерживаются. Если при настройке пространства вы получаете сообщение об ошибке Требует аутентификации пользователя .
|
Обновление членства |
---|
Обновляет членство. Пример см. в разделе Обновление членства пользователя в пространстве . Поддерживает следующие типы аутентификации :
|
Обновление сообщения |
---|
Обновляет сообщение. Существует разница между методами Поддерживает следующие типы аутентификации : При использовании аутентификации приложения запросы могут обновлять только сообщения, созданные вызывающим приложением чата.
|
ОбновлениеПространство |
---|
Обновляет пространство. Пример см. в разделе Обновление пространства . Если вы обновляете поле Поддерживает следующие типы аутентификации :
|
UpdateSpaceNotificationSetting |
---|
Обновляет настройки состояния уведомлений о пространстве. Требует аутентификации пользователя .
|
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[] | Раздел должен содержать хотя бы один виджет. |
CreateCustomEmojiRequest
Просьба создать собственный смайлик.
Поля | |
---|---|
custom_ emoji | Необходимый. Пользовательский смайлик, который нужно создать. |
Создать запрос на членство
Сообщение с запросом на создание членства.
Поля | |
---|---|
parent | Необходимый. Имя ресурса пространства, для которого необходимо создать членство. Формат: пробелы/{пробел} |
membership | Необходимый. Отношение членства для создания. Когда приложение чата создает отношение членства для пользователя-человека, оно должно использовать определенные области авторизации и устанавливать определенные значения для определенных полей:
Для приглашения пользователей, не входящих в организацию Workspace, владеющую пространством, требуется аутентификация пользователя . Когда приложение чата создает для себя отношение членства, оно должно пройти аутентификацию в качестве пользователя и использовать область |
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
Представляет пользовательский эмодзи.
Поля | |
---|---|
name | Идентификатор. Имя ресурса пользовательского эмодзи, назначенное сервером. Формат: |
uid | Только вывод. Уникальный ключ для пользовательского ресурса смайлов. |
emoji_ name | Необязательный. Неизменяемый. Предоставленное пользователем имя для пользовательского смайлика, уникальное в рамках организации. Требуется при создании пользовательского смайлика, в противном случае выводите только. Имена эмодзи должны начинать и заканчиваться колонами, должны быть строчными и могут содержать только буквенно -цифровые символы, дефисы и подчеркивание. Дефисы и подставки должны использоваться для разделения слов и нельзя использовать последовательно. Пример:: |
temporary_ image_ uri | Только вывод. URL -адрес изображения для пользовательских смайликов, действительный не менее 10 минут. Обратите внимание, что это не заполняется в ответе, когда создается пользовательский смайлик. |
payload | Необязательный. Только ввод. Данные полезной нагрузки. Требуется, когда создается пользовательский смайлик. |
CustomeJipayLoad
Данные полезной нагрузки для пользовательских смайликов.
Поля | |
---|---|
file_ content | Необходимый. Только ввод. Изображение, используемое для пользовательских смайликов. Полезная нагрузка должна быть менее 256 т.п.н., а измерение изображения должно составлять от 64 до 500 пикселей. Ограничения могут быть изменены. |
filename | Необходимый. Только ввод. Имя файла изображения. Поддерживаемые расширения файлов: |
DeleteCustomejirequest
Запрос на удаление пользовательского смайлика.
Поля | |
---|---|
name | Необходимый. Название ресурса пользовательского смайлика для удаления. Формат: Вы можете использовать имя эмодзи в качестве псевдонима для |
DeletemembershipRequest
Запрос удалить членство в пространстве.
Поля | |
---|---|
name | Необходимый. Название ресурса членства для удаления. Приложения чата могут удалять пользователей людей или их собственное членство. Приложения чата не могут удалить членство других приложений. При удалении человеческого членства требуется формат При удалении членства в приложении требуется Формат: |
use_ admin_ access | Необязательный. Когда Пользователь по вызову должен быть администратором Google Workspace с привилегией Manage CHAT и Spaces Trantings . Требует Удаление членов приложения в пространстве не поддерживается с использованием доступа к администратору. |
DeletemessageRequest
Запрос удалить сообщение.
Поля | |
---|---|
name | Необходимый. Имя ресурса сообщения. Формат: Если вы установили пользовательский идентификатор для вашего сообщения, вы можете использовать значение из поля |
force | Необязательный. Когда Применяется только при аутентификации как пользователь . Не имеет никакого влияния при аутентификации в качестве приложения для чата . |
DeletereActionRequest
Удаляет реакцию на сообщение.
Поля | |
---|---|
name | Необходимый. Название реакции на удаление. Формат: |
DeleteSpacerequest
Запрос на удаление места.
Поля | |
---|---|
name | Необходимый. Название ресурса пространства для удаления. Формат: |
use_ admin_ access | Необязательный. Когда Пользователь по вызову должен быть администратором Google Workspace с привилегией Manage CHAT и Spaces Trantings . Требует |
DeletionMetadata
Информация о удаленном сообщении. Сообщение удаляется при установке delete_time
.
Поля | |
---|---|
deletion_ type | Указывает, кто удалил сообщение. |
DeletionType
Кто удалил сообщение и как оно было удалено. В будущем может быть добавлено больше значений.
Перечисления | |
---|---|
DELETION_TYPE_UNSPECIFIED | Это значение не используется. |
CREATOR | Пользователь удалил свое собственное сообщение. |
SPACE_OWNER | Владелец пространства удалил сообщение. |
ADMIN | Администратор Google Workspace удалил сообщение. |
APP_MESSAGE_EXPIRY | Приложение чата удалило собственное сообщение, когда оно истек. |
CREATOR_VIA_APP | Приложение чата удалило сообщение от имени пользователя. |
SPACE_OWNER_VIA_APP | Приложение чата удалило сообщение от имени владельца пространства. |
Диалог
Обертка вокруг корпуса карты диалога.
Поля | |
---|---|
body | Только ввод. Тело диалога, которое отображается в модале. Приложения Google Chat не поддерживают следующие карты: |
Диалог
Содержит диалог и код состояния запроса.
Поля | |
---|---|
action_ status | Только ввод. Статус для запроса либо вызвать, либо отправить диалог . Отображает статус и сообщение пользователям, если это необходимо. Например, в случае ошибки или успеха. |
Союзное полевое action . Действие для выполнения. action может быть только одним из следующих: | |
dialog | Только ввод. Диалог для запроса. |
DRIEDATAREF
Ссылка на данные привязанности к дисков.
Поля | |
---|---|
drive_ file_ id | Идентификатор для файла диска. Используйте с приводом API. |
DRIVELINKDATA
Данные для ссылок на Google Drive.
Поля | |
---|---|
drive_ data_ ref | DriedAtaref , который ссылается на файл Google Drive. |
mime_ type | Тип MIME связанного ресурса Google Drive. |
Эмодзи
Эмодзи, который используется в качестве реакции на сообщение.
Поля | |
---|---|
Полевой content союза. Необходимый. Содержание эмодзи. content может быть только одним из следующих: | |
unicode | Необязательный. Основные смайлики, представленные строкой Unicode. |
custom_ emoji | Только вывод. Пользовательский смайлик. |
Эмодзиреатзамман
Количество людей, которые отреагировали на сообщение с определенным смайликом.
Поля | |
---|---|
emoji | Только вывод. Эмодзи, связанные с реакциями. |
reaction_ count | Только вывод. Общее количество реакций с использованием связанных эмодзи. |
FindDirectMessAgeRequest
Запрос на получение прямого пространства сообщений на основе пользовательского ресурса.
Поля | |
---|---|
name | Необходимый. Имя ресурса пользователя, чтобы найти прямое сообщение. Format: |
GetAttachmentRequest
Просьба получить вложение.
Поля | |
---|---|
name | Необходимый. Имя ресурса вложения, в |
GetCustomeJirequest
Запрос на возврат одного пользовательского смайлика.
Поля | |
---|---|
name | Необходимый. Название ресурса пользовательского смайлика. Формат: Вы можете использовать имя эмодзи в качестве псевдонима для |
GetMembershipRequest
Запрос получить членство в пространстве.
Поля | |
---|---|
name | Необходимый. Название ресурса членства для извлечения. Чтобы получить собственное членство в приложении с помощью аутентификации пользователя , вы можете при желании использовать Формат: Вы можете использовать электронную почту пользователя в качестве псевдонима для |
use_ admin_ access | Необязательный. Когда Пользователь по вызову должен быть администратором Google Workspace с привилегией Manage CHAT и Spaces Trantings . Требует Получение членства в приложении в пространстве не поддерживается при использовании доступа к администратору. |
GetMessageRequest
Запрос получить сообщение.
Поля | |
---|---|
name | Необходимый. Имя ресурса сообщения. Формат: Если вы установили пользовательский идентификатор для вашего сообщения, вы можете использовать значение из поля |
GetSpaceEventRequest
Запросить сообщение о получении космического мероприятия.
Поля | |
---|---|
name | Необходимый. Название ресурса космического события. Формат: |
GetSpacenotificationsettingRequest
Запросить сообщение, чтобы получить настройку уведомления о пространстве. Поддерживает только получение настройки уведомления для пользователя.
Поля | |
---|---|
name | Необходимый. Формат: users/{user}/spaces/{space}/spacenotificationsetting
|
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 | Необходимый. Название ресурса потока считываем состояние для извлечения. Поддерживает только получение состояния чтения для звонящего пользователя. Чтобы обозначить пользователя по вызову, установите одно из следующих:
Format: users/{user}/spaces/{space}/threads/{thread}/threadReadState |
Группа
Группа Google в чате Google.
Поля | |
---|---|
name | Имя ресурса для группы Google. Представляет группу в группе облачных идентификаторов API. Формат: группы/{группа} |
Состояние истории
Состояние истории сообщений и пространств. Указывает, как долго сообщения и цепочки разговоров хранятся после создания.
Перечисления | |
---|---|
HISTORY_STATE_UNSPECIFIED | Значение по умолчанию. Не используйте. |
HISTORY_OFF | История отключена. Сообщения и темы хранятся 24 часа . |
HISTORY_ON | История включена. Правила хранения Сейфа организации определяют, как долго хранятся сообщения и цепочки. |
Listcustomejisrequest
Запрос на возврат списка пользовательских смайликов.
Поля | |
---|---|
page_ size | Необязательный. Максимальное количество пользовательских смайликов вернулось. Сервис может вернуть меньше пользовательских смайликов, чем это значение. В случае неопределенности значение по умолчанию составляет 25. Максимальное значение составляет 200; Значения выше 200 изменяются на 200. |
page_ token | Необязательный. (Если возобновить из предыдущего запроса.) Токен страницы, полученный из предыдущего списка пользовательского эмодзи. Предоставьте это, чтобы получить последующую страницу. При страничном значении фильтра должно соответствовать вызову, который предоставил токен страницы. Прохождение другого значения может привести к неожиданным результатам. |
filter | Необязательный. Фильтр запросов. Поддерживает фильтрацию создателем. Чтобы фильтровать создателем, вы должны указать достоверное значение. В настоящее время только Например, следующий запрос возвращает пользовательские смайлики, созданные абонентом:
Неверные запросы отклоняются сервером с ошибкой |
Listcustomejisresponse
Ответ на список пользовательских смайликов.
Поля | |
---|---|
custom_ emojis[] | Неупомянутый список. Список пользовательских смайликов на запрошенной (или первой) странице. |
next_ page_ token | Токен, который вы можете отправить в качестве |
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 членство соответствует. Чтение или мутирование членов для групп 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 | Необязательный. Неизменяемый. Ввод для создания сообщения, в противном случае только вывод. Пользователь, который может просматривать сообщение. При установке сообщение является приватным и видимым только для указанного пользователя и приложения чата. Чтобы включить это поле в ваш запрос, вы должны позвонить в API чата, используя аутентификацию приложения и пропустить следующее: Для получения подробной информации см. Отправить сообщение в частном порядке . |
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 мест возвращаются. The maximum value is 1000. If you use a value more than 1000, it's automatically changed to 1000. |
page_ token | A token, received from the previous search spaces call. Provide this parameter to retrieve the subsequent page. When paginating, all other parameters provided should match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results. |
query | Необходимый. A search query. You can search by using the following parameters:
Across different fields, only Among the same field, The following example queries are valid:
|
order_ by | Необязательный. How the list of spaces is ordered. Supported attributes to order by are:
Valid ordering operation values are:
The supported syntax are:
|
SearchSpacesResponse
Response with a list of spaces corresponding to the search spaces request.
Поля | |
---|---|
spaces[] | A page of the requested spaces. |
next_ page_ token | A token that can be used to retrieve the next page. If this field is empty, there are no subsequent pages. |
total_ size | The total number of spaces that match the query, across all pages. If the result is over 10,000 spaces, this value is an estimate. |
SetUpSpaceRequest
Request to create a space and add specified users to it.
Поля | |
---|---|
space | Необходимый. The To create a space, set To create a group chat, set To create a 1:1 conversation between humans, set To create an 1:1 conversation between a human and the calling Chat app, set If a |
request_ id | Необязательный. A unique identifier for this request. A random UUID is recommended. Specifying an existing request ID returns the space created with that ID instead of creating a new space. Specifying an existing request ID from the same Chat app with a different authenticated user returns an error. |
memberships[] | Необязательный. The Google Chat users or groups to invite to join the space. Omit the calling user, as they are added automatically. The set currently allows up to 20 memberships (in addition to the caller). For human membership, the For Google group membership, the Optional when setting Required when setting Required when setting Must be empty when creating a 1:1 conversation between a human and the calling Chat app (when setting |
SlashCommand
A slash command in Google Chat.
Поля | |
---|---|
command_ id | The ID of the slash command invoked. |
SlashCommandMetadata
Annotation metadata for slash commands (/).
Поля | |
---|---|
bot | The Chat app whose command was invoked. |
type | The type of slash command. |
command_ name | The name of the invoked slash command. |
command_ id | The command ID of the invoked slash command. |
triggers_ dialog | Indicates whether the slash command is for a dialog. |
Тип
Перечисления | |
---|---|
TYPE_UNSPECIFIED | Default value for the enum. Не используйте. |
ADD | Add Chat app to space. |
INVOKE | Invoke slash command in space. |
Космос
Место в Google Chat. Пространства — это разговоры между двумя или более пользователями или сообщения один на один между пользователем и приложением чата.
Поля | |
---|---|
name | Идентификатор. Имя ресурса пространства. Формат: Где |
type | Только вывод. Deprecated: Use |
space_ type | Необязательный. Тип помещения. Требуется при создании пространства или обновлении типа пространства. Вывод только для другого использования. |
single_ user_ bot_ dm | Необязательный. Является ли пространство личным сообщением между приложением чата и одним человеком. |
threaded | Только вывод. Устарело: вместо этого используйте |
display_ name | Необязательный. Отображаемое имя пространства. Требуется при создании пространства с Для прямых сообщений это поле может быть пустым. Поддерживает до 128 символов. |
external_ user_ allowed | Необязательный. Неизменяемый. Разрешено ли в этом пространстве любому пользователю Google Chat быть участником. Ввод при создании пространства в организации Google Workspace. Пропустите это поле при создании пространств в следующих условиях:
Для существующих пространств это поле предназначено только для вывода. |
space_ threading_ state | Только вывод. Состояние потока в пространстве чата. |
space_ details | Необязательный. Подробная информация о пространстве, включая описание и правила. |
space_ history_ state | Необязательный. Состояние истории сообщений и потоков в этом пространстве. |
import_ mode | Необязательный. Создано ли это пространство в Создание пространства в |
create_ time | Необязательный. Неизменяемый. Для пространств, созданных в Chat, — время создания пространства. Это поле предназначено только для вывода, за исключением случаев, когда оно используется в пространствах режима импорта. Для пространств режима импорта установите в этом поле историческую временную метку создания пространства в источнике, чтобы сохранить исходное время создания. Заполняется в выходных данных только в том случае, если |
last_ active_ time | Только вывод. Временная метка последнего сообщения в пространстве. |
admin_ installed | Только вывод. Для пространств прямого обмена сообщениями (DM) с приложением Chat: было ли пространство создано администратором Google Workspace. Администраторы могут установить и настроить прямое сообщение с помощью приложения Chat от имени пользователей в своей организации. Чтобы поддерживать установку администратора, ваше приложение Chat должно поддерживать прямой обмен сообщениями. |
membership_ count | Только вывод. Количество присоединившихся участников, сгруппированных по типу участников. Populated when the |
access_ settings | Необязательный. Указывает настройки доступа к пространству. Заполняется только в том случае, если |
space_ uri | Только вывод. URI для доступа пользователя к пространству. |
customer | Необязательный. Неизменяемый. Идентификатор клиента домена пространства. Требуется только при создании пространства с аутентификацией приложения и В формате Для личных сообщений это поле не заполняется. |
Поле объединения Требует аутентификации пользователя . | |
predefined_ permission_ settings | Необязательный. Только ввод. Предопределенные настройки разрешений пространства, вводимые только при создании пространства. Если поле не задано, создается пространство для совместной работы. После создания пространства параметры заполняются в поле |
permission_ settings | Необязательный. Настройки разрешений для существующих пространств. Вход для обновления точных настроек разрешений пространства, при этом существующие настройки разрешений заменяются. В выводе перечислены текущие настройки разрешений. |
Доступ к настройкам
Представляет настройки доступа к пространству.
Поля | |
---|---|
access_ state | Только вывод. Указывает состояние доступа к пространству. |
audience | Необязательный. Имя ресурса целевой аудитории , которая может обнаружить пространство, присоединиться к нему и просмотреть сообщения в пространстве. Если этот параметр не установлен, доступ к нему смогут получить только пользователи или группы Google, которые были индивидуально приглашены или добавлены в пространство. Подробную информацию см. в разделе «Как сделать пространство доступным для обнаружения целевой аудиторией» . Формат: Чтобы использовать целевую аудиторию по умолчанию для организации Google Workspace, установите значение Чтение целевой аудитории поддерживает:
Это поле не заполняется при использовании области Настройка целевой аудитории требует аутентификации пользователя . |
Аксессстате
Представляет состояние доступа к пространству.
Перечисления | |
---|---|
ACCESS_STATE_UNSPECIFIED | Состояние доступа неизвестно или не поддерживается в этом API. |
PRIVATE | Только пользователи или группы Google, которые были индивидуально добавлены или приглашены другими пользователями или администраторами Google Workspace, могут находить пространство и получать к нему доступ. |
DISCOVERABLE | Менеджер пространства предоставил целевой аудитории доступ к пространству. Пользователи или группы Google, которые были индивидуально добавлены или приглашены в пространство, также могут находить его и получать к нему доступ. Дополнительные сведения см. в разделе Как сделать пространство доступным для просмотра определенным пользователям . Создание обнаруживаемых пространств требует аутентификации пользователя . |
ЧленствоКаунт
Представляет количество участников пространства, сгруппированных по категориям.
Поля | |
---|---|
joined_ direct_ human_ user_ count | Только вывод. Подсчет пользователей-людей, которые напрямую присоединились к пространству, не считая пользователей, присоединившихся путем членства в присоединенной группе. |
joined_ group_ count | Только вывод. Подсчет всех групп, которые напрямую присоединились к пространству. |
Настройка разрешений
Представляет параметр разрешения пространства.
Поля | |
---|---|
managers_ allowed | Необязательный. Есть ли у менеджеров пространств это разрешение. |
members_ allowed | Необязательный. Имеют ли участники, не являющиеся менеджерами, это разрешение. |
Настройки разрешений
Параметры разрешений , которые можно указать при обновлении существующего именованного пространства.
Чтобы задать настройки разрешений при создании пространства, укажите в запросе поле PredefinedPermissionSettings
.
Поля | |
---|---|
manage_ members_ and_ groups | Необязательный. Настройка управления участниками и группами в пространстве. |
modify_ space_ details | Необязательный. Настройка обновления названия пространства, аватара, описания и рекомендаций. |
toggle_ history | Необязательный. Настройка включения и выключения истории пространства. |
use_ at_ mention_ all | Необязательный. Настройка использования @all в пространстве. |
manage_ apps | Необязательный. Настройка управления приложениями в пространстве. |
manage_ webhooks | Необязательный. Настройка управления веб-перехватчиками в пространстве. |
post_ messages | Только вывод. Настройка публикации сообщений в пространстве. |
reply_ messages | Необязательный. Настройка ответа на сообщения в пространстве. |
Предопределенные параметры разрешений
Предопределенные настройки разрешений, которые можно указать только при создании именованного пространства. В будущем могут быть добавлены дополнительные настройки. Подробные сведения о настройках разрешений для именованных пространств см. в разделе Дополнительные сведения о пространствах .
Перечисления | |
---|---|
PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED | Не указано. Не используйте. |
COLLABORATION_SPACE | Настройка, позволяющая сделать это пространство пространством для совместной работы, где все участники могут публиковать сообщения. |
ANNOUNCEMENT_SPACE | Настройка, позволяющая сделать пространство пространством объявлений, где только менеджеры пространства могут публиковать сообщения. |
ПространствоДетали
Подробная информация о пространстве, включая описание и правила.
Поля | |
---|---|
description | Необязательный. Описание помещения. Например, опишите тему обсуждения, функциональное назначение или участников пространства. Поддерживает до 150 символов. |
guidelines | Необязательный. Правила, ожидания и этикет этого места. Поддерживает до 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 Прямое сообщение между человеком и приложением чата, где все сообщения однородны. Обратите внимание, что сюда не входят прямые сообщения между двумя людьми. |
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: |
SpaceNotificationSetting
The notification settings of a user in a space.
Поля | |
---|---|
name | Идентификатор. The resource name of the space notification setting. Format: |
notification_ setting | The notification setting. |
mute_ setting | The space notification mute setting. |
MuteSetting
The space notification mute setting types.
Перечисления | |
---|---|
MUTE_SETTING_UNSPECIFIED | Сдержанный. |
UNMUTED | The user will receive notifications for the space based on the notification setting. |
MUTED | The user will not receive any notifications for the space, regardless of the notification setting. |
NotificationSetting
The notification setting types.
Перечисления | |
---|---|
NOTIFICATION_SETTING_UNSPECIFIED | Сдержанный. |
ALL | Notifications are triggered by @mentions, followed threads, first message of new threads. All new threads are automatically followed, unless manually unfollowed by the user. |
MAIN_CONVERSATIONS | The notification is triggered by @mentions, followed threads, first message of new threads. Not available for 1:1 direct messages. |
FOR_YOU | The notification is triggered by @mentions, followed threads. Not available for 1:1 direct messages. |
OFF | Notification is off. |
SpaceReadState
A user's read state within a space, used to identify read and unread messages.
Поля | |
---|---|
name | Resource name of the space read state. Format: |
last_ read_ time | Необязательный. The time when the user's space read state was updated. Usually this corresponds with either the timestamp of the last read message, or a timestamp specified by the user to mark the last read position in a space. |
SpaceUpdatedEventData
Event payload for an updated space.
Event type: google.workspace.chat.space.v1.updated
Поля | |
---|---|
space | 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 |
UpdateSpaceNotificationSettingRequest
Request to update the space notification settings. Only supports updating notification setting for the calling user.
Поля | |
---|---|
space_ notification_ setting | Необходимый. The resource name for the space notification settings must be populated in the form of |
update_ mask | Необходимый. Supported field paths: - |
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. DO NOT USE. |
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. Не используйте. |
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.
Поля | |
---|---|
Union field | |
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.
Поля | |
---|---|
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 | |
Индекс
-
ChatService
(interface) -
AccessoryWidget
(message) -
ActionResponse
(message) -
ActionResponse.ResponseType
(enum) -
ActionResponse.SelectionItems
(message) -
ActionResponse.UpdatedWidget
(message) -
ActionStatus
(message) -
Annotation
(message) -
AnnotationType
(enum) -
AttachedGif
(message) -
Attachment
(message) -
Attachment.Source
(enum) -
AttachmentDataRef
(message) -
CardWithId
(message) -
ChatSpaceLinkData
(message) -
CompleteImportSpaceRequest
(message) -
CompleteImportSpaceResponse
(message) -
ContextualAddOnMarkup
(message) -
ContextualAddOnMarkup.Card
(message) -
ContextualAddOnMarkup.Card.CardAction
(message) -
ContextualAddOnMarkup.Card.CardHeader
(message) -
ContextualAddOnMarkup.Card.CardHeader.ImageStyle
(enum) -
ContextualAddOnMarkup.Card.Section
(message) -
CreateCustomEmojiRequest
(message) -
CreateMembershipRequest
(message) -
CreateMessageRequest
(message) -
CreateMessageRequest.MessageReplyOption
(enum) -
CreateReactionRequest
(message) -
CreateSpaceRequest
(message) -
CustomEmoji
(message) -
CustomEmoji.CustomEmojiPayload
(message) -
DeleteCustomEmojiRequest
(message) -
DeleteMembershipRequest
(message) -
DeleteMessageRequest
(message) -
DeleteReactionRequest
(message) -
DeleteSpaceRequest
(message) -
DeletionMetadata
(message) -
DeletionMetadata.DeletionType
(enum) -
Dialog
(message) -
DialogAction
(message) -
DriveDataRef
(message) -
DriveLinkData
(message) -
Emoji
(message) -
EmojiReactionSummary
(message) -
FindDirectMessageRequest
(message) -
GetAttachmentRequest
(message) -
GetCustomEmojiRequest
(message) -
GetMembershipRequest
(message) -
GetMessageRequest
(message) -
GetSpaceEventRequest
(message) -
GetSpaceNotificationSettingRequest
(message) -
GetSpaceReadStateRequest
(message) -
GetSpaceRequest
(message) -
GetThreadReadStateRequest
(message) -
Group
(message) -
HistoryState
(enum) -
ListCustomEmojisRequest
(message) -
ListCustomEmojisResponse
(message) -
ListMembershipsRequest
(message) -
ListMembershipsResponse
(message) -
ListMessagesRequest
(message) -
ListMessagesResponse
(message) -
ListReactionsRequest
(message) -
ListReactionsResponse
(message) -
ListSpaceEventsRequest
(message) -
ListSpaceEventsResponse
(message) -
ListSpacesRequest
(message) -
ListSpacesResponse
(message) -
MatchedUrl
(message) -
Membership
(message) -
Membership.MembershipRole
(enum) -
Membership.MembershipState
(enum) -
MembershipBatchCreatedEventData
(message) -
MembershipBatchDeletedEventData
(message) -
MembershipBatchUpdatedEventData
(message) -
MembershipCreatedEventData
(message) -
MembershipDeletedEventData
(message) -
MembershipUpdatedEventData
(message) -
Message
(message) -
MessageBatchCreatedEventData
(message) -
MessageBatchDeletedEventData
(message) -
MessageBatchUpdatedEventData
(message) -
MessageCreatedEventData
(message) -
MessageDeletedEventData
(message) -
MessageUpdatedEventData
(message) -
QuotedMessageMetadata
(message) -
Reaction
(message) -
ReactionBatchCreatedEventData
(message) -
ReactionBatchDeletedEventData
(message) -
ReactionCreatedEventData
(message) -
ReactionDeletedEventData
(message) -
RichLinkMetadata
(message) -
RichLinkMetadata.RichLinkType
(enum) -
SearchSpacesRequest
(message) -
SearchSpacesResponse
(message) -
SetUpSpaceRequest
(message) -
SlashCommand
(message) -
SlashCommandMetadata
(message) -
SlashCommandMetadata.Type
(enum) -
Space
(message) -
Space.AccessSettings
(message) -
Space.AccessSettings.AccessState
(enum) -
Space.MembershipCount
(message) -
Space.PermissionSetting
(message) -
Space.PermissionSettings
(message) -
Space.PredefinedPermissionSettings
(enum) -
Space.SpaceDetails
(message) -
Space.SpaceThreadingState
(enum) -
Space.SpaceType
(enum) -
Space.Type
(enum) -
SpaceBatchUpdatedEventData
(message) -
SpaceEvent
(message) -
SpaceNotificationSetting
(message) -
SpaceNotificationSetting.MuteSetting
(enum) -
SpaceNotificationSetting.NotificationSetting
(enum) -
SpaceReadState
(message) -
SpaceUpdatedEventData
(message) -
Thread
(message) -
ThreadReadState
(message) -
UpdateMembershipRequest
(message) -
UpdateMessageRequest
(message) -
UpdateSpaceNotificationSettingRequest
(message) -
UpdateSpaceReadStateRequest
(message) -
UpdateSpaceRequest
(message) -
User
(message) -
User.Type
(enum) -
UserMentionMetadata
(message) -
UserMentionMetadata.Type
(enum) -
WidgetMarkup
(message) -
WidgetMarkup.Button
(message) -
WidgetMarkup.FormAction
(message) -
WidgetMarkup.FormAction.ActionParameter
(message) -
WidgetMarkup.Icon
(enum) -
WidgetMarkup.Image
(message) -
WidgetMarkup.ImageButton
(message) -
WidgetMarkup.KeyValue
(message) -
WidgetMarkup.OnClick
(message) -
WidgetMarkup.OpenLink
(message) -
WidgetMarkup.TextButton
(message) -
WidgetMarkup.TextParagraph
(message)
ChatService
Enables developers to build Chat apps and integrations on Google Chat Platform.
CompleteImportSpace |
---|
Завершает процесс импорта указанного пространства и делает его видимым для пользователей. Requires app authentication and domain-wide delegation. For more information, see Authorize Google Chat apps to import data .
|
CreateCustomEmoji |
---|
Создает собственный смайлик. Требует аутентификации пользователя .
|
CreateMembership |
---|
Создает членство для вызывающего приложения Chat, пользователя или группы Google. Creating memberships for other Chat apps isn't supported. When creating a membership, if the specified member has their auto-accept policy turned off, then they're invited, and must accept the space invitation before joining. Otherwise, creating a membership adds the member directly to the specified space. Supports the following types of authentication :
For example usage, see:
|
CreateMessage |
---|
Создает сообщение в чате Google. For an example, see Send a message . The The following image shows how Chat attributes a message when you use app authentication. Chat displays the Chat app as the message sender. The content of the message can contain text ( The following image shows how Chat attributes a message when you use user authentication. Chat displays the user as the message sender and attributes the Chat app to the message by displaying its name. The content of message can only contain text ( The maximum message size, including the message contents, is 32,000 bytes.
|
CreateReaction |
---|
Создает реакцию и добавляет ее в сообщение. Only unicode emojis are supported. For an example, see Add a reaction to a message . Требует аутентификации пользователя .
|
CreateSpace |
---|
Создает пространство. Can be used to create a named space, or a group chat in Supports the following types of authentication : When authenticating as an app, the Space membership upon creation depends on whether the space is created in
If you receive the error message
|
DeleteCustomEmoji |
---|
Удаляет собственный эмодзи. Требует аутентификации пользователя .
|
DeleteMembership |
---|
Удаляет членство. For an example, see Remove a user or a Google Chat app from a space . Supports the following types of authentication :
|
DeleteMessage |
---|
Удаляет сообщение. For an example, see Delete a message . Supports the following types of authentication : When using app authentication, requests can only delete messages created by the calling Chat app.
|
DeleteReaction |
---|
Удаляет реакцию на сообщение. Only unicode emojis are supported. For an example, see Delete a reaction . Требует аутентификации пользователя .
|
DeleteSpace |
---|
Удаляет именованное пространство. Always performs a cascading delete, which means that the space's child resources—like messages posted in the space and memberships in the space—are also deleted. For an example, see Delete a space . Supports the following types of authentication :
|
FindDirectMessage |
---|
Возвращает существующее прямое сообщение указанному пользователю. If no direct message space is found, returns a With app authentication , returns the direct message space between the specified user and the calling Chat app. With user authentication , returns the direct message space between the specified user and the authenticated user. // Supports the following types of authentication :
|
GetAttachment |
---|
Получает метаданные вложения сообщения. The attachment data is fetched using the media API . For an example, see Get metadata about a message attachment . Requires app authentication .
|
GetCustomEmoji |
---|
Возвращает сведения о пользовательском эмодзи. Требует аутентификации пользователя .
|
GetMembership |
---|
Возвращает сведения о членстве. For an example, see Get details about a user's or Google Chat app's membership . Supports the following types of authentication :
|
GetMessage |
---|
Возвращает сведения о сообщении. For an example, see Get details about a message . Supports the following types of authentication : Note: Might return a message from a blocked member or space.
|
GetSpace |
---|
Возвращает подробную информацию о пространстве. For an example, see Get details about a space . Supports the following types of authentication :
|
GetSpaceEvent |
---|
Возвращает событие из пространства Google Chat. The event payload contains the most recent version of the resource that changed. For example, if you request an event about a new message but the message was later updated, the server returns the updated Note: The Требует аутентификации пользователя . To get an event, the authenticated user must be a member of the space. For an example, see Get details about an event from a Google Chat space .
|
GetSpaceNotificationSetting |
---|
Получает настройки состояния уведомлений о пространстве. Требует аутентификации пользователя .
|
GetSpaceReadState |
---|
Возвращает сведения о состоянии чтения пользователя в пространстве, используемые для идентификации прочитанных и непрочитанных сообщений. For an example, see Get details about a user's space read state . Требует аутентификации пользователя .
|
GetThreadReadState |
---|
Возвращает сведения о состоянии чтения пользователя в потоке, используемые для идентификации прочитанных и непрочитанных сообщений. For an example, see Get details about a user's thread read state . Требует аутентификации пользователя .
|
ListCustomEmojis |
---|
Перечисляет пользовательские смайлы, видимые авторизованному пользователю. Требует аутентификации пользователя .
|
ListMemberships |
---|
Перечисляет членство в пространстве. For an example, see List users and Google Chat apps in a space . Listing memberships with app authentication lists memberships in spaces that the Chat app has access to, but excludes Chat app memberships, including its own. Listing memberships with User authentication lists memberships in spaces that the authenticated user has access to. Supports the following types of authentication :
|
ListMessages |
---|
Перечисляет сообщения в пространстве, участником которого является вызывающий абонент, включая сообщения от заблокированных участников и пространств. If you list messages from a space with no messages, the response is an empty object. When using a REST/HTTP interface, the response contains an empty JSON object, Требует аутентификации пользователя .
|
ListReactions |
---|
Перечисляет реакции на сообщение. For an example, see List reactions for a message . Требует аутентификации пользователя .
|
ListSpaceEvents |
---|
Перечисляет события из пространства Google Chat. For each event, the payload contains the most recent version of the Chat resource. For example, if you list events about new space members, the server returns Требует аутентификации пользователя . To list events, the authenticated user must be a member of the space. For an example, see List events from a Google Chat space .
|
ListSpaces |
---|
Перечисляет пространства, членом которых является вызывающий абонент. Group chats and DMs aren't listed until the first message is sent. For an example, see List spaces . Supports the following types of authentication : To list all named spaces by Google Workspace organization, use the
|
SearchSpaces |
---|
Возвращает список пространств в организации Google Workspace на основе поиска администратора. Requires user authentication with administrator privileges . In the request, set
|
SetUpSpace |
---|
Создает пространство и добавляет в него указанных пользователей. The calling user is automatically added to the space, and shouldn't be specified as a membership in the request. For an example, see Set up a space with initial members . To specify the human members to add, add memberships with the appropriate To specify the Google groups to add, add memberships with the appropriate For a named space or group chat, if the caller blocks, or is blocked by some members, or doesn't have permission to add some members, then those members aren't added to the created space. To create a direct message (DM) between the calling user and another human user, specify exactly one membership to represent the human user. If one user blocks the other, the request fails and the DM isn't created. To create a DM between the calling user and the calling app, set If a DM already exists between two users, even when one user blocks the other at the time a request is made, then the existing DM is returned. Spaces with threaded replies aren't supported. If you receive the error message Требует аутентификации пользователя .
|
UpdateMembership |
---|
Обновляет членство. For an example, see Update a user's membership in a space . Supports the following types of authentication :
|
UpdateMessage |
---|
Обновляет сообщение. There's a difference between the Supports the following types of authentication : When using app authentication, requests can only update messages created by the calling Chat app.
|
UpdateSpace |
---|
Обновляет пространство. For an example, see Update a space . If you're updating the Supports the following types of authentication :
|
UpdateSpaceNotificationSetting |
---|
Обновляет настройки состояния уведомлений о пространстве. Требует аутентификации пользователя .
|
UpdateSpaceReadState |
---|
Обновляет состояние чтения пользователя в пространстве, используемое для идентификации прочитанных и непрочитанных сообщений. For an example, see Update a user's space read state . Требует аутентификации пользователя .
|
AccessoryWidget
One or more interactive widgets that appear at the bottom of a message. For details, see Add interactive widgets at the bottom of a message .
Поля | |
---|---|
Union field action . The type of action. action can be only one of the following: | |
button_ list | A list of buttons. |
ActionResponse
Parameters that a Chat app can use to configure how its response is posted.
Поля | |
---|---|
type | Только ввод. The type of Chat app response. |
url | Только ввод. URL for users to authenticate or configure. (Only for |
dialog_ action | Только ввод. A response to an interaction event related to a dialog . Must be accompanied by |
updated_ widget | Только ввод. The response of the updated widget. |
ResponseType
The type of Chat app response.
Перечисления | |
---|---|
TYPE_UNSPECIFIED | Default type that's handled as NEW_MESSAGE . |
NEW_MESSAGE | Post as a new message in the topic. |
UPDATE_MESSAGE | Update the Chat app's message. This is only permitted on a CARD_CLICKED event where the message sender type is BOT . |
UPDATE_USER_MESSAGE_CARDS | Update the cards on a user's message. This is only permitted as a response to a MESSAGE event with a matched url, or a CARD_CLICKED event where the message sender type is HUMAN . Text is ignored. |
REQUEST_CONFIG | Privately ask the user for additional authentication or configuration. |
DIALOG | Presents a dialog . |
UPDATE_WIDGET | Widget text autocomplete options query. |
SelectionItems
List of widget autocomplete results.
Поля | |
---|---|
items[] | An array of the SelectionItem objects. |
UpdatedWidget
The response of the updated widget. Used to provide autocomplete options for a widget.
Поля | |
---|---|
widget | The ID of the updated widget. The ID must match the one for the widget that triggered the update request. |
Union field updated_widget . The widget updated in response to a user action. updated_widget can be only one of the following: | |
suggestions | List of widget autocomplete results |
ActionStatus
Represents the status for a request to either invoke or submit a dialog .
Поля | |
---|---|
status_ code | The status code. |
user_ facing_ message | The message to send users about the status of their request. If unset, a generic message based on the |
Аннотация
Только вывод. Annotations associated with the plain-text body of the message. To add basic formatting to a text message, see Format text messages .
Example plain-text message body:
Hello @FooBot how are you!"
The corresponding annotations metadata:
"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 | The type of this annotation. |
length | Length of the substring in the plain-text message body this annotation corresponds to. |
start_ index | Start index (0-based, inclusive) in the plain-text message body this annotation corresponds to. |
Union field metadata . Additional metadata about the annotation. metadata can be only one of the following: | |
user_ mention | The metadata of user mention. |
slash_ command | The metadata for a slash command. |
rich_ link_ metadata | The metadata for a rich link. |
AnnotationType
Type of the annotation.
Перечисления | |
---|---|
ANNOTATION_TYPE_UNSPECIFIED | Default value for the enum. Не используйте. |
USER_MENTION | A user is mentioned. |
SLASH_COMMAND | A slash command is invoked. |
RICH_LINK | A rich link annotation. |
AttachedGif
A GIF image that's specified by a URL.
Поля | |
---|---|
uri | Только вывод. The URL that hosts the GIF image. |
Вложение
An attachment in Google Chat.
Поля | |
---|---|
name | Необязательный. Resource name of the attachment, in the form |
content_ name | Только вывод. The original file name for the content, not the full path. |
content_ type | Только вывод. The content type (MIME type) of the file. |
thumbnail_ uri | Только вывод. The thumbnail URL which should be used to preview the attachment to a human user. Chat apps shouldn't use this URL to download attachment content. |
download_ uri | Только вывод. The download URL which should be used to allow a human user to download the attachment. Chat apps shouldn't use this URL to download attachment content. |
source | Только вывод. The source of the attachment. |
Union field data_ref . The data reference to the attachment. data_ref can be only one of the following: | |
attachment_ data_ ref | Необязательный. A reference to the attachment data. This field is used to create or update messages with attachments, or with the media API to download the attachment data. |
drive_ data_ ref | Только вывод. A reference to the Google Drive attachment. This field is used with the Google Drive API. |
Источник
The source of the attachment.
Перечисления | |
---|---|
SOURCE_UNSPECIFIED | Сдержанный. |
DRIVE_FILE | The file is a Google Drive file. |
UPLOADED_CONTENT | The file is uploaded to Chat. |
AttachmentDataRef
A reference to the attachment data.
Поля | |
---|---|
resource_ name | Необязательный. The resource name of the attachment data. This field is used with the media API to download the attachment data. |
attachment_ upload_ token | Необязательный. Opaque token containing a reference to an uploaded attachment. Treated by clients as an opaque string and used to create or update Chat messages with attachments. |
CardWithId
A card in a Google Chat message.
Only Chat apps can create cards. If your Chat app authenticates as a user , the message can't contain cards.
Design and preview cards with the Card Builder.
Open the Card BuilderПоля | |
---|---|
card_ id | Required if the message contains multiple cards. A unique identifier for a card in a message. |
card | A card. Maximum size is 32 KB. |
ChatSpaceLinkData
Data for Chat space links.
Поля | |
---|---|
space | The space of the linked Chat space resource. Формат: |
thread | The thread of the linked Chat space resource. Format: |
message | The message of the linked Chat space resource. Format: |
CompleteImportSpaceRequest
Request message for completing the import process for a space.
Поля | |
---|---|
name | Необходимый. Resource name of the import mode space. Формат: |
CompleteImportSpaceResponse
Response message for completing the import process for a space.
Поля | |
---|---|
space | The import mode space. |
ContextualAddOnMarkup
This type has no fields.
The markup for developers to specify the contents of a contextual AddOn.
Карта
A card is a UI element that can contain UI widgets such as text and images.
Поля | |
---|---|
header | The header of the card. A header usually contains a title and an image. |
sections[] | Sections are separated by a line divider. |
card_ actions[] | The actions of this card. |
name | Name of the card. |
CardAction
A card action is the action associated with the card. For an invoice card, a typical action would be: delete invoice, email invoice or open the invoice in browser.
Not supported by Google Chat apps.
Поля | |
---|---|
action_ label | The label used to be displayed in the action menu item. |
on_ click | The onclick action for this action item. |
CardHeader
Поля | |
---|---|
title | The title must be specified. The header has a fixed height: if both a title and subtitle is specified, each takes up one line. If only the title is specified, it takes up both lines. |
subtitle | The subtitle of the card header. |
image_ style | The image's type (for example, square border or circular border). |
image_ url | The URL of the image in the card header. |
ImageStyle
Перечисления | |
---|---|
IMAGE_STYLE_UNSPECIFIED | |
IMAGE | Square border. |
AVATAR | Circular border. |
Раздел
A section contains a collection of widgets that are rendered (vertically) in the order that they are specified. Across all platforms, cards have a narrow fixed width, so there's currently no need for layout properties (for example, float).
Поля | |
---|---|
header | The header of the section. Formatted text is supported. For more information about formatting text, see Formatting text in Google Chat apps and Formatting text in Google Workspace Add-ons . |
widgets[] | A section must contain at least one widget. |
CreateCustomEmojiRequest
A request to create a custom emoji.
Поля | |
---|---|
custom_ emoji | Необходимый. The custom emoji to create. |
CreateMembershipRequest
Request message for creating a membership.
Поля | |
---|---|
parent | Необходимый. The resource name of the space for which to create the membership. Формат: пробелы/{пробел} |
membership | Необходимый. The membership relation to create. The When a Chat app creates a membership relation for a human user, it must use certain authorization scopes and set specific values for certain fields:
Inviting users external to the Workspace organization that owns the space requires user authentication . When a Chat app creates a membership relation for itself, it must authenticate as a user and use the |
use_ admin_ access | Необязательный. When The calling user must be a Google Workspace administrator with the manage chat and spaces conversations privilege . Requires the Creating app memberships or creating memberships for users outside the administrator's Google Workspace organization isn't supported using admin access. |
CreateMessageRequest
Creates a message.
Поля | |
---|---|
parent | Необходимый. The resource name of the space in which to create a message. Формат: |
message | Необходимый. Message body. |
thread_key | Необязательный. Deprecated: Use |
request_ id | Необязательный. A unique request ID for this message. Specifying an existing request ID returns the message created with that ID instead of creating a new message. |
message_ reply_ option | Необязательный. Specifies whether a message starts a thread or replies to one. Only supported in named spaces. When responding to user interactions , this field is ignored. For interactions within a thread, the reply is created in the same thread. Otherwise, the reply is created as a new thread. |
message_ id | Необязательный. A custom ID for a message. Lets Chat apps get, update, or delete a message without needing to store the system-assigned ID in the message's resource name (represented in the message The value for this field must meet the following requirements:
For details, see Name a message . |
MessageReplyOption
Specifies how to reply to a message. More states might be added in the future.
Перечисления | |
---|---|
MESSAGE_REPLY_OPTION_UNSPECIFIED | По умолчанию. Starts a new thread. Using this option ignores any thread ID or that's included. |
REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD | Creates the message as a reply to the thread specified by thread ID or . If it fails, the message starts a new thread instead. |
REPLY_MESSAGE_OR_FAIL | Creates the message as a reply to the thread specified by thread ID or . If a new thread_key is used, a new thread is created. If the message creation fails, a NOT_FOUND error is returned instead. |
CreateReactionRequest
Creates a reaction to a message.
Поля | |
---|---|
parent | Необходимый. The message where the reaction is created. Format: |
reaction | Необходимый. The reaction to create. |
CreateSpaceRequest
A request to create a named space with no members.
Поля | |
---|---|
space | Необходимый. The If you receive the error message The space |
request_ id | Необязательный. A unique identifier for this request. A random UUID is recommended. Specifying an existing request ID returns the space created with that ID instead of creating a new space. Specifying an existing request ID from the same Chat app with a different authenticated user returns an error. |
CustomEmoji
Represents a custom emoji.
Поля | |
---|---|
name | Идентификатор. The resource name of the custom emoji, assigned by the server. Format: |
uid | Только вывод. Unique key for the custom emoji resource. |
emoji_ name | Необязательный. Неизменяемый. User-provided name for the custom emoji, which is unique within the organization. Required when the custom emoji is created, output only otherwise. Emoji names must start and end with colons, must be lowercase and can only contain alphanumeric characters, hyphens, and underscores. Hyphens and underscores should be used to separate words and cannot be used consecutively. Example: |
temporary_ image_ uri | Только вывод. The image URL for the custom emoji, valid for at least 10 minutes. Note that this is not populated in the response when the custom emoji is created. |
payload | Необязательный. Только ввод. Payload data. Required when the custom emoji is created. |
CustomEmojiPayload
Payload data for the custom emoji.
Поля | |
---|---|
file_ content | Необходимый. Только ввод. The image used for the custom emoji. The payload must be under 256 KB and the dimension of the image must be between 64 and 500 pixels. The restrictions are subject to change. |
filename | Необходимый. Только ввод. The image file name. Supported file extensions: |
DeleteCustomEmojiRequest
Request for deleting a custom emoji.
Поля | |
---|---|
name | Необходимый. Resource name of the custom emoji to delete. Format: You can use the emoji name as an alias for |
DeleteMembershipRequest
Request to delete a membership in a space.
Поля | |
---|---|
name | Необходимый. Resource name of the membership to delete. Chat apps can delete human users' or their own memberships. Chat apps can't delete other apps' memberships. When deleting a human membership, requires the When deleting an app membership, requires the Format: |
use_ admin_ access | Необязательный. When The calling user must be a Google Workspace administrator with the manage chat and spaces conversations privilege . Requires the Deleting app memberships in a space isn't supported using admin access. |
DeleteMessageRequest
Request to delete a message.
Поля | |
---|---|
name | Необходимый. Resource name of the message. Format: If you've set a custom ID for your message, you can use the value from the |
force | Необязательный. When Only applies when authenticating as a user . Has no effect when authenticating as a Chat app . |
DeleteReactionRequest
Удаляет реакцию на сообщение.
Поля | |
---|---|
name | Необходимый. Name of the reaction to delete. Format: |
DeleteSpaceRequest
Request for deleting a space.
Поля | |
---|---|
name | Необходимый. Resource name of the space to delete. Формат: |
use_ admin_ access | Необязательный. When The calling user must be a Google Workspace administrator with the manage chat and spaces conversations privilege . Requires the |
DeletionMetadata
Information about a deleted message. A message is deleted when delete_time
is set.
Поля | |
---|---|
deletion_ type | Indicates who deleted the message. |
DeletionType
Who deleted the message and how it was deleted. More values may be added in the future.
Перечисления | |
---|---|
DELETION_TYPE_UNSPECIFIED | This value is unused. |
CREATOR | User deleted their own message. |
SPACE_OWNER | The space owner deleted the message. |
ADMIN | A Google Workspace admin deleted the message. |
APP_MESSAGE_EXPIRY | A Chat app deleted its own message when it expired. |
CREATOR_VIA_APP | A Chat app deleted the message on behalf of the user. |
SPACE_OWNER_VIA_APP | A Chat app deleted the message on behalf of the space owner. |
Диалог
Wrapper around the card body of the dialog.
Поля | |
---|---|
body | Только ввод. Body of the dialog, which is rendered in a modal. Google Chat apps don't support the following card entities: |
DialogAction
Contains a dialog and request status code.
Поля | |
---|---|
action_ status | Только ввод. Status for a request to either invoke or submit a dialog . Displays a status and message to users, if necessary. For example, in case of an error or success. |
Union field action . Action to perform. action can be only one of the following: | |
dialog | Только ввод. Dialog for the request. |
DriveDataRef
A reference to the data of a drive attachment.
Поля | |
---|---|
drive_ file_ id | The ID for the drive file. Use with the Drive API. |
DriveLinkData
Data for Google Drive links.
Поля | |
---|---|
drive_ data_ ref | A DriveDataRef which references a Google Drive file. |
mime_ type | The mime type of the linked Google Drive resource. |
Эмодзи
An emoji that is used as a reaction to a message.
Поля | |
---|---|
Union field content . Необходимый. The content of the emoji. content can be only one of the following: | |
unicode | Необязательный. A basic emoji represented by a unicode string. |
custom_ emoji | Только вывод. A custom emoji. |
EmojiReactionSummary
The number of people who reacted to a message with a specific emoji.
Поля | |
---|---|
emoji | Только вывод. Emoji associated with the reactions. |
reaction_ count | Только вывод. The total number of reactions using the associated emoji. |
FindDirectMessageRequest
A request to get direct message space based on the user resource.
Поля | |
---|---|
name | Необходимый. Resource name of the user to find direct message with. Format: |
GetAttachmentRequest
Request to get an attachment.
Поля | |
---|---|
name | Необходимый. Resource name of the attachment, in the form |
GetCustomEmojiRequest
A request to return a single custom emoji.
Поля | |
---|---|
name | Необходимый. Resource name of the custom emoji. Format: You can use the emoji name as an alias for |
GetMembershipRequest
Request to get a membership of a space.
Поля | |
---|---|
name | Необходимый. Resource name of the membership to retrieve. To get the app's own membership by using user authentication , you can optionally use Format: You can use the user's email as an alias for |
use_ admin_ access | Необязательный. When The calling user must be a Google Workspace administrator with the manage chat and spaces conversations privilege . Requires the Getting app memberships in a space isn't supported when using admin access. |
GetMessageRequest
Request to get a message.
Поля | |
---|---|
name | Необходимый. Resource name of the message. Format: If you've set a custom ID for your message, you can use the value from the |
GetSpaceEventRequest
Request message for getting a space event.
Поля | |
---|---|
name | Необходимый. The resource name of the space event. Format: |
GetSpaceNotificationSettingRequest
Request message to get space notification setting. Only supports getting notification setting for the calling user.
Поля | |
---|---|
name | Необходимый. Format: users/{user}/spaces/{space}/spaceNotificationSetting
|
GetSpaceReadStateRequest
Request message for GetSpaceReadState API.
Поля | |
---|---|
name | Необходимый. Resource name of the space read state to retrieve. Only supports getting read state for the calling user. To refer to the calling user, set one of the following:
Format: users/{user}/spaces/{space}/spaceReadState |
GetSpaceRequest
A request to return a single space.
Поля | |
---|---|
name | Необходимый. Resource name of the space, in the form Формат: |
use_ admin_ access | Необязательный. When The calling user must be a Google Workspace administrator with the manage chat and spaces conversations privilege . Requires the |
GetThreadReadStateRequest
Request message for GetThreadReadStateRequest API.
Поля | |
---|---|
name | Необходимый. Resource name of the thread read state to retrieve. Only supports getting read state for the calling user. To refer to the calling user, set one of the following:
Format: users/{user}/spaces/{space}/threads/{thread}/threadReadState |
Группа
A Google Group in Google Chat.
Поля | |
---|---|
name | Resource name for a Google Group. Represents a group in Cloud Identity Groups API. Format: groups/{group} |
Состояние истории
Состояние истории сообщений и пространств. Указывает, как долго сообщения и цепочки разговоров хранятся после создания.
Перечисления | |
---|---|
HISTORY_STATE_UNSPECIFIED | Значение по умолчанию. Не используйте. |
HISTORY_OFF | История отключена. Сообщения и темы хранятся 24 часа . |
HISTORY_ON | История включена. Правила хранения Сейфа организации определяют, как долго хранятся сообщения и цепочки. |
ListCustomEmojisRequest
A request to return a list of custom emoji.
Поля | |
---|---|
page_ size | Необязательный. The maximum number of custom emoji returned. The service can return fewer custom emoji than this value. If unspecified, the default value is 25. The maximum value is 200; values above 200 are changed to 200. |
page_ token | Необязательный. (If resuming from a previous query.) A page token received from a previous list custom emoji call. Provide this to retrieve the subsequent page. When paginating, the filter value should match the call that provided the page token. Passing a different value might lead to unexpected results. |
filter | Необязательный. A query filter. Supports filtering by creator. To filter by creator, you must specify a valid value. Currently only For example, the following query returns custom emoji created by the caller:
Invalid queries are rejected by the server with an |
ListCustomEmojisResponse
A response to a list of custom emoji.
Поля | |
---|---|
custom_ emojis[] | Unordered list. List of custom emoji in the requested (or first) page. |
next_ page_ token | A token that you can send as |
ListMembershipsRequest
Request message for listing memberships.
Поля | |
---|---|
parent | Необходимый. The resource name of the space for which to fetch a membership list. Формат: пробелы/{пробел} |
page_ size | Необязательный. The maximum number of memberships to return. The service might return fewer than this value. If unspecified, at most 100 memberships are returned. The maximum value is 1000. If you use a value more than 1000, it's automatically changed to 1000. Negative values return an |
page_ token | Необязательный. A page token, received from a previous call to list memberships. Provide this parameter to retrieve the subsequent page. When paginating, all other parameters provided should match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results. |
filter | Необязательный. A query filter. You can filter memberships by a member's role ( To filter by role, set To filter by type, set To filter by both role and type, use the Either For example, the following queries are valid:
The following queries are invalid:
Invalid queries are rejected by the server with an |
show_ groups | Необязательный. When |
show_ invited | Необязательный. When Currently requires user authentication . |
use_ admin_ access | Необязательный. When The calling user must be a Google Workspace administrator with the manage chat and spaces conversations privilege . Requires either the Listing app memberships in a space isn't supported when using admin access. |
ListMembershipsResponse
Response to list memberships of the space.
Поля | |
---|---|
memberships[] | Unordered list. List of memberships in the requested (or first) page. |
next_ page_ token | A token that you can send as |
ListMessagesRequest
Lists messages in the specified space, that the user is a member of.
Поля | |
---|---|
parent | Необходимый. The resource name of the space to list messages from. Формат: |
page_ size | Необязательный. The maximum number of messages returned. The service might return fewer messages than this value. If unspecified, at most 25 are returned. The maximum value is 1000. If you use a value more than 1000, it's automatically changed to 1000. Negative values return an |
page_ token | Необязательный. A page token received from a previous list messages call. Provide this parameter to retrieve the subsequent page. When paginating, all other parameters provided should match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results. |
filter | Необязательный. A query filter. You can filter messages by date ( To filter messages by the date they were created, specify the To filter by thread, specify the To filter by both thread and date, use the For example, the following queries are valid:
Invalid queries are rejected by the server with an |
order_ by | Необязательный. How the list of messages is ordered. Specify a value to order by an ordering operation. Valid ordering operation values are as follows:
The default ordering is |
show_ deleted | Необязательный. Whether to include deleted messages. Deleted messages include deleted time and metadata about their deletion, but message content is unavailable. |
ListMessagesResponse
Response message for listing messages.
Поля | |
---|---|
messages[] | List of messages. |
next_ page_ token | You can send a token as |
ListReactionsRequest
Перечисляет реакции на сообщение.
Поля | |
---|---|
parent | Необходимый. The message users reacted to. Format: |
page_ size | Необязательный. The maximum number of reactions returned. The service can return fewer reactions than this value. If unspecified, the default value is 25. The maximum value is 200; values above 200 are changed to 200. |
page_ token | Необязательный. (If resuming from a previous query.) A page token received from a previous list reactions call. Provide this to retrieve the subsequent page. When paginating, the filter value should match the call that provided the page token. Passing a different value might lead to unexpected results. |
filter | Необязательный. A query filter. You can filter reactions by emoji (either To filter reactions for multiple emojis or users, join similar fields with the To filter reactions by emoji and user, use the If your query uses both For example, the following queries are valid:
The following queries are invalid:
Invalid queries are rejected by the server with an |
ListReactionsResponse
Response to a list reactions request.
Поля | |
---|---|
reactions[] | List of reactions in the requested (or first) page. |
next_ page_ token | Continuation token to retrieve the next page of results. It's empty for the last page of results. |
ListSpaceEventsRequest
Request message for listing space events.
Поля | |
---|---|
parent | Необходимый. Resource name of the Google Chat space where the events occurred. Format: |
page_ size | Необязательный. The maximum number of space events returned. The service might return fewer than this value. Negative values return an |
page_ token | Необязательный. A page token, received from a previous list space events call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to list space events must match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results. |
filter | Необходимый. A query filter. You must specify at least one event type ( Optionally, you can also filter by start time (
To specify a start or end time, use the equals For example, the following queries are valid:
The following queries are invalid:
Invalid queries are rejected by the server with an |
ListSpaceEventsResponse
Response message for listing space events.
Поля | |
---|---|
space_ events[] | Results are returned in chronological order (oldest event first). Note: The |
next_ page_ token | Continuation token used to fetch more events. If this field is omitted, there are no subsequent pages. |
ListSpacesRequest
A request to list the spaces the caller is a member of.
Поля | |
---|---|
page_ size | Необязательный. The maximum number of spaces to return. The service might return fewer than this value. If unspecified, at most 100 spaces are returned. The maximum value is 1000. If you use a value more than 1000, it's automatically changed to 1000. Negative values return an |
page_ token | Необязательный. A page token, received from a previous list spaces call. Provide this parameter to retrieve the subsequent page. When paginating, the filter value should match the call that provided the page token. Passing a different value may lead to unexpected results. |
filter | Необязательный. A query filter. You can filter spaces by the space type ( To filter by space type, you must specify valid enum value, such as For example, the following queries are valid:
Invalid queries are rejected by the server with an |
ListSpacesResponse
The response for a list spaces request.
Поля | |
---|---|
spaces[] | List of spaces in the requested (or first) page. Note: The |
next_ page_ token | You can send a token as |
MatchedUrl
A matched URL in a Chat message. Chat apps can preview matched URLs. For more information, see Preview links .
Поля | |
---|---|
url | Только вывод. The URL that was matched. |
Membership
Represents a membership relation in Google Chat, such as whether a user or Chat app is invited to, part of, or absent from a space.
Поля | |
---|---|
name | Идентификатор. Resource name of the membership, assigned by the server. Format: |
state | Только вывод. State of the membership. |
role | Необязательный. User's role within a Chat space, which determines their permitted actions in the space. This field can only be used as input in |
create_ time | Необязательный. Неизменяемый. The creation time of the membership, such as when a member joined or was invited to join a space. This field is output only, except when used to import historical memberships in import mode spaces. |
delete_ time | Необязательный. Неизменяемый. The deletion time of the membership, such as when a member left or was removed from a space. This field is output only, except when used to import historical memberships in import mode spaces. |
Union field memberType . Member associated with this membership. Other member types might be supported in the future. memberType can be only one of the following: | |
member | Необязательный. The Google Chat user or app the membership corresponds to. If your Chat app authenticates as a user , the output populates the user |
group_ member | Необязательный. The Google Group the membership corresponds to. Reading or mutating memberships for Google Groups requires user authentication . |
MembershipRole
Represents a user's permitted actions in a Chat space. More enum values might be added in the future.
Перечисления | |
---|---|
MEMBERSHIP_ROLE_UNSPECIFIED | Значение по умолчанию. For users : they aren't a member of the space, but can be invited. For Google Groups : they're always assigned this role (other enum values might be used in the future). |
ROLE_MEMBER | A member of the space. The user has basic permissions, like sending messages to the space. In 1:1 and unnamed group conversations, everyone has this role. |
ROLE_MANAGER | A space manager. The user has all basic permissions plus administrative permissions that let them manage the space, like adding or removing members. Only supported in SpaceType.SPACE . |
MembershipState
Specifies the member's relationship with a space. Other membership states might be supported in the future.
Перечисления | |
---|---|
MEMBERSHIP_STATE_UNSPECIFIED | Значение по умолчанию. Не используйте. |
JOINED | The user is added to the space, and can participate in the space. |
INVITED | The user is invited to join the space, but hasn't joined it. |
NOT_A_MEMBER | The user doesn't belong to the space and doesn't have a pending invitation to join the space. |
MembershipBatchCreatedEventData
Event payload for multiple new memberships.
Event type: google.workspace.chat.membership.v1.batchCreated
Поля | |
---|---|
memberships[] | A list of new memberships. |
MembershipBatchDeletedEventData
Event payload for multiple deleted memberships.
Event type: google.workspace.chat.membership.v1.batchDeleted
Поля | |
---|---|
memberships[] | A list of deleted memberships. |
MembershipBatchUpdatedEventData
Event payload for multiple updated memberships.
Event type: google.workspace.chat.membership.v1.batchUpdated
Поля | |
---|---|
memberships[] | A list of updated memberships. |
MembershipCreatedEventData
Event payload for a new membership.
Event type: google.workspace.chat.membership.v1.created
.
Поля | |
---|---|
membership | The new membership. |
MembershipDeletedEventData
Event payload for a deleted membership.
Event type: google.workspace.chat.membership.v1.deleted
Поля | |
---|---|
membership | The deleted membership. Only the |
MembershipUpdatedEventData
Event payload for an updated membership.
Event type: google.workspace.chat.membership.v1.updated
Поля | |
---|---|
membership | The updated membership. |
Сообщение
A message in a Google Chat space.
Поля | |
---|---|
name | Идентификатор. Resource name of the message. Format: Where If you set a custom ID when you create a message, you can use this ID to specify the message in a request by replacing |
sender | Только вывод. The user who created the message. If your Chat app authenticates as a user , the output populates the user |
create_ time | Необязательный. Неизменяемый. For spaces created in Chat, the time at which the message was created. Это поле предназначено только для вывода, за исключением случаев, когда оно используется в пространствах режима импорта. For import mode spaces, set this field to the historical timestamp at which the message was created in the source in order to preserve the original creation time. |
last_ update_ time | Только вывод. The time at which the message was last edited by a user. If the message has never been edited, this field is empty. |
delete_ time | Только вывод. The time at which the message was deleted in Google Chat. If the message is never deleted, this field is empty. |
text | Необязательный. Plain-text body of the message. The first link to an image, video, or web page generates a preview chip . You can also @mention a Google Chat user , or everyone in the space. To learn about creating text messages, see Send a message . |
formatted_ text | Только вывод. Contains the message
For more information, see View text formatting sent in a message |
cards[] | Deprecated: Use Rich, formatted, and interactive cards that you can use to display UI elements such as: formatted texts, buttons, and clickable images. Cards are normally displayed below the plain-text body of the message. |
cards_ v2[] | Необязательный. An array of cards . Only Chat apps can create cards. If your Chat app authenticates as a user , the messages can't contain cards. To learn how to create a message that contains cards, see Send a message . Design and preview cards with the Card Builder. Open the Card Builder |
annotations[] | Только вывод. Annotations associated with the |
thread | The thread the message belongs to. For example usage, see Start or reply to a message thread . |
space | Только вывод. If your Chat app authenticates as a user , the output only populates the space |
fallback_ text | Необязательный. A plain-text description of the message's cards, used when the actual cards can't be displayed—for example, mobile notifications. |
action_ response | Только ввод. Parameters that a Chat app can use to configure how its response is posted. |
argument_ text | Только вывод. Plain-text body of the message with all Chat app mentions stripped out. |
slash_ command | Только вывод. Slash command information, if applicable. |
attachment[] | Необязательный. User-uploaded attachment. |
matched_ url | Только вывод. A URL in |
thread_ reply | Только вывод. When If the space doesn't support reply in threads, this field is always |
client_ assigned_ message_ id | Необязательный. A custom ID for the message. You can use field to identify a message, or to get, delete, or update a message. To set a custom ID, specify the |
emoji_ reaction_ summaries[] | Только вывод. The list of emoji reaction summaries on the message. |
private_ message_ viewer | Необязательный. Неизменяемый. Input for creating a message, otherwise output only. The user that can view the message. When set, the message is private and only visible to the specified user and the Chat app. To include this field in your request, you must call the Chat API using app authentication and omit the following: For details, see Send a message privately . |
deletion_ metadata | Только вывод. Information about a deleted message. A message is deleted when |
quoted_ message_ metadata | Только вывод. Information about a message that's quoted by a Google Chat user in a space. Google Chat users can quote a message to reply to it. |
attached_ gifs[] | Только вывод. GIF images that are attached to the message. |
accessory_ widgets[] | Необязательный. One or more interactive widgets that appear at the bottom of a message. You can add accessory widgets to messages that contain text, cards, or both text and cards. Not supported for messages that contain dialogs. For details, see Add interactive widgets at the bottom of a message . Creating a message with accessory widgets requires app authentication . |
MessageBatchCreatedEventData
Event payload for multiple new messages.
Event type: google.workspace.chat.message.v1.batchCreated
Поля | |
---|---|
messages[] | A list of new messages. |
MessageBatchDeletedEventData
Event payload for multiple deleted messages.
Event type: google.workspace.chat.message.v1.batchDeleted
Поля | |
---|---|
messages[] | A list of deleted messages. |
MessageBatchUpdatedEventData
Event payload for multiple updated messages.
Event type: google.workspace.chat.message.v1.batchUpdated
Поля | |
---|---|
messages[] | A list of updated messages. |
MessageCreatedEventData
Event payload for a new message.
Event type: google.workspace.chat.message.v1.created
Поля | |
---|---|
message | The new message. |
MessageDeletedEventData
Event payload for a deleted message.
Event type: google.workspace.chat.message.v1.deleted
Поля | |
---|---|
message | The deleted message. Only the |
MessageUpdatedEventData
Event payload for an updated message.
Event type: google.workspace.chat.message.v1.updated
Поля | |
---|---|
message | The updated message. |
QuotedMessageMetadata
Information about a quoted message.
Поля | |
---|---|
name | Только вывод. Resource name of the quoted message. Format: |
last_ update_ time | Только вывод. The timestamp when the quoted message was created or when the quoted message was last updated. |
Реакция
A reaction to a message.
Поля | |
---|---|
name | Идентификатор. The resource name of the reaction. Format: |
user | Только вывод. The user who created the reaction. |
emoji | Необходимый. The emoji used in the reaction. |
ReactionBatchCreatedEventData
Event payload for multiple new reactions.
Event type: google.workspace.chat.reaction.v1.batchCreated
Поля | |
---|---|
reactions[] | A list of new reactions. |
ReactionBatchDeletedEventData
Event payload for multiple deleted reactions.
Event type: google.workspace.chat.reaction.v1.batchDeleted
Поля | |
---|---|
reactions[] | A list of deleted reactions. |
ReactionCreatedEventData
Event payload for a new reaction.
Event type: google.workspace.chat.reaction.v1.created
Поля | |
---|---|
reaction | The new reaction. |
ReactionDeletedEventData
Event payload for a deleted reaction.
Type: google.workspace.chat.reaction.v1.deleted
Поля | |
---|---|
reaction | The deleted reaction. |
RichLinkMetadata
A rich link to a resource.
Поля | |
---|---|
uri | The URI of this link. |
rich_ link_ type | The rich link type. |
Union field data . Data for the linked resource. data can be only one of the following: | |
drive_ link_ data | Data for a drive link. |
chat_ space_ link_ data | Data for a chat space link. |
RichLinkType
The rich link type. More types might be added in the future.
Перечисления | |
---|---|
RICH_LINK_TYPE_UNSPECIFIED | Default value for the enum. Не используйте. |
DRIVE_FILE | A Google Drive rich link type. |
CHAT_SPACE | A Chat space rich link type. For example, a space smart chip. |
SearchSpacesRequest
Request to search for a list of spaces based on a query.
Поля | |
---|---|
use_ admin_ access | When The calling user must be a Google Workspace administrator with the manage chat and spaces conversations privilege . Requires either the This method currently only supports admin access, thus only |
page_ size | The maximum number of spaces to return. The service may return fewer than this value. If unspecified, at most 100 spaces are returned. The maximum value is 1000. If you use a value more than 1000, it's automatically changed to 1000. |
page_ token | A token, received from the previous search spaces call. Provide this parameter to retrieve the subsequent page. When paginating, all other parameters provided should match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results. |
query | Необходимый. A search query. You can search by using the following parameters:
Across different fields, only Among the same field, The following example queries are valid:
|
order_ by | Необязательный. How the list of spaces is ordered. Supported attributes to order by are:
Valid ordering operation values are:
The supported syntax are:
|
SearchSpacesResponse
Response with a list of spaces corresponding to the search spaces request.
Поля | |
---|---|
spaces[] | A page of the requested spaces. |
next_ page_ token | A token that can be used to retrieve the next page. If this field is empty, there are no subsequent pages. |
total_ size | The total number of spaces that match the query, across all pages. If the result is over 10,000 spaces, this value is an estimate. |
SetUpSpaceRequest
Request to create a space and add specified users to it.
Поля | |
---|---|
space | Необходимый. The To create a space, set To create a group chat, set To create a 1:1 conversation between humans, set To create an 1:1 conversation between a human and the calling Chat app, set If a |
request_ id | Необязательный. A unique identifier for this request. A random UUID is recommended. Specifying an existing request ID returns the space created with that ID instead of creating a new space. Specifying an existing request ID from the same Chat app with a different authenticated user returns an error. |
memberships[] | Необязательный. The Google Chat users or groups to invite to join the space. Omit the calling user, as they are added automatically. The set currently allows up to 20 memberships (in addition to the caller). For human membership, the For Google group membership, the Optional when setting Required when setting Required when setting Must be empty when creating a 1:1 conversation between a human and the calling Chat app (when setting |
SlashCommand
A slash command in Google Chat.
Поля | |
---|---|
command_ id | The ID of the slash command invoked. |
SlashCommandMetadata
Annotation metadata for slash commands (/).
Поля | |
---|---|
bot | The Chat app whose command was invoked. |
type | The type of slash command. |
command_ name | The name of the invoked slash command. |
command_ id | The command ID of the invoked slash command. |
triggers_ dialog | Indicates whether the slash command is for a dialog. |
Тип
Перечисления | |
---|---|
TYPE_UNSPECIFIED | Default value for the enum. Не используйте. |
ADD | Add Chat app to space. |
INVOKE | Invoke slash command in space. |
Космос
Место в Google Chat. Пространства — это разговоры между двумя или более пользователями или сообщения один на один между пользователем и приложением чата.
Поля | |
---|---|
name | Идентификатор. Имя ресурса пространства. Формат: Где |
type | Только вывод. Deprecated: Use |
space_ type | Необязательный. Тип помещения. Требуется при создании пространства или обновлении типа пространства. Вывод только для другого использования. |
single_ user_ bot_ dm | Необязательный. Является ли пространство личным сообщением между приложением чата и одним человеком. |
threaded | Только вывод. Устарело: вместо этого используйте |
display_ name | Необязательный. Отображаемое имя пространства. Требуется при создании пространства с Для прямых сообщений это поле может быть пустым. Поддерживает до 128 символов. |
external_ user_ allowed | Необязательный. Неизменяемый. Разрешено ли в этом пространстве любому пользователю Google Chat быть участником. Ввод при создании пространства в организации Google Workspace. Пропустите это поле при создании пространств в следующих условиях:
Для существующих пространств это поле предназначено только для вывода. |
space_ threading_ state | Только вывод. Состояние потока в пространстве чата. |
space_ details | Необязательный. Подробная информация о пространстве, включая описание и правила. |
space_ history_ state | Необязательный. Состояние истории сообщений и потоков в этом пространстве. |
import_ mode | Необязательный. Создано ли это пространство в Создание пространства в |
create_ time | Необязательный. Неизменяемый. Для пространств, созданных в Chat, — время создания пространства. Это поле предназначено только для вывода, за исключением случаев, когда оно используется в пространствах режима импорта. Для пространств режима импорта установите в этом поле историческую временную метку создания пространства в источнике, чтобы сохранить исходное время создания. Заполняется в выходных данных только в том случае, если |
last_ active_ time | Только вывод. Временная метка последнего сообщения в пространстве. |
admin_ installed | Только вывод. Для пространств прямого обмена сообщениями (DM) с приложением Chat: было ли пространство создано администратором Google Workspace. Администраторы могут установить и настроить прямое сообщение с помощью приложения Chat от имени пользователей в своей организации. Чтобы поддерживать установку администратора, ваше приложение Chat должно поддерживать прямой обмен сообщениями. |
membership_ count | Только вывод. Количество присоединившихся участников, сгруппированных по типу участников. Populated when the |
access_ settings | Необязательный. Указывает настройки доступа к пространству. Заполняется только в том случае, если |
space_ uri | Только вывод. URI для доступа пользователя к пространству. |
customer | Необязательный. Неизменяемый. Идентификатор клиента домена пространства. Требуется только при создании пространства с аутентификацией приложения и В формате Для личных сообщений это поле не заполняется. |
Поле объединения Требует аутентификации пользователя . | |
predefined_ permission_ settings | Необязательный. Только ввод. Предопределенные настройки разрешений пространства, вводимые только при создании пространства. Если поле не задано, создается пространство для совместной работы. После создания пространства параметры заполняются в поле |
permission_ settings | Необязательный. Настройки разрешений для существующих пространств. Вход для обновления точных настроек разрешений пространства, при этом существующие настройки разрешений заменяются. В выводе перечислены текущие настройки разрешений. |
Доступ к настройкам
Представляет настройки доступа к пространству.
Поля | |
---|---|
access_ state | Только вывод. Указывает состояние доступа к пространству. |
audience | Необязательный. Имя ресурса целевой аудитории , которая может обнаружить пространство, присоединиться к нему и просмотреть сообщения в пространстве. Если этот параметр не установлен, доступ к нему смогут получить только пользователи или группы Google, которые были индивидуально приглашены или добавлены в пространство. Подробную информацию см. в разделе «Как сделать пространство доступным для обнаружения целевой аудиторией» . Формат: Чтобы использовать целевую аудиторию по умолчанию для организации Google Workspace, установите значение Чтение целевой аудитории поддерживает:
Это поле не заполняется при использовании области Настройка целевой аудитории требует аутентификации пользователя . |
Аксессстате
Представляет состояние доступа к пространству.
Перечисления | |
---|---|
ACCESS_STATE_UNSPECIFIED | Состояние доступа неизвестно или не поддерживается в этом API. |
PRIVATE | Только пользователи или группы Google, которые были индивидуально добавлены или приглашены другими пользователями или администраторами Google Workspace, могут находить пространство и получать к нему доступ. |
DISCOVERABLE | Менеджер пространства предоставил целевой аудитории доступ к пространству. Пользователи или группы Google, которые были индивидуально добавлены или приглашены в пространство, также могут находить его и получать к нему доступ. Дополнительные сведения см. в разделе Как сделать пространство доступным для просмотра определенным пользователям . Создание обнаруживаемых пространств требует аутентификации пользователя . |
ЧленствоКаунт
Представляет количество участников пространства, сгруппированных по категориям.
Поля | |
---|---|
joined_ direct_ human_ user_ count | Только вывод. Подсчет пользователей-людей, которые напрямую присоединились к пространству, не считая пользователей, присоединившихся путем членства в присоединенной группе. |
joined_ group_ count | Только вывод. Подсчет всех групп, которые напрямую присоединились к пространству. |
Настройка разрешений
Представляет параметр разрешения пространства.
Поля | |
---|---|
managers_ allowed | Необязательный. Есть ли у менеджеров пространств это разрешение. |
members_ allowed | Необязательный. Имеют ли участники, не являющиеся менеджерами, это разрешение. |
Настройки разрешений
Параметры разрешений , которые можно указать при обновлении существующего именованного пространства.
Чтобы задать настройки разрешений при создании пространства, укажите в запросе поле PredefinedPermissionSettings
.
Поля | |
---|---|
manage_ members_ and_ groups | Необязательный. Настройка управления участниками и группами в пространстве. |
modify_ space_ details | Необязательный. Настройка обновления названия пространства, аватара, описания и рекомендаций. |
toggle_ history | Необязательный. Настройка включения и выключения истории пространства. |
use_ at_ mention_ all | Необязательный. Настройка использования @all в пространстве. |
manage_ apps | Необязательный. Настройка управления приложениями в пространстве. |
manage_ webhooks | Необязательный. Настройка управления веб-перехватчиками в пространстве. |
post_ messages | Только вывод. Настройка публикации сообщений в пространстве. |
reply_ messages | Необязательный. Настройка ответа на сообщения в пространстве. |
Предопределенные параметры разрешений
Предопределенные настройки разрешений, которые можно указать только при создании именованного пространства. В будущем могут быть добавлены дополнительные настройки. Подробные сведения о настройках разрешений для именованных пространств см. в разделе Дополнительные сведения о пространствах .
Перечисления | |
---|---|
PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED | Не указано. Не используйте. |
COLLABORATION_SPACE | Настройка, позволяющая сделать это пространство пространством для совместной работы, где все участники могут публиковать сообщения. |
ANNOUNCEMENT_SPACE | Настройка, позволяющая сделать пространство пространством объявлений, где только менеджеры пространства могут публиковать сообщения. |
ПространствоДетали
Подробная информация о пространстве, включая описание и правила.
Поля | |
---|---|
description | Необязательный. Описание помещения. Например, опишите тему обсуждения, функциональное назначение или участников пространства. Поддерживает до 150 символов. |
guidelines | Необязательный. Правила, ожидания и этикет этого места. Поддерживает до 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 Прямое сообщение между человеком и приложением чата, где все сообщения однородны. Обратите внимание, что сюда не входят прямые сообщения между двумя людьми. |
SpaceBatchUpdatedEventData
Event payload for multiple updates to a space.
Event type: google.workspace.chat.space.v1.batchUpdated
Поля | |
---|---|
spaces[] |