Импорт и экспорт шаблона сообщения
Данный функционал позволяет загрузить в платформу или выгрузить на своё устройство шаблон сообщения. Это может быть шаблон как для одного канала, так и для нескольких сразу. Для экспорта и импорта используется файл в формате zip.
Соответствующие кнопки доступны в окне редактирования шаблона в правом верхнем углу:
— импортировать шаблон
— экспортировать шаблон
Импорт шаблона
Чтобы импортировать шаблон в платформу, нажмите на иконку . Далее кликните на область загрузки и выберите файл в формате zip на своём устройстве.
О переносе шаблона из стороннего сервиса читайте в этой статье.
Настройте импорт:
-
Выберите каналы, для которых необходимо импортировать шаблон (Email, SMS, Push).
-
Разрешите конфликты импорта. Конфликты возникают, если импортируемые данные и данные, которые уже сохранены в платформе, отличаются. В таблице показаны старое и новое значение. Если вы хотите обновить данные, установите галочку в колонке "Заменить".
Нажмите Принять, чтобы запустить процесс импорта.
Структура zip-файла
Для импорта используется файл в формате zip. Архив должен иметь определенную структуру:
<catalog_name>/
<channel_name>/
<fieldname>.<type>
<attach>/
<fileid>/
<filename>
images/
<image_name>
template.json
Описание структуры:
| Элемент | Пример | Описание |
|---|---|---|
| <catalog_name> | template_newsletter | Корневая директория. Можно использовать произвольное название. |
| <channel_name> | email sms push | Директория содержит данные шаблона для определенного канала отправки. Название директории должно соответствовать каналу. Поддерживается импорт Email, SMS и Push шаблонов. Информацию о том, какие файлы можно импортировать для каждого канала, вы найдете здесь. |
| images | image_1.png | Директория для хранения изображений. |
| template.json | — | Файл содержит общие данные о шаблоне (ссылка на динамический JSON контент, дополнительные настройки, фрагменты и части). Более подробную информация вы найдете ниже. |
Пример zip-файла
Начиная с версии 68, изображения могут храниться на одном уровне с HTML-файлом или в папке с одним из следующих названий: images, image, img, imgs, pictures, pics. Архив с таким email-шаблоном не должен содержать файлы text.txt, subject.txt, template.json, так как их наличие может вызывать ошибки при импорте.
Базовая структура для email-канала
template_123/
email/
html.html
text.txt
subject.txt
images/
image_1.jpeg
template.json
Полная структура для всех каналов
template_123/
email/
html.html
text.txt
subject.txt
amp.txt
is_amp.txt
is_not_inline.txt
from_email.txt
from_name.txt
replyto_email.txt
replyto_name.txt
attach/
023f-ad8c-4412-9bba-16ac/
attach_file.zip
sms/
sms.txt
add_sms_url_scheme.txt
push/
title.txt
body.txt
click_url.txt
icon.txt
is_rich_push.txt
images/
image_1.jpeg
image_2.jpeg
template.json
Пути к изображениям в HTML
Для корректного отображения картинок в импортируемом шаблоне используйте относительные пути, соответствующие структуре архива.
Убедитесь, что пути в атрибуте src соответствуют фактическому расположению файлов в архиве.
Рекомендуемая структура:
template_name
├── email
│ └── html.html
└── images
└── banner.png
Пример корректного пути в HTML:
<img src="../images/banner.png" alt="Баннер">
Не создавайте папку images одновременно в корне и внутри папки канала — это может привести к конфликтам при импорте
Описание полей для каждого канала
Email
| Файл | Пример | Описание |
|---|---|---|
| html.html | <html>Hello, world!</html> | HTML-версия письма |
| text.txt | Hello, world! | Текстовая версия письма |
| subject.txt | Лучшие новинки 2022 | Тема письма |
| amp.txt | <html>Hello, world!</html> | AMP HTML версия письма |
| is_amp.txt | false | Есть ли в шаблоне amp-версия |
| is_not_inline.txt | true | Не конвертировать CSS в inline |
| from_email.txt | awesome@example.com | Email отправ ителя |
| from_name.txt | Awesome Books | Имя отправителя |
| replyto_email.txt | reply_awesome@example.com | Обратный Email |
| replyto_name.txt | Awesome Books | |
| attach (директория) | 023f-ad8c-4412-9bba-16ac/ attach_file.pdf | Директория для хранения прикрепленных файлов. Содержит дополнительные директории, в каждой из которых хранится отдельный файл. Дополнительным директориям можно давать произвольные имена. |
SMS
| Файл | Пример | Описание |
|---|---|---|
| sms.txt | Hello, world! | Текст сообщения |
| add_sms_url_scheme.txt | true | Добавлять "http://" в ссылки |
Push
| Файл | Пример | Описание |
|---|---|---|
| title.txt | Лучшие новинки 2022 | Заголовок уведомления |
| body.txt | Hello, world! | Текст уведомления |
| click_url.txt | https://example.com/ | Ссылка для перехода по клику |
| icon.txt | https://example.com/images/test.jpg | URL-адрес, по которому расположена иконка для уведомления |
| is_rich_push.txt | false | Использование rich-версии для push сообщения |
| <platform>.json | <html>Hello, world!</html> | Данные по шаблону для определенного браузера или ОС (при использовании rich push) |
Файл template.json
С помощью файла template.json можно загрузить данные, которые отображаются в блоках "Опции" и "Контент".
Пример template.json
{
"json_url": "https://altkraft.com/example/RU_content.json",
"suppress_id": 1,
"is_unsub_to_supp": true,
"field_overrides": {
"lead": {
"_fname": "клиент"
}
},
"parts": []
}
Описание полей в template.json
| Поле | Пример | Обязательный | Описание |
|---|---|---|---|
| json_url | "https://altkraft.com/example/content.json" | Нет | URL для динамического JSON-контента |
| suppress_id | 1 | Нет | Идентификатор стоп-списка |
| is_unsub_to_supp | true | Нет | Добавлять отписавшихся в прикрепленный стоп-список |
| field_overrides | { | Нет | Значения полей, если пустые |
| parts | [ | Нет | Части шаблона |
Вы можете экспортировать любой готовый шаблон из своего аккаунта, чтобы получить наглядный пример zip-архива для импорта.