Разметка для писем

После того, как вы получили идентификатор компании и подключились к платежной системе, можно разметить письма с помощью 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", 
  "name": "MailRu", 
  "legalName":"Mail Group",
  "logo": "https://img.imgsmail.ru/pm/mail.ru.png"
},

@typeУкажите "Organization"CONST
nameВаш уникальный идентификатор: краткое название, которое отображается в интерфейсеREQUIRED
legalNameОфициальное название компанииOPTIONAL
logoСсылка на логотип компании для карточки.OPTIONAL
accountIdИдентификатор пользователя услуг в вашей компании (например, номер абонента)REQUIRED"accountId": "user12345"
minimumPaymentDueМинимальная сумма для оплаты.OPTIONAL

"minimumPaymentDue": {
  "@type": "PriceSpecification", 
  "price": "100",
  "priceCurrency": "RUB"
},

@typeУкажите "PriceSpecification"CONST
priceСумма. Поддерживаются форматы 1450 или 1450.50, если нужно использовать копейкиREQUIRED
priceCurrencyВалюта. По умолчанию — рубли.REQUIRED
totalPaymentDue
Полная сумма для оплатыREQUIRED

"totalPaymentDue": {
  "@type": "PriceSpecification", 
  "price": "400.50", 
  "priceCurrency": "RUB"
},

@typeУкажите "PriceSpecification"CONST
priceСумма. Поддерживаются форматы 1450 или 1450.50, если нужно использовать копейкиREQUIRED
priceCurrencyВалютаREQUIRED
descriptionНазначение платежа. Пользователь увидит назначение в интерфейсе. Например, Абонентская плата за апрель 2018OPTIONAL "description": "Абонентская плата за апрель 2018",
paymentDueКрайний срок оплаты в формате ISO 8601CONST"paymentDue": "2050-01-01T00:00:00+03:00",
customerДанные о плательщикеOPTIONAL

"customer": { 
  "@type": "Person",
  "name": "Федорова В.В.", 
  "address": "Алтаский край, г. Барнаул, Солнечная поляна, д. 43, к. 72",
  "telephone": "+79254273486"
},

@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 pxOPTIONAL"image": "https://previews.com/preview1"

Пример разметки для письма

<script type="application/ld+json">
{
    "@context": "http://schema.org",
    "@type": "Invoice",
    "provider": { (*)
        "@type": "Organization",
        "name": "MailRu",
        "legalName":"Mail 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",
  "name": "MailRuGames",
  "legalName": "Официальное название организации" 

@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",  
  "itemOffered": {
    "@type": "Product",
    "name": "Gothic 3", 
    "url": "https://games.mail.ru/play/game/gothic3/", 
    "image": "https://games.mail.ru/019.jpeg" 
},
  "price": "249.99",
  "priceCurrency": "RUB", 
  "eligibleQuantity": { 
    "@type": "QuantitativeValue",
    "value": "1"
  }
},

@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"
  },
  "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>
Помощь Mail
Обновлено 22 ноября 2021 г.
Была ли эта информация полезной?

Помощь по другим проектам

icon