Разметка для писем
После того, как вы получили идентификатор компании и подключились к платежной системе, можно разметить письма с помощью JSON-LD. Мы подготовили для вас специальный валидатор разметки со встроенными шаблонами.
Заполните шаблон данными из письма и проверьте на ошибки. Полученную разметку оберните тегом <script> и поместите внутри тега <body> в HTML-коде письма.
Описание параметров разметки для типа Invoice
В этой таблице мы описываем параметры для разметки писем виде «Invoice» — писем для выставленного счета. Все параметры делятся на три типа:
- CONST — зарезервированная константа: этот параметр нужно вставить без изменений, как показано в нашем примере, в то же место и с тем же значением;
- REQUIRED — обязательный параметр, для которого вы сами указываете значение;
- OPTIONAL — необязательный параметр.
| Параметр | Описание | Тип | Пример | ||
| @context | Контекст описания объекта | CONST | "@context": "http://schema.org" | ||
| @type | Тип описываемого объекта, в данном случае — invoice (выставленный счёт на оплату) | CONST | "@type": "Invoice" | ||
| provider | Объект, содержащий информацию о компании выставившей счёт | REQUIRED |
"provider": { |
||
| @type | Укажите "Organization" | CONST | |||
| name | Ваш уникальный идентификатор: краткое название, которое отображается в интерфейсе | REQUIRED | |||
| legalName | Официальное название компании | OPTIONAL | |||
| logo | Ссылка на логотип компании для карточки. | OPTIONAL | |||
| accountId | Идентификатор пользователя услуг в вашей компании (например, номер абонента) | REQUIRED | "accountId": "user12345" | ||
| minimumPaymentDue | Минимальная сумма для оплаты. | OPTIONAL |
"minimumPaymentDue": { |
||
| @type | Укажите "PriceSpecification" | CONST | |||
| price | Сумма. Поддерживаются форматы 1450 или 1450.50, если нужно использовать копейки | REQUIRED | |||
| priceCurrency | Валюта. По умолчанию — рубли. | REQUIRED | |||
| totalPaymentDue |
Полная сумма для оплаты | REQUIRED |
"totalPaymentDue": { |
||
| @type | Укажите "PriceSpecification" | CONST | |||
| price | Сумма. Поддерживаются форматы 1450 или 1450.50, если нужно использовать копейки | REQUIRED | |||
| priceCurrency | Валюта | REQUIRED | |||
| description | Назначение платежа. Пользователь увидит назначение в интерфейсе. Например, Абонентская плата за апрель 2018 | OPTIONAL | "description": "Абонентская плата за апрель 2018", | ||
| paymentDue | Крайний срок оплаты в формате ISO 8601 | CONST | "paymentDue": "2050-01-01T00:00:00+03:00", | ||
| customer | Данные о плательщике | OPTIONAL |
"customer": { |
||
| @type | Укажите "Person" | ||||
| name | Имя в любом формате | OPTIONAL | |||
| address | Адрес плательщика | OPTIONAL | |||
| telephone | Телефон плательщика | OPTIONAL | |||
| billingPeriod | Период выставленного счёта в указанном формате, месяц и день могут быть опущены, т.е. строки "2018", "2018-12" являются валидными | OPTIONAL | "billingPeriod": "2018-10-28" |
||
| url | Ссылка на заказ, продукт или объект счёта на внешнем ресурсе (например, ссылка на скачивание pdf-файла со счётом) | OPTIONAL | "url": "https://www.omfgdogs.com/test?usr=123" | ||
| image | Ссылка на превью картинки. Рекомендуемое разрешение — 630×380 px | OPTIONAL | "image": "https://previews.com/preview1" | ||
Пример разметки для письма
<script type="application/ld+json">{ "@context": "http://schema.org", "@type": "Invoice", "provider": { (*) "@type": "Organization", "name": "MailRu", "legalName":"Mail.Ru Group", "logo": "https://img.imgsmail.ru/pm/1.0.4/blocks/ph-logo/img/logotype-mail.ru.png" }, "accountId": "user12345", "minimumPaymentDue": { "@type": "PriceSpecification", "price": "100", "priceCurrency": "RUB" }, "totalPaymentDue": { "@type": "PriceSpecification", "price": "400.50", "priceCurrency": "RUB" }, "description": "Абонентская плата за апрель 2018", "paymentDue": "2018-10-28T08:00:00+03:00", "customer": { "@type": "Person", "name": "Федорова В.В.", "address": "Алтайский край, г. Барнаул, Солнечная поляна, д.43, к.72", "telephone": "+79254273486" }, "billingPeriod": "2018-10-28T08:00:00+03:00", "url" : "https://www.omfgdogs.com/test?usr=123", "image": "https://previews.com/preview1" }</script> |
Описание параметров разметки для типа Order
В этой таблице мы описываем параметры для разметки писем виде «Order» — писем о заказе или брошенной корзине. Все параметры делятся на три типа:
- CONST — зарезервированная константа: этот параметр нужно вставить без изменений, как показано в нашем примере, в то же место и с тем же значением;
- REQUIRED — обязательный параметр, для которого вы сами указываете значение;
- OPTIONAL — необязательный параметр.
| Параметр | Описание | Тип | Пример | |||
| @context | Контекст описания объекта | CONST | "@context": "http://schema.org" | |||
| @type | Тип описываемого объекта, в данном случае — invoice (выставленный счёт на оплату) | CONST | "@type": "Order" | |||
| merchant | Объект описывающий компанию, приславшую брошенную корзину | REQUIRED |
"merchant": { |
|||
| @type | Укажите "Organization" | CONST | ||||
| name | Ваш уникальный идентификатор: краткое название, которое отображается в интерфейсе | REQUIRED | ||||
| legalName | Официальное название компании | OPTIONAL | ||||
| orderNumber | Номер заказа, определяет платёжную транзакцию | REQUIRED | "orderNumber": "123-4567890-1234567" | |||
| priceCurrency | Валюта | REQURED | "priceCurrency": "RUB" | |||
| price | Общая сумма заказа | REQURED | "price": "539.00" | |||
| acceptedOffer | Детальное описание брошенной корзины | REQUIRED |
"acceptedOffer": { |
|||
| @type | Укажите "Offer" | CONST | ||||
| itemOffered | Параметры брошенной корзины | REQUIRED | ||||
| @type | Укажите "Product" | CONST | ||||
| name | Наименование заказа в брошенной корзине | REQUIRED | ||||
| url | Ссылка на корзину | OPTIONAL | ||||
| image | Ссылка на превью-картинку заказа | OPTIONAL | ||||
| price | Цена корзины (Совпадает с общей суммой заказа) | REQUIRED | ||||
| priceCurrency | Валюта | REQUIRED | ||||
| eligibleQuantity | Укажите как показано ниже | CONST | ||||
| @type | Укажите "QuantitativeValue" | CONST | ||||
| value | Укажите "1" | CONST | ||||
| url | Ссылка на корзину | OPTIONAL | "url": "https://games.mail.ru/play/game/order/123-4567890-1234567" | |||
Пример разметки для письма
<script type="application/ld+json">{ "@context": "http://schema.org", "@type": "Order", "merchant": { "@type": "Organization", "name": "MailRuGames", "legalName":"Игры Mail.ru" }, "orderNumber": "123-4567890-1234567", "priceCurrency": "RUB", "price": "539.00", "acceptedOffer": { "@type": "Offer", "itemOffered": { // (*) "@type": "Product", "name": "Gothic 3", "url": "https://games.mail.ru/play/game/gothic3/", "image": "https://games.mail.ru/pre_310x0_resize/pic/play/game2/picture/2017/8/1ade4ca5a019.jpeg" }, "price": "249.99", // (*) "priceCurrency": "RUB", // (*) "eligibleQuantity": { // (*) "@type": "QuantitativeValue", "value": "1" // (*) } }, "url": "https://games.mail.ru/play/game/order/123-4567890-1234567"}</script> |