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

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

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

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

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

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

Формат Символ Пример синтаксиса Текст, отображаемый в Google Chat
Смелый * *привет* привет
Курсив _ (подчеркивание) _привет_ привет
Зачеркивание ~ ~привет~ привет
Моноширинный ` (обратная цитата) `привет` hello
Моноширинный блок ` ` ` (три обратные кавычки) ```
Привет
Мир
```
Hello
World
Маркированный список * или - (дефис) с последующим пробелом

* Это первый пункт в списке

* Это второй пункт в списке

  • Это первый пункт в списке.
  • Это второй пункт в списке.
Гиперссылка <hyperlink|display text> <https://example.com|Example website>

Пример веб-сайта

Дополнительную информацию о гиперссылках см. в разделе Форматирование ссылок .

Упоминание пользователя <users/{user}> , где {user} — идентификатор пользователя. <users/123456789012345678901>

@Махан С

Дополнительную информацию об упоминании пользователей см. в разделе Упоминание пользователей в текстовом сообщении .

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

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

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

Приложение 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*?",
    }

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

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

Пример синтаксиса Текст, отображаемый в Google Chat
<https://example.com|Example website>

Вертикальная черта и текст ссылки необязательны, поэтому <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 должно пройти аутентификацию как user .
  • Если вы используете API People, вы также можете использовать метод people.get для определения идентификатора пользователя.

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

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

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

Форматировать текст, отображаемый на карточках

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


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

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

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

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

Формат Пример Результат визуализации
Смелый "This is <b>bold</b>." Это смело .
Курсив "This is <i>italics</i>." Это курсив .
Подчеркнуть "This is <u>underline</u>." Это подчеркивание .
Зачеркивание "This is <s>strikethrough</s>." Это зачеркивание .
Цвет шрифта "This is <font color=\"#FF0000\">red font</font>." Это красный шрифт .
Гиперссылка "This is a <a href=\"https://www.google.com\">hyperlink</a>." Это гиперссылка .
Время "This is a time format: <time>2023-02-16 15:00</time>." Это формат времени: .
Новая строка "This is the first line. <br> This is a new line. » Это первая строка.
Это новая линия.

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

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

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

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

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

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

САМОЛЕТ ЗАКЛАДКА
АВТОБУС МАШИНА
ЧАСЫ CONFIRMATION_NUMBER_ICON
ОПИСАНИЕ ДОЛЛАР
ЭЛЕКТРОННАЯ ПОЧТА МЕРОПРИЯТИЕ_МЕСТО
ПРИБЫТИЕ_РЕЙСА РЕЙС_ВЫЛЕТ
ОТЕЛЬ ТИП_НОМЕР_ОТЕЛЯ
ПРИГЛАШАТЬ MAP_PIN
ЧЛЕНСТВО НЕСКОЛЬКО_ЛЮДЕЙ
ЧЕЛОВЕК ТЕЛЕФОН
РЕСТОРАН_ИКОНКА КОРЗИНА
ЗВЕЗДА МАГАЗИН
БИЛЕТ ТРЕНИРОВАТЬСЯ
ВИДЕО_КАМЕРА ВИДЕО_ВОСПРОИЗВЕДЕНИЕ

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

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

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

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

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

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

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

,

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

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

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

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

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

Формат Символ Пример синтаксиса Текст, отображаемый в Google Chat
Смелый * *привет* привет
Курсив _ (подчеркивание) _привет_ привет
Зачеркивание ~ ~привет~ привет
Моноширинный ` (обратная цитата) `привет` hello
Моноширинный блок ` ` ` (три обратные кавычки) ```
Привет
Мир
```
Hello
World
Маркированный список * или - (дефис) с последующим пробелом

* Это первый пункт в списке

* Это второй пункт в списке

  • Это первый пункт в списке.
  • Это второй пункт в списке.
Гиперссылка <hyperlink|display text> <https://example.com|Example website>

Пример веб-сайта

Дополнительную информацию о гиперссылках см. в разделе Форматирование ссылок .

Упоминание пользователя <users/{user}> , где {user} — идентификатор пользователя. <users/123456789012345678901>

@Махан С

Дополнительную информацию об упоминании пользователей см. в разделе Упоминание пользователей в текстовом сообщении .

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

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

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

Приложение 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*?",
    }

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

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

Пример синтаксиса Текст, отображаемый в Google Chat
<https://example.com|Example website>

Вертикальная черта и текст ссылки необязательны, поэтому <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 должно пройти аутентификацию как user .
  • Если вы используете API People, вы также можете использовать метод people.get для определения идентификатора пользователя.

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

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

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

Форматировать текст, отображаемый на карточках

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


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

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

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

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

Формат Пример Результат визуализации
Смелый "This is <b>bold</b>." Это смело .
Курсив "This is <i>italics</i>." Это курсив .
Подчеркнуть "This is <u>underline</u>." Это подчеркивание .
Зачеркивание "This is <s>strikethrough</s>." Это зачеркивание .
Цвет шрифта "This is <font color=\"#FF0000\">red font</font>." Это красный шрифт .
Гиперссылка "This is a <a href=\"https://www.google.com\">hyperlink</a>." Это гиперссылка .
Время "This is a time format: <time>2023-02-16 15:00</time>." Это формат времени: .
Новая строка "This is the first line. <br> This is a new line. » Это первая строка.
Это новая линия.

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

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

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

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

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

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

САМОЛЕТ ЗАКЛАДКА
АВТОБУС МАШИНА
ЧАСЫ CONFIRMATION_NUMBER_ICON
ОПИСАНИЕ ДОЛЛАР
ЭЛЕКТРОННАЯ ПОЧТА МЕРОПРИЯТИЕ_МЕСТО
ПРИБЫТИЕ_РЕЙСА РЕЙС_ВЫЛЕТ
ОТЕЛЬ ТИП_НОМЕР_ОТЕЛЯ
ПРИГЛАШАТЬ MAP_PIN
ЧЛЕНСТВО НЕСКОЛЬКО_ЛЮДЕЙ
ЧЕЛОВЕК ТЕЛЕФОН
РЕСТОРАН_ИКОНКА КОРЗИНА
ЗВЕЗДА МАГАЗИН
БИЛЕТ ТРЕНИРОВАТЬСЯ
ВИДЕО_КАМЕРА ВИДЕО_ВОСПРОИЗВЕДЕНИЕ

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

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

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

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

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

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

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