Требования к XML-фиду для новостроек

Перед подготовкой XML-фида ознакомьтесь с требованиями к передаче данных.

  1. Общая информация об объявлении
  2. Информация о продавце
  3. Информация об условиях сделки
  4. Информация об объекте
  5. Описание жилого помещения
  6. Описание здания
  7. Пример корректного YRL-файла

Общая информация об объявлении

У элемента offer есть обязательный атрибут internal-id, который должен быть уникальным для каждого объявления. Internal-id может состоять из цифр, латинских и кириллических букв, знаков. Мы рекомендуем заполнять его номером из вашей базы данных.

<offer internal-id="А1245">
 ...
</offer>

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

Элемент Обязательный элемент Описание
type Да

Тип сделки.

Строго ограниченные значения: «продажа».

property-type Да

Тип недвижимости.

Строго ограниченное значение: «жилая».

category Да

Категория объекта.

Возможные значения:

  • «дом»/«house»

  • «квартира»/«flat»

  • «таунхаус»/«townhouse».

url  

URL страницы с объявлением.

creation-date Да

Дата создания объявления.

Указывается в формате YYYY-MM-DDTHH:mm:ss+00:00.

Внимание. Следите за актуальностью объявлений в фидах и удаляйте объекты, которые уже сданы или проданы. Модерация может заблокировать фид, в котором есть устаревшие объявления.

location Да

Набор элементов, описывающих местоположение объекта.

<location>
      <country/>
      <region/>
      <district/>
      <locality-name/>
      …
 </location>
country Да

Страна, в которой расположен объект.

Примечание. В настоящее время объявления принимаются только для объектов недвижимости, расположенных в Украине.

region  

Название области страны.

district  

Название района области страны.

locality-name  

Название населенного пункта.

sub-locality-name  

Район населенного пункта.

address  

Улица и номер дома.

Номер дома необязательно указывать для загородной недвижимости и земельных участков.

direction  

Шоссе.

Элемент передается только для объектов в Киеве и Киевской области, если есть такой ориентир.

distance  

Расстояние по шоссе до Окружной дороги.

Значение указывается в километрах.

Элемент передается только для объектов в Киеве и Киевской области.

latitude  

Географическая широта.

longitude Отображается на карте R24

Географическая долгота.

metro Отображается на карте R24

Ближайшая станция метро.

Если станций несколько, каждая должна быть указана в отдельном элементе. Во вложенных тегах указывается подробная информация.

<metro>
      <name/>
      <time-on-foot/>
      <time-on-transport/>
</metro>
name  

Название станции метро.

time-on-transport  

Время до метро в минутах на транспорте.

time-on-foot  

Время до метро в минутах пешком.

railway-station  

Ближайшая железнодорожная станция.

Элемент указывается только для загородной недвижимости.

vas  

Дополнительная услуга по продвижению объявления.

Элемент указывается, если к объявлению должна быть применена дополнительная услуга.

Возможные значения:

  • «premium»

  • «raise»

  • «promotion».

Для значения «raise» (услуги «Поднятие») можно применить ежедневное автоподключение в определенное время.

Для этого внутри vas укажите атрибут start-time, дату и время в формате YYYY-MM-DDTHH:mm:ss+00:00 и значение raise.

Пример:
<vas start-time="2018-06-04T10:00:00+03:00">raise</vas>

Должна быть указана дата первого применения услуги. Обновлять атрибут не нужно. Объявление, к которому применена услуга, будет подниматься ежедневно в указанное время.

Внимание. Услуги нельзя подключить к объявлениям без фотографий.

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

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

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

Пример использования тегов <region>, <district> и <sub-locality-name> при описании адреса

<location>
    <country>Украина</country>
    <region>Киевская</region>
    <district>Фастовский</district>
    <locality-name>Боярка</locality-name>
        <sub-locality-name>Центральный</sub-locality-name>
    <address>Пушкинская ул., д. 12</address>
    <direction>Минское шоссе</direction>
</location>

Пример использования тега <metro> при описании городской недвижимости

<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>

Пример использования тегов <direction> и <distance> при описании загородной недвижимости (для Московской области)

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

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

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

Элемент Обязательный элемент Описание
sales-agent Да

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

Во вложенных тегах указывается подробная информация.

<sales-agent>
    <name/>
    <phone/>
    <category/>
    <organization/>
    <url/>
    <photo/>
    …
</sales-agent>
name  

Имя продавца, арендодателя или агента.

phone Да

Номер телефона.

Номер указывается в международном формате.

Пример:
<phone>+380951234567</phone>

Если номеров несколько, каждый из них необходимо передавать в отдельном элементе phone.

Примечание. Для агентств недвижимости обязательно должны быть указаны прямые номера агентов.

category Да

Тип продавца.

Строго ограниченные значения:

  • «агентство»/«agency»

  • «застройщик»/«developer».

organization  

Название организации.

url  

Сайт агентства или застройщика.

email  

Электронный адрес продавца.

photo  

Ссылка на фотографию агента или логотип компании.

Информация об условиях сделки

Элемент Обязательный элемент Описание
deal-status Да

Тип сделки.

Возможные значения:

  • если объект продаёт застройщик:

«первичная продажа»/«продажа от застройщика».
<deal-status>первичная продажа</deal-status>
  • Если право собственности на объект принадлежит не застройщику:

«прямая продажа».

<deal-status>прямая продажа</deal-status>
  • Если объект продаёт частное лицо или агентство, но права собственности ещё нет:

«переуступка»/«reassignment».
<deal-status>переуступка</deal-status>
price Да

Набор элементов, описывающих цену объекта.

<price>
  <value/>
  <currency/>
  <unit/>
  <period/>
</price>
value Да

Цена.

Сумма указывается без пробелов.

Цена должна включать НДС (если он есть) и постоянные эксплуатационные расходы (для коммерческой недвижимости).

currency Да

Валюта, в которой указана цена.

Цену предложения следует передавать только в той валюте, которая указана в объявлении.

Возможные значения:

  • «RUR» или «RUB» (российский рубль)

  • «EUR» (евро)

  • «USD» (американский доллар).

unit  

Единица площади помещения.

Параметр нужно передавать, если цена указана за единицу площади.

Возможные значения: «кв. м»/«sq. m».

Пример передачи данных о цене квартиры

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

Пример передачи данных о цене 1 кв. м.

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

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

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

Элемент Обязательный элемент Описание
image Да

Фотография объекта и планировки.

Можно передавать несколько элементов.

В первом элементе image должны быть фотографии планировки.

Фотографии планировки следует передавать с атрибутом tag. Возможные значения атрибута: plan, plan 3d и т. п.

<image tag="plan">
 ...
</image>
Внимание. В качестве разделителя в значении атрибута используется пробел:
  • 3d plan — фотография будет использована для изображения планировки объекта,

  • 3dplan — не будет.

Если фотографий с атрибутом tag несколько, то для изображения планировки используется первая из них.

Если таких фотографий нет, то фотография для изображения планировки определяется автоматически.

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

area Да

Общая площадь.

Значение и единица измерения площади передаются во вложенных тэгах:

<area>
  <value/>
  <unit/> 
</area>
value  

Площадь.

Указывается числовое значение.

unit  

Единица площади помещения.

Элемент используется, если цена указана за единицу площади.

Возможные значения: «кв. м»/«sq. m».

living-space Да

Жилая площадь.

Во вложенных тегах указывается подробная информация.

<living-space>
   </value>
   </unit>
</living-space>
room-space  

Площадь комнаты.

Количество передаваемых элементов должно соответствовать количеству комнат.

Во вложенных тегах указывается подробная информация.

<room-space>
   </value>
   </unit>
</room-space>

Элемент не используется для студий.

kitchen-space  

Площадь кухни.

<kitchen-space>
   </value>
   </unit>
</kitchen-space>
renovation  

Ремонт.

Возможные значения:

  • «чистовая отделка»

  • «под ключ»

  • «черновая отделка».

     
description  

Дополнительная информация.

Описание в свободной форме.

Пример передачи данных о площадях объекта недвижимости

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

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

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

Элемент Обязательный элемент Описание
new-flat Да

Признак новостройки.

Строго ограниченные значения: «да», «true», «1», «+».

floor Да

Этаж.

Обязательный элемент для агентств недвижимости.

rooms Да

Общее количество комнат в квартире.

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

Элемент не используется для студий.

rooms-type  

Тип комнат.

Возможные значения:

  • «смежные»

  • «раздельные».

apartments  

Апартаменты.

Строго ограниченные значения:

  • «да»/«нет»

  • «true»/«false»

  • «1»/«0»

  • «+»/«-».

studio  

Студия.

Строго ограниченные значения: «да», «true», «1», «+».

Элемент не используется для объектов со свободной планировкой.

open-plan  

Свободная планировка.

Строго ограниченные значения: «да», «true», «1», «+».

Элемент не используется для студий.

balcony  

Тип балкона.

Возможные значения:

  • «балкон»

  • «лоджия»

  • «2 балкона»

  • «2 лоджии»

И т. п.

window-view  

Вид из окон.

Возможные значения:

  • «во двор»

  • «на улицу».

floor-covering  

Покрытие пола.

Возможные значения:

  • «ковролин»

  • «ламинат»

  • «линолеум»

  • «паркет».

bathroom-unit  

Тип санузла.

Возможные значения:

  • «совмещенный»

  • «раздельный»

  • числовое значение (например «2»).

Описание здания

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

Элемент Обязательный элемент Описание
floors-total Да

Общее количество этажей в доме.

building-name Да

Название жилого комплекса.

Передавать нужно только название ЖК.

Пример:

<building-name>Северная жемчужина</building-name>
yandex-building-id Да

Идентификатор жилого комплекса в базе Яндекса.

Нужен чтобы объявления соответствовали правильному корпусу в ЖК.

Будет виден в URL карточки вашего ЖК.

yandex-house-id Да Идентификатор корпуса жилого комплекса в базе Яндекса.

Нужен чтобы объявления соответствовали правильному корпусу в ЖК.

building-state Да

Стадия строительства дома.

Строго ограниченные значения:

  • «built» (дом построен, но не сдан)

  • «hand-over» (сдан в эксплуатацию)

  • «unfinished» (строится)

Если значения built-year и ready-quarter указаны в прошедшем времени, для элемента building-state следует передавать значение hand-over.

built-year Да

Год сдачи (год постройки).

Обязательный элемент для домов (жилищных комплексов), которые были сданы менее 5 лет назад или будут сданы в будущем.

Год необходимо указывать полностью, например — «1996», а не «96».

ready-quarter Да

Квартал сдачи дома.

Строго ограниченные значения: «1», «2», «3», «4».

building-phase  

Очередь строительства.

Возможные значения: «очередь 1», «II очередь», «3» и т. п.

building-type  

Тип дома.

Возможные значения:

  • «кирпичный»

  • «монолит»

  • «панельный».

building-series  

Серия дома.

building-section  

Корпус дома.

Возможные значения: «корпус 1», «корпус А», «дом 3» и т. п.

ceiling-height  

Высота потолков в метрах.

lift  

Наличие лифта.

Строго ограниченные значения:

  • «да»/«нет»

  • «true»/«false»

  • «1»/«0»

  • «+»/«-».

rubbish-chute  

Наличие мусоропровода.

Строго ограниченные значения:

  • «да»/«нет»

  • «true»/«false»

  • «1»/«0»

  • «+»/«-».

guarded-building  

Закрытая территория.

Строго ограниченные значения:

  • «да»/«нет»

  • «true»/«false»

  • «1»/«0»

  • «+»/«-».

parking  

Наличие охраняемой парковки.

Строго ограниченные значения:

  • «да»/«нет»

  • «true»/«false»

  • «1»/«0»

  • «+»/«-».

is-elite  

Элитная недвижимость.

Строго ограниченные значения:

  • «да»/«нет»

  • «true»/«false»

  • «1»/«0»

  • «+»/«-».

Пример корректного YRL-файла

<?xml version="1.0" encoding="UTF-8"?>
<realty-feed xmlns="http://webmaster.yandex.ru/schemas/feed/realty/2010-06">
<generation-date>2015-04-11T12:00:00+04:00</generation-date>
<offer internal-id="15782295">
<type>продажа</type>
<property-type>жилая</property-type>
<category>квартира</category>
<creation-date>2015-04-02T19:00:06+03:00</creation-date>
<location>
  <country>Россия</country>
   <locality-name>Санкт-Петербург</locality-name>
   <address>18-я линия В.О., 32</address>
   <metro>
     <name>Василеостровская</name>
   </metro>
</location>
<price>
  <value>4780000</value>
  <currency>RUR</currency>
</price>
<sales-agent>
  <phone>+7812500400</phone>
  <organization>ЗАО "Застройщик"</organization>
  <url>http://www.developer.ru/</url>
   <category>developer</category>
  <photo>http://www.developer.ru/company/logo</photo>
</sales-agent>
<rooms>2</rooms>
<new-flat>1</new-flat>
<bathroom-unit>раздельный</bathroom-unit>
<balcony>балкон</balcony>
<floor>13</floor>
<floors-total>15</floors-total>
<building-name>Северная фантазия</building-name>
<yandex-building-id>12345</yandex-building-id>
<yandex-house-id>54321</yandex-house-id>
<building-section>Корпус 1</building-section>
<building-state>unfinished</building-state>
<ready-quarter>3</ready-quarter>
<built-year>2018</built-year>
<building-phase>3</building-phase>
<image>http://www.developer.ru/images/plans/000001289.jpg</image>
<description>Продается 2 к. кв., 13 этаж, 15 минут на машине до метро "Василеостровская". Дом комфорт-класса с продуманными планировочными решениями и широким выбором квартир. Внутренний двор «Северной фантазии» выполнен по эксклюзивному дизайн-проекту. В районе постройки нового ЖК развита инфраструктура: школы и детские сады, больница, аптеки магазины, кафе и спортивные центры. Доступны разные условия ипотеки, скидки и зачет жилья.</description>
<area>
  <value>63.00</value>
  <unit>кв. м</unit>
</area>
<living-space>
  <value>50.00</value>
  <unit>кв. м</unit>
</living-space>
<kitchen-space>
  <value>10.00</value>
  <unit>кв. м</unit>
</kitchen-space>
<room-space>
  <value>15</value>
  <unit>кв. м</unit>
</room-space>
<room-space>
  <value>35</value>
  <unit>кв. м</unit>
</room-space>
</offer>
</realty-feed>