Форматировать сообщения

На этой странице объясняется, как приложения Google Chat могут форматировать текст для отправки сообщений, содержащих любой из следующих элементов:

• Форматированный текст, содержащий гиперссылки или упоминания (@) одного или всех пользователей в чате.
• Текст, отображаемый в карточном интерфейсе, включая абзацный текст или текст пользовательского интерфейса, который отображается рядом со значком, например, кнопкой.

Отформатировать текстовое сообщение

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

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

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

    {
      "text": "Your pizza delivery *has arrived*!\nThank you for using _Cymbal Pizza!_"
    }

В чате отформатированное текстовое сообщение отображает следующее:

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

Когда пользователь отправляет сообщение, текст сообщения в text поле отображается в виде обычного текста. Некоторое форматирование, применяемое к тексту сообщения с использованием синтаксиса Markdown, также отображается в text поле. Дополнительное форматирование, включая следующее, находится в поле formattedText , предназначенном только для вывода:

• Дополнительный синтаксис Markdown для текста
• Пользователь упоминает
• Пользовательские гиперссылки
• Пользовательские эмодзи

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

Если сообщение было отформатировано с помощью меню «Формат» в интерфейсе чата, то text поле содержит только текст, а поле formattedText — разметку, текст и гиперссылку. В следующем примере показан черновик текстового сообщения со словом, являющимся гиперссылкой, элементами в виде списка и одним выделенным жирным шрифтом словом:

Сообщение получено в следующем формате:

    {
      "text": "I can meet there at:\nNoon\n3 pm\n5 pm\nWhat time works for you?",
      "formattedText": "I can meet <http://example.com|there> at:\n* Noon\n* 3 pm\n* 5 pm\nWhat time works for *you*?",
    }

Форматировать ссылки

Если вы укажете в тексте сообщения обычную ссылку, например, http://www.example.com/ , Google Chat будет использовать её в качестве ссылки и автоматически создаст гиперссылку на указанный URL-адрес.

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

Символ вертикальной черты и текст ссылки являются необязательными, поэтому <https://www.example.com/> и https://www.example.com/ эквивалентны.

Используйте пользовательские эмодзи в текстовых сообщениях

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

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

Чтобы добавить пользовательские эмодзи в текст сообщения, укажите name или emoji_name ресурса customEmoji :

{
    "text": "Hello <customEmojis/CUSTOM_EMOJI_ID>."
}

Чтобы использовать этот пример, замените CUSTOM_EMOJI_ID на идентификатор пользовательского эмодзи. Этот идентификатор можно найти в поле name или emoji_name ресурса customEmoji .

Упомяните пользователей в текстовом сообщении

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

@упоминание конкретных пользователей

Чтобы упомянуть конкретного пользователя с помощью символа @, добавьте в текст сообщения <users/{user}> , где {user} — это идентификатор пользователя. Например, рассмотрим следующее текстовое сообщение, где 123456789012345678901 представляет собой идентификатор пользователя Mahan S.:

{
    "text": "A customer has reported an issue. Assigning ticket #942 to <users/123456789012345678901>."
}

Текст сообщения отображается следующим образом:

Значение users/{user} можно указать следующими способами:

• Если ваше приложение Google Chat отвечает на сообщение, отправленное пользователем, вы можете использовать поле message.sender.name события взаимодействия MESSAGE .

• Если ваше приложение Google Chat создает асинхронное текстовое сообщение , вы можете указать значение для users/{user} следующими способами:

  • Используйте поле name ресурса User Google Chat, например users/123456789012345678901 .
  • Используйте адрес электронной почты пользователя в качестве псевдонима для значения {user} . Например, если адрес электронной почты mahan@example.com , вы можете указать пользователя как users/mahan@example.com . Для использования псевдонима электронной почты ваше приложение Google Chat должно пройти аутентификацию как пользователь .

• При использовании API People вы также можете использовать метод people.get для определения идентификатора пользователя.

@упомянуть всех пользователей

Чтобы создать текстовое сообщение, в котором упоминаются все пользователи в пространстве с помощью символа @, замените {user} на all . В следующем примере JSON упоминаются все пользователи в сообщении:

{
    "text": "Important message for <users/all>: Code freeze starts at midnight tonight!"
}

Форматирование текста, отображаемого на карточках.

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

Используйте конструктор карточек для разработки и предварительного просмотра сообщений и пользовательских интерфейсов для чат-приложений:

Форматирование текста абзаца

Поддерживаемые теги и их назначение указаны в следующей таблице:

Для определения списков и блоков кода используйте следующие теги:

This is a code block.

Маркдаун

Если включен синтаксис Markdown , можно использовать следующий синтаксис:

Добавить значки в текст

Для отображения значков рядом с текстом в карточке можно использовать виджеты DecoratedText и ButtonList .

В следующих разделах объясняется, как использовать встроенные значки, значки Google Material или пользовательские значки в оформленном тексте или кнопках.

Используйте значки из чата.

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

В таблице ниже перечислены встроенные значки, доступные для сообщений в открытках:

Ниже приведён пример карточки со значком электронной почты:

Используйте значки Google Material Design

С помощью иконок Google Material Icons вы можете выбрать из более чем 2500 вариантов и настроить толщину, заливку и оттенок иконок.

Ниже приведён пример карточки со значком Google Material:

Используйте пользовательские значки

Чтобы добавить пользовательскую иконку, укажите поле iconUrl и соответствующий URL-адрес иконки.

Ниже приведён пример пользовательской иконки: