Чтобы предотвратить переключение контекста, когда пользователи делятся ссылкой в Google Chat, ваше приложение Chat может предварительно просмотреть ссылку, прикрепив к сообщению карточку , которая предоставляет дополнительную информацию и позволяет людям выполнять действия прямо из Google Chat.
Например, представьте себе пространство Google Chat, которое включает всех агентов службы поддержки клиентов компании, а также приложение Chat под названием Case-y. Агенты часто делятся ссылками на случаи обслуживания клиентов в пространстве Chat, и каждый раз, когда они это делают, их коллеги должны открывать ссылку на случай, чтобы увидеть такие детали, как ответственное лицо, статус и тема. Аналогично, если кто-то хочет взять на себя ответственность за случай или изменить статус, ему нужно открыть ссылку.
Предварительный просмотр ссылок позволяет приложению Chat пространства Case-y прикреплять карточку с указанием ответственного, статуса и темы всякий раз, когда кто-то делится ссылкой на дело. Кнопки на карточке позволяют агентам брать на себя ответственность за дело и изменять статус непосредственно из потока чата.
Как работает предварительный просмотр ссылок
Когда кто-то добавляет ссылку в свое сообщение, появляется чип, который дает ему знать, что приложение Chat может просмотреть ссылку.
После отправки сообщения ссылка отправляется в приложение Chat, которое затем генерирует и прикрепляет карточку к сообщению пользователя.
Наряду со ссылкой карточка предоставляет дополнительную информацию о ссылке, включая интерактивные элементы, такие как кнопки. Ваше приложение Chat может обновлять прикрепленную карточку в ответ на взаимодействие с пользователем, например, нажатие кнопок.
Если кто-то не хочет, чтобы приложение Chat просматривало его ссылку, прикрепляя карточку к сообщению, он может предотвратить просмотр, нажав
на чипе предварительного просмотра. Пользователи могут удалить прикрепленную карточку в любое время, нажав «Удалить предварительный просмотр» .Предпосылки
Node.js
Приложение Google Chat, которое получает и отвечает на события взаимодействия . Чтобы создать интерактивное приложение Chat с использованием HTTP-сервиса, выполните это краткое руководство .Питон
Приложение Google Chat, которое получает и отвечает на события взаимодействия . Чтобы создать интерактивное приложение Chat с использованием HTTP-сервиса, выполните это краткое руководство .Ява
Приложение Google Chat, которое получает и отвечает на события взаимодействия . Чтобы создать интерактивное приложение Chat с использованием HTTP-сервиса, выполните это краткое руководство .Скрипт приложений
Приложение Google Chat, которое получает и отвечает на события взаимодействия . Чтобы создать интерактивное приложение Chat в Apps Script, выполните это краткое руководство .Настроить предварительный просмотр ссылок
Зарегистрируйте определенные ссылки, например example.com
, support.example.com
и support.example.com/cases/
, в качестве шаблонов URL-адресов на странице конфигурации вашего приложения Chat в консоли Google Cloud, чтобы ваше приложение Chat могло просматривать их.
- Откройте консоль Google Cloud .
- Рядом с «Google Cloud» нажмите стрелку вниз и откройте проект вашего приложения Chat.
- В поле поиска введите
Google Chat API
и нажмите Google Chat API . - Нажмите Управление > Конфигурация .
- В разделе «Предварительный просмотр ссылок» добавьте или отредактируйте шаблон URL.
- Чтобы настроить предварительный просмотр ссылок для нового шаблона URL, нажмите Добавить шаблон URL .
- Чтобы изменить конфигурацию существующего шаблона URL, нажмите стрелку вниз .
В поле Host pattern введите домен шаблона URL. Приложение Chat будет предварительно просматривать ссылки на этот домен.
Чтобы получить ссылки предварительного просмотра приложения Chat для определенного поддомена, например
subdomain.example.com
, включите поддомен.Чтобы получить ссылки предварительного просмотра приложения Chat для всего домена, укажите подстановочный знак со звездочкой (*) в качестве поддомена. Например,
*.example.com
соответствуетsubdomain.example.com
иany.number.of.subdomains.example.com
.В поле Префикс пути введите путь, который будет добавлен к домену шаблона хоста.
Чтобы сопоставить все URL-адреса в домене шаблона хоста, оставьте префикс пути пустым.
Например, если шаблон хоста —
support.example.com
, для сопоставления URL-адресов для случаев, размещенных по адресуsupport.example.com/cases/
, введитеcases/
.Нажмите Готово .
Нажмите «Сохранить» .
Теперь, когда кто-то добавляет ссылку, соответствующую шаблону URL-адреса предварительного просмотра ссылки, в сообщение в чат-пространстве, включающем ваше приложение Chat, ваше приложение отображает предварительный просмотр ссылки.
Предварительный просмотр ссылки
После настройки предварительного просмотра для определенной ссылки ваше приложение Chat сможет распознавать и предварительно просматривать ссылку, прикрепляя к ней дополнительную информацию.
Внутри пространств чата, включающих ваше приложение чата, когда чье-либо сообщение содержит ссылку, которая соответствует шаблону URL-адреса предварительного просмотра ссылки, ваше приложение чата получает событие взаимодействия MESSAGE
. Полезная нагрузка JSON для события взаимодействия содержит поле matchedUrl
:
JSON
message: {
matchedUrl: {
url: "https://support.example.com/cases/case123"
},
... // other message attributes redacted
}
Проверяя наличие поля matchedUrl
в полезной нагрузке события MESSAGE
, ваше приложение Chat может добавлять информацию в сообщение с предварительно просмотренной ссылкой. Ваше приложение Chat может либо ответить простым текстовым сообщением, либо прикрепить карточку.
Ответить текстовым сообщением
Для базовых ответов ваше приложение Chat может выполнить предварительный просмотр ссылки, ответив простым текстовым сообщением на ссылку. В этом примере прикрепляется сообщение, которое повторяет URL-адрес ссылки, соответствующий шаблону URL-адреса предварительного просмотра ссылки.
Node.js
Питон
Ява
Скрипт приложений
Прикрепите карточку, которая предварительно просматривает ссылку
Чтобы прикрепить карту к предварительно просмотренной ссылке, верните ActionResponse
типа UPDATE_USER_MESSAGE_CARDS
. В этом примере прикрепляется базовая карта.
Node.js
Питон
Ява
Скрипт приложений
Этот пример отправляет сообщение карты, возвращая карту JSON . Вы также можете использовать службу карт Apps Script .
Обновить ссылку предварительного просмотра карты
Ваше приложение Chat может обновлять карточку предварительного просмотра ссылки, когда пользователи взаимодействуют с ней, например, нажимают кнопку на карточке.
Чтобы обновить карточку, ваше приложение чата должно обработать событие взаимодействия CARD_CLICKED
и вернуть actionResponse
в зависимости от того, кто отправил сообщение, содержащее предварительный просмотр ссылки:
- Если сообщение отправил пользователь, установите
actionResponse.type
наUPDATE_USER_MESSAGE_CARDS
. - Если приложение Chat отправило сообщение, установите
actionResponse.type
наUPDATE_MESSAGE
.
Чтобы определить, кто отправил сообщение, вы можете использовать поле message.sender.type
события взаимодействия, чтобы узнать, был ли отправитель HUMAN
или BOT
.
В следующем примере показано, как приложение чата обновляет предварительный просмотр ссылки всякий раз, когда пользователь нажимает кнопку « Назначить мне» , обновляя поле «Назначение» карточки и отключая кнопку.
Node.js
Питон
Ява
Скрипт приложений
Этот пример отправляет сообщение карты, возвращая карту JSON . Вы также можете использовать службу карт Apps Script .
Ограничения и соображения
При настройке предварительного просмотра ссылок для вашего приложения Chat примите во внимание следующие ограничения и соображения:
- Каждое приложение чата поддерживает предварительный просмотр ссылок для 5 шаблонов URL.
- Приложения чата просматривают одну ссылку на сообщение. Если в одном сообщении присутствует несколько ссылок для предварительного просмотра, просматривается только первая ссылка для предварительного просмотра.
- Приложения чата поддерживают предварительный просмотр только ссылок, начинающихся с
https://
, поэтомуhttps://support.example.com/cases/
выполняет предварительный просмотр, аsupport.example.com/cases/
нет. - Если сообщение не содержит другой информации, которая отправляется в приложение Chat, например, команды с косой чертой , то при предварительном просмотре ссылок в приложение Chat отправляется только URL-адрес ссылки.
- Если пользователь публикует ссылку, приложение Chat может обновить карту предварительного просмотра ссылки только в том случае, если пользователи взаимодействуют с картой, например, нажимают кнопку. Вы не можете вызвать метод
update()
API Chat на ресурсеMessage
, чтобы обновить сообщение пользователя асинхронно. - Приложения чата должны предоставлять предварительный просмотр ссылок всем участникам чата, поэтому в сообщении не должно быть поля
privateMessageViewer
.
Предварительный просмотр ссылок отладки
При внедрении предпросмотра ссылок вам может потребоваться отладить приложение Chat, прочитав журналы приложения. Чтобы прочитать журналы, посетите Logs Explorer в консоли Google Cloud.