Описание формата YRL

YRL (Yandex Realty Language) — стандарт, разработанный Яндексом для приема и публикации объявлений о продаже и аренде недвижимости в базе данных Яндекс.Недвижимость. YRL основан на стандарте XML (Extensible Markup Language).

Общие замечания по формату (необходимо учитывать при создании файлов в стандарте YRL)

Стандарт XML не допускает наличие символов с ASCII-кодами в диапазоне значений от 0 до 31 (за исключением значений 9, 10, 13 — табуляция, перевод строки, возврат каретки) в текстовых полях. Также этот стандарт строго требует заменять в тексте все следующие символы.

Для замены специальных символов в строках и удаления из строк недопустимых символов можно воспользоваться функцией checkxmlchars()

Требования к фиду

1. В фиде должны передаваться все актуальные объявления.
2. В данных не допускается присутствие HTML-тегов.
3. URL фида должен быть постоянным и доступным по протоколу HTTP (в разделе «Вопросы и ответы » есть инструкция, как можно ограничить доступ к фиду).
4. URL объявления должен быть постоянным. Объявления, поступающие от Партнёров через фиды, должны обновляться, а не удаляться и создаваться заново.
5. Если для объявления есть несколько значений одного параметра (например, несколько фото), то нужно передавать несколько одинаковых тегов.
6. Цену объявления надо передавать только в той валюте, которую указал владелец объявления.

7. В фиде надо передавать только те параметры, которые ввел податель объявления (например, если геокоординаты и/или время до метро и/или метро вычисляются автоматически, передавать их не надо).

   Если для объявления нет какого-то параметра (податель объявления не указал этот параметр при размещении), то не надо передавать соответствующий тег.

Описание формата фида

<?xml version="1.0" encoding="utf-8"?>

Стандартный XML-заголовок. Заголовок должен начинаться с первой строки, с нулевого символа.

Документ должен содержать корневой элемент realty-feed.

Фид должен быть в кодировке UTF-8.

<realty-feed xmlns="http://webmaster.yandex.ru/schemas/feed/realty/2010-06">
     <generation-date>2010-10-05T16:36:00+04:00 </generation-date>
		...
</realty-feed>

Элемент realty-feed должен содержать следующие элементы:

• xmlns="http://webmaster.yandex.ru/schemas/feed/realty/2010-06" — способ указать namespace в xml ( http://en.wikipedia.org/wiki/XML_Namespace)
• generation-date — содержит информацию о дате и времени создания данного файла

Формат даты

Формат даты YYYY-MM-DDTHH:mm:ss+04:00. Стандартный формат ISO 8601 (http://en.wikipedia.org/wiki/ISO_8601)

Дата и время создания файла на стороне доски объявлений.

YYYY — год

MM — месяц

DD — день

HH — час

mm — минута

ss — секунда

+ 04:00 — указание часового пояса (в данном случае — для Москвы).

Партнер обязан следить за изменением формата даты при переводе часов.

У элемента <offer> есть обязательный атрибут internal-id — id объявления в базе партнера (в вашей базе).

Обязательные элементы отмечены символом «*».

Элементы, содержащие текстовые поля с пометкой «строго ограниченные значения », должны содержать только те значения, которые указаны. Использование других значений будет считаться ошибкой.

В зависимости от типа недвижимости (городская или загородная) обязательны разные параметры, описывающие адрес.

<location>
	<country>Россия</country>
	<region>Московская область</region>
	<district>Одинцовский район</district>
	<locality-name>Одинцово</locality-name>
        <sub-locality-name>Центральный</sub-locality-name>
	<adress>Пушкинская ул., д. 12</adress>
	<direction>Минское шоссе</direction>
</location>

<location>
   	<country>Россия</country>
   	<locality-name>Санкт-Петербург</locality-name>
   	<sub-locality-name>Адмиралтейский</sub-locality-name>
   	<address>Измайловский пр., 16</address>
   	<metro>
      	<name>Технологический институт</name>
      	<time-on-foot>10</time-on-foot>
      	<time-on-transport>5</time-on-transport>
   	</metro>
</location>

<location>
   	<country>Россия</country>
   	<region>Московская область</region>
   	<district>Истринский район</district>
   	<locality-name>деревня Подушкино</locality-name>
   	<direction>Рублево-Успенское шоссе</direction>
   	<distance>10</distance>
</location>

Информация о продавце

Информация о сделке

<price>
	<value>4000000</value>
   	<currency>RUR</currency>
</price>

<price>
   	<value>60000</value>
   	<currency>RUB</currency>
   	<unit>кв.м</unit>
</price>

<price>
	<value>700</value>
	<currency>USD</currency>
	<period>месяц</period>
</price>

Информация об объекте

<area>
	<value>56</value>
	<unit>кв.м</unit>
</area>
<living-space>
	<value>36</value>
	<unit>кв.м</unit>
</living-space>
<kitchen-space>
	<value>8</value>
	<unit>кв.м</unit>
</kitchen-space>

<lot-area>
	<value>15</value>
	<unit>сот</unit>
</lot-area>

Описание жилого помещения

Для загородной недвижимости

Партнер обязуется передавать максимальный набор параметров для каждого объявления (в том числе теги manually-added и payed-adv) — в файле должны отражаться все параметры, указанные в объявлении на сайте.

Количество передаваемых параметров влияет на релевантность объявления. Релевантность влияет на показы объявлений и количество получаемого трафика на сайт партнера.

В зависимости от типа недвижимости (городская или загородная) обязательны разные параметры, описывающие адрес (поля, отмеченные символом «*», обязательны для всех объявлений).

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

• country (страна);
• region (субъект РФ, не нужно для Москвы и Санкт-Петербурга);
• district (обязателен для городов, находящихся в областях субъектов РФ);
• locality-name (название населенного пункта);
• address (улица или улица и дом)
  или
  metro и time-on-... (метро и время до него).

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

• country (страна);
• region (субъект РФ);
• district (район субъекта РФ)
  или
  locality- name (название населенного пункта)
  или
  direction (шоссе — для Москвы)
  или
  railway-station (ближайшая ж/д станция).

Пример YRL-файла можно посмотреть на соответствующей странице