Технические требования
Экспорт данных для размещения заголовков и аннотаций новостей на сервисе осуществляется в XML-based формате RSS 2.0. Кодировка указывается в экспортном файле.
Для лучшего понимания вы можете ознакомиться с примером экспортного файла.
Механизм экспорта данных
Чтобы передавать информацию о новостных сообщениях, разместите RSS-файл на сервере вашего сайта и обновляйте его с необходимой периодичностью (например, файл может пополняться в течение дня и перезаписываться утром). Робот скачивает файл от двух до пяти минут.
Чтобы робот Яндекса (Yandex или YandexNews) проиндексировал данные, откройте для него (или, по крайней мере, не закрывайте) доступ к RSS-файлу и страницам сайта, ссылки на которые в файле передаются. Прописывать отдельно доступ к каждой странице сайта не нужно. Достаточно, чтобы доступ к разделу с этими страницами либо к URL с определенным паттерном не был запрещен.
Вы также можете задать параметры индексирования данных, указав поддерживаемые роботом Яндекса директивы в файле robots.txt.
User-agent: YandexNews
Allow: путь до экспортного файла без имени хоста (например, /file.rss)
...
#последняя строка должна быть пустой
Проверить корректность добавления строк можно в Яндекс Вебмастере.
Если вы используете в robots.txt директиву Crawl-delay, укажите ее для робота YandexNews отдельно.
User-agent: YandexNews
Allow: /file.rss
Crawl-delay: 0.1
...
#последняя строка должна быть пустой
Описание элементов RSS 2.0
Корневым элементом RSS-файла является rss
, атрибут version
которого должен иметь значение 2.0.
<rss
xmlns:yandex="http://news.yandex.ru"
xmlns:media="http://search.yahoo.com/mrss/"
version="2.0">
...
</rss>
Внутри элемента rss
содержится элемент channel
, который включает информацию об источнике и его содержание.
Элементы, из которых состоит экспортный файл, подробно описаны ниже.
Информация о сайте-источнике
Сведения передаются в элементе channel
. Обязательные элементы отмечены значком .
Элемент | Описание |
---|---|
title | Название RSS-канала. Если экспортируется содержание целого сайта, укажите название сайта. Если экспортируются раздел сайта, укажите название сайта и раздела через двоеточие. Примечание. На главной странице название RSS-канала не показывается, экспортируемые данные маркируются тем названием источника, которое было указано в анкете при подключении к сервису Новости. |
link | Домен сайта, данные которого транслируются. |
description | Описание канала одним предложением. Не используйте HTML-разметку. |
language | Язык статьи по стандарту ISO 639-1. |
item ![]() | Информация о странице и ее содержимом. Каждый Для передачи новостных сообщений в
|
Элемент | Описание |
---|---|
title | Название RSS-канала. Если экспортируется содержание целого сайта, укажите название сайта. Если экспортируются раздел сайта, укажите название сайта и раздела через двоеточие. Примечание. На главной странице название RSS-канала не показывается, экспортируемые данные маркируются тем названием источника, которое было указано в анкете при подключении к сервису Новости. |
link | Домен сайта, данные которого транслируются. |
description | Описание канала одним предложением. Не используйте HTML-разметку. |
language | Язык статьи по стандарту ISO 639-1. |
item ![]() | Информация о странице и ее содержимом. Каждый Для передачи новостных сообщений в
|
Информация о сообщении
Данные передаются в элементе item
. Обязательные элементы отмечены значком .
Элемент | Описание |
---|---|
title ![]() | Заголовок сообщения. Элемент Максимальная длина заголовка — 200 символов. Запрещено:
|
link ![]() | URL страницы-источника. Требования:
|
pubDate ![]() | Время публикации сообщения на сайте источника. Передается в формате RFC-822. Время, указанное в экспортном файле, должно совпадать с фактическим временем публикации на сайте. Актуальными считаются сообщения за последние 8 дней. Остальные проиндексированы не будут. |
author | Автор сообщения. |
yandex:full-text ![]() | Текст новости. Элемент В элементе
|
pdalink | Ссылка на версию сообщения, адаптированную для мобильных устройств. Чтобы в Новостях была доступна мобильная версия сообщения, передайте в элементе pdalink ссылку на соответствующее сообщение в мобильной версии сайта источника.
|
amplink | Ссылка на AMP-версию сообщения. Ссылки на страницы в формате AMP, если они присутствуют в вашем экспортном файле, будут использоваться в версии Новостей для устройств с тачскрином вместо ссылок на обыкновенные мобильные и адаптивные страницы. Чтобы передавать AMP-версии новостей, укажите в элементе |
description | Краткое описание сообщения (аннотация, лид). |
yandex:genre | Жанр сообщения. Указывается латиницей:
|
category | Рубрика (раздел, категория). Указывается оригинальное (как в издании) название рубрики, в которой опубликовано сообщение. Одному сообщению может соответствовать только одна рубрика. Внимание. Об изменении рубрикации издания или о добавлении в экспортный файл материалов новых рубрик необходимо сообщать по адресу info-news@dzen.ru. Иначе сообщения, относящиеся к ранее не существовавшим или переименованным рубрикам издания, проиндексированы не будут. |
enclosure | Иллюстрации, аудио и видеофайлы. В одном элементе указывается ссылка на одну иллюстрацию, аудио или видеофайл. Если в сообщении содержится несколько иллюстраций, или иллюстрация и видеофайл, используйте несколько элементов Требования к иллюстрациям:
Для изображений параметр |
media:group | Группа связанных медиаобъектов. Можно указать любое количество элементов Элемент
В
Внимание. Элемент media:group обязательно должен содержать media:thumbnail , а также хотя бы один элемент media:content либо media:player . Использовать все три элемента не требуется. |
yandex:theme_tags | Признак сообщения, относящегося к теме на сайте партнера. В качестве значения должен быть указан произвольный идентификатор события, продублированный в JSON-файле с темами. |
Элемент | Описание |
---|---|
title ![]() | Заголовок сообщения. Элемент Максимальная длина заголовка — 200 символов. Запрещено:
|
link ![]() | URL страницы-источника. Требования:
|
pubDate ![]() | Время публикации сообщения на сайте источника. Передается в формате RFC-822. Время, указанное в экспортном файле, должно совпадать с фактическим временем публикации на сайте. Актуальными считаются сообщения за последние 8 дней. Остальные проиндексированы не будут. |
author | Автор сообщения. |
yandex:full-text ![]() | Текст новости. Элемент В элементе
|
pdalink | Ссылка на версию сообщения, адаптированную для мобильных устройств. Чтобы в Новостях была доступна мобильная версия сообщения, передайте в элементе pdalink ссылку на соответствующее сообщение в мобильной версии сайта источника.
|
amplink | Ссылка на AMP-версию сообщения. Ссылки на страницы в формате AMP, если они присутствуют в вашем экспортном файле, будут использоваться в версии Новостей для устройств с тачскрином вместо ссылок на обыкновенные мобильные и адаптивные страницы. Чтобы передавать AMP-версии новостей, укажите в элементе |
description | Краткое описание сообщения (аннотация, лид). |
yandex:genre | Жанр сообщения. Указывается латиницей:
|
category | Рубрика (раздел, категория). Указывается оригинальное (как в издании) название рубрики, в которой опубликовано сообщение. Одному сообщению может соответствовать только одна рубрика. Внимание. Об изменении рубрикации издания или о добавлении в экспортный файл материалов новых рубрик необходимо сообщать по адресу info-news@dzen.ru. Иначе сообщения, относящиеся к ранее не существовавшим или переименованным рубрикам издания, проиндексированы не будут. |
enclosure | Иллюстрации, аудио и видеофайлы. В одном элементе указывается ссылка на одну иллюстрацию, аудио или видеофайл. Если в сообщении содержится несколько иллюстраций, или иллюстрация и видеофайл, используйте несколько элементов Требования к иллюстрациям:
Для изображений параметр |
media:group | Группа связанных медиаобъектов. Можно указать любое количество элементов Элемент
В
Внимание. Элемент media:group обязательно должен содержать media:thumbnail , а также хотя бы один элемент media:content либо media:player . Использовать все три элемента не требуется. |
yandex:theme_tags | Признак сообщения, относящегося к теме на сайте партнера. В качестве значения должен быть указан произвольный идентификатор события, продублированный в JSON-файле с темами. |
Официальный комментарий
Данные передаются в элементе item
.
Элемент | Описание |
---|---|
yandex:official-comment | Официальный комментарий. Разметку официального комментария необходимо сделать в основном экспортном файле для Новостей. Длина комментария не должна быть больше 300 знаков с пробелами, можно использовать сокращения вида ... или <...>, не нужно оформлять комментарий как прямую речь или брать в кавычки. Текст комментария обязательно должен присутствовать на вашем сайте в новости.
|
Элемент | Описание |
---|---|
yandex:official-comment | Официальный комментарий. Разметку официального комментария необходимо сделать в основном экспортном файле для Новостей. Длина комментария не должна быть больше 300 знаков с пробелами, можно использовать сокращения вида ... или <...>, не нужно оформлять комментарий как прямую речь или брать в кавычки. Текст комментария обязательно должен присутствовать на вашем сайте в новости.
|
Видео в сюжетах
Чтобы показывать видео в сюжетах, добавьте ссылки на видеоролики в формате mp4 в экспортный файл для Новостей. Если у вас нет возможности передавать ссылки на mp4-файлы, видео можно загрузить на ваш канал на Дзене и указать в экспортном файле ссылки на плеер с загруженными роликами.
См. требования к содержанию видео.
Разместите ссылки на видео к новостям в вашем экспортном файле для Новостей, указав их в элементах media:content
внутри элемента media:group
. Ссылки должны вести на видеофайлы в формате mp4, а не на страницы с ними и не на плеер. Если в ссылке нет явно указанного расширения файла, используйте атрибут type
и пропишите тип файла в нем.
<media:group>
<media:content
url="ссылка на видеофайл в формате .mp4"
type="video/mp4"/>
<media:thumbnail
url="ссылка на иллюстрацию для preview не менее 800 × 400 пикселей"/>
</media:group>
- Создайте канал в Дзене.
- Загрузите видео на канал. Убедитесь, что видео загружено.
- Используйте код вставки вида https://dzen.ru/embed в теге
media:player
внутри элементовmedia:group
.<media:group> <media:player url="ссылка вида https://dzen.ru/embed....."> </media:player> <media:thumbnail url="ссылка на иллюстрацию для preview не менее 800 × 400 пикселей"> </media:thumbnail> </media:group>
Символы и кодировки
В экспортном файле укажите кодировку, отдаваемую вашим сервером. Наиболее часто используются: UTF-8, Windows-1251, KOI8-R.
Во всех элементах channel
и item
необходимо кодировать следующие символы:
Символ | Название | Код замены |
---|---|---|
& | Амперсанд | & |
> | Правая угловая скобка | > |
< | Левая угловая скобка | < |
" | Знак кавычек | " |
' | Апостроф | ' |
Символ | Название | Код замены |
---|---|---|
& | Амперсанд | & |
> | Правая угловая скобка | > |
< | Левая угловая скобка | < |
" | Знак кавычек | " |
' | Апостроф | ' |
Например, ссылка http://some.host.ru/?id=1&page=10 должна быть приведена к виду http://some.host.ru/?id=1&page=10.
Если RSS-файл передается в KOI8-R, необходимо также заменить встречающиеся в тексте символы кодировки Windows-1251 на аналоги из KOI8-R:
Символ | Название | Код замены |
---|---|---|
... | Многоточие | 133 |
– | Короткое тире (en-dash) | 150 |
— | Длинное тире (em-dash) | 151 |
' ' | «Сглаженные» апострофы | 145 и 146 |
" " | «Сглаженные» кавычки — «лапки» | 147 и 148 |
«» | Кавычки «ёлочки» | 171 и 187 |
№ | Номер | 185 |
Символ | Название | Код замены |
---|---|---|
... | Многоточие | 133 |
– | Короткое тире (en-dash) | 150 |
— | Длинное тире (em-dash) | 151 |
' ' | «Сглаженные» апострофы | 145 и 146 |
" " | «Сглаженные» кавычки — «лапки» | 147 и 148 |
«» | Кавычки «ёлочки» | 171 и 187 |
№ | Номер | 185 |
Пример экспортного файла
<?xml version="1.0" encoding="windows-1251"?>
<rss
xmlns:yandex="http://news.yandex.ru"
xmlns:media="http://search.yahoo.com/mrss/"
version="2.0">
<channel>
<title>Российские новости</title>
<link>http://www.rossiyskie-novosti.ru/</link>
<description>Ежедневная московская газета</description>
<item>
<title>Яндекс ищет на сайте Минприроды</title>
<link>http://www.rossiyskie-novosti.ru/2023/03/25/yandex.html</link>
<pdalink>http://www.m.rossiyskie-novosti.ru/2023/03/25/yandex.html</pdalink>
<description>Яндекс.Site установлен на сайте Минприроды</description>
<author>Иван Петров</author>
<category>Технологии</category>
<enclosure
url="http://www.rossiyskie-novosti.ru/2023/03/25/yandex.jpg"
type="image/jpeg"/>
<media:group>
<media:content
url="ссылка на видеофайл в формате .mp4 на вашем сайте"
type="video/mp4"/>
<media:thumbnail
url="ссылка на иллюстрацию для preview не менее 800 × 400 пикселей"
</media:group>
<pubDate>Sun, 29 Sep 2023 19:59:01 +0300</pubDate>
<yandex:genre>message</yandex:genre>
<yandex:full-text>Для поиска по сайту www.mnr.gov.ru выбрана программа Яндекс.Site.
Этот программный продукт был исследован провайдером сайта Минприроды —
Федеральным агентством правительственной связи и информации. ФАПСИ сочло
возможным использование поисковой системы <Яндекса> на www.mnr.gov.ru.
По результатам исследования программа была скомпилирована, протестирована и
установлена на сайт.</yandex:full-text>
</item>
</channel>
</rss>