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

+7 (495) 973-83-87, 988-76-07
[email protected]
www.domex.ru
Технические требования к XML-фиду
Требования к фиду
1.
2.
3.
4.
5.
6.
7.
В фиде должны передаваться все актуальные объявления.
В данных не допускается присутствие HTML-тегов.
URL фида должен быть постоянным и доступным по протоколу HTTP (в разделе «Вопросы и ответы » есть
инструкция, как можно ограничить доступ к фиду).
URL объявления должен быть постоянным. Объявления, поступающие от Партнёров через фиды, должны
обновляться, а не удаляться и создаваться заново.
Если для объявления есть несколько значений одного параметра (например, несколько фото), то нужно
передавать несколько одинаковых тегов.
Цену объявления надо передавать только в той валюте, которую указал владелец объявления.
В фиде надо передавать только те параметры, которые ввел податель объявления (например, если
геокоординаты и/или время до метро и/или метро вычисляются автоматически, передавать их не надо).
Если для объявления нет какого-то параметра (податель объявления не указал этот параметр при
размещении), то не надо передавать соответствующий тег.
Описание формата фида
Заголовок документа (XML header)
<?xml version="1.0" encoding="utf-8"?>
Стандартный XML-заголовок. Заголовок должен начинаться с первой строки, с нулевого символа.
Документ должен содержать корневой элемент realty-feed.
Фид должен быть в кодировке UTF-8.
Элемент realty-feed
<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 — содержит информацию о дате и времени создания данного файла
+7 (495) 973-83-87, 988-76-07
[email protected]
www.domex.ru
Формат даты
Формат даты 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>
У элемента <offer> есть обязательный атрибут internal-id — id объявления в базе партнера (в
вашей базе).
Обязательные элементы отмечены символом «*».
Элементы, содержащие текстовые поля с пометкой «строго ограниченные значения », должны
содержать только те значения, которые указаны. Использование других значений будет считаться
ошибкой.
Элементы Описание
type*
тип сделки («продажа», «аренда»)
propertytype*
тип недвижимости (рекомендуемое значение — «жилая»)
category*
категория объекта («комната», «квартира», «дом», «участок», «таунхаус», «часть дома», «дом с
участком», «дача», «земельный участок», «коттедж», «офис», «участок», «земельный участок»,
«склад», «общепит» , «торговое помещение», «готовый бизнес», «свободного назначения», «гараж»).
url *
URL страницы с объявлением
creationdate*
дата создания объявления формат даты такой же, как в поле generation-date
last-updatedate
дата последнего обновления объявления формат даты такой же, как в поле generation-date
expire-date
дата и время, до которых объявление актуально формат даты такой же, как в поле generation-date
location*
набор тегов, описывающих местоположение объекта
country*
Страна
region
Название области (Московская область)
district
для России — название района субъекта РФ, для Белорусии, Казахстана, Украины — название района
области
locality-name название города
address
улица, дом
+7 (495) 973-83-87, 988-76-07
[email protected]
www.domex.ru
direction
шоссе (только для Москвы)
distance
расстояние по шоссе до МКАД (указывается в км)
latitude
географические координаты (широта)
longitude
географические координаты (долгота)
metro
ближайшая станция метро (если таковых несколько, каждый указывается в отдельном теге)
name
название станции метро
В зависимости от типа недвижимости (городская или загородная) обязательны разные параметры,
описывающие адрес.
Пример использования тегов <region>, <district> и <sub-locality-name> при передаче данных о местоположении
объекта недвижимости:
<location>
<country>Россия</country>
<region>Московская область</region>
<district>Одинцовский район</district>
<locality-name>Одинцово</locality-name>
<address>Пушкинская ул., д. 12</address>
<direction>Минское шоссе</direction>
</location>
Пример использования тега <metro> при передаче данных о продаже/сдаче в аренду городской недвижимости:
<location>
<country>Россия</country>
<locality-name>Санкт-Петербург</locality-name>
<address>Измайловский пр., 16</address>
<metro>
<name>Технологический институт</name>
</metro>
</location>
Пример использования тегов <direction> и <distance> при передаче данных о продаже/сдаче в аренду
загородной недвижимости (для Москвы)
<location>
<country>Россия</country>
<region>Московская область</region>
<district>Истринский район</district>
<locality-name>Истра</locality-name>
<direction>Рублево-Успенское шоссе</direction>
<distance>10</distance>
</location>
+7 (495) 973-83-87, 988-76-07
[email protected]
www.domex.ru
Информация о продавце
Элементы Описание
sales-agent* информация о продавце
name
имя агента/продавца
phone*
телефон агента/продавца:(каждому тегу соответствует один номер телефона, если номеров несколько,
каждый из них необходимо передавать в отдельном теге phone)
category
тип продавца (строго ограниченные значения — «владелец», «агентство», «owner», «agency»)
organization название агентства
agency-id
внутренний ID агентства в базе партнера
url
сайт агентства
email
электронный адрес продавца
Информация о сделке
Элементы Описание
price*
Стоимость
value*
цена (сумма указывается без пробелов)
currency*
валюта, в которой измеряется стоимость ( «RUR», «EUR», «USD»)
period
в случае сдачи недвижимости в аренду — промежуток времени (рекомендуемые значения — «день»,
«месяц»)
unit
единица площади (рекомендуемые значения — «кв. м», «га», «cот»)
Пример передачи данных о стоимости квартиры:
<price>
<value>4000000</value>
<currency>RUR</currency>
</price>
Пример передачи данных о стоимости 1 кв.м.:
<price>
<value>60000</value>
<currency>RUR</currency>
<unit>кв.м</unit>
</price>
Пример передачи данных о стоимости аренды объекта недвижимости сроком на 1 месяц:
<price>
<value>700</value>
<currency>USD</currency>
<period>месяц</period>
</price>
Информация об объекте
Элементы Описание
image
фотография (может быть несколько тегов)
description
дополнительная информация (описание в свободной форме, оставленное подателем объявления)
area
общая площадь
value
площадь (числовое значение)
unit
единица площади (рекомендуемые значения — «кв. м»)
+7 (495) 973-83-87, 988-76-07
[email protected]
www.domex.ru
Пример передачи данных о площадях объекта недвижимости
<area>
<value>56</value>
<unit>кв.м</unit>
</area>
Пример передачи данных о площади участка
<lot-area>
<value>15</value>
<unit>сот</unit>
</lot-area>
Описание жилого помещения
Элементы
Описание
rooms*
общее количество комнат в квартире
rooms-offered* для продажи и аренды комнат: количество комнат, участвующих в сделке
floor
этаж
floors-total
общее количество этажей в доме
Обязательные поля
Для городской недвижимости обязательны следующие параметры:





country (страна);
region (субъект РФ [область]);
district (обязателен для городов, находящихся в областях субъектов РФ);
locality-name (название города);
address (улица или улица и дом)
Для загородной недвижимости обязательны следующие поля:




country (страна);
region (субъект РФ);
district (район субъекта РФ)
locality- name (название ближайшего города)
direction (шоссе — для Москвы)
+7 (495) 973-83-87, 988-76-07
[email protected]
www.domex.ru
Пример XML Файла
<?xml version="1.0" encoding="UTF-8"?>
<realty-feed xmlns="http://webmaster.yandex.ru/schemas/feed/realty/2010-06">
<generation-date>2001-12-31T12:00:00+04:00</generation-date>
<!-- Минимальный набор полей -->
<!-- Квартира на вторичном рынке -->
<offer internal-id="1245">
<type>продажа</type>
<property-type>жилая</property-type>
<category>квартира</category>
<url>http://yandex.ru/1/</url>
<creation-date>2010-10-13T12:32:45+04:00</creation-date>
<location>
<country>Россия</country>
<locality-name>Москва</locality-name>
<address>Яузская улица</address>
</location>
<sales-agent>
<phone>8-495-589-8013</phone>
</sales-agent>
<rooms>1</rooms>
</offer>
<!-- Комната/комнаты -->
<offer internal-id="3">
<type>продажа</type>
<property-type>жилая</property-type>
<category>комната</category>
<url>http://yandex.ru/1/</url>
<creation-date>2010-11-13T12:32:45+04:00</creation-date>
<location>
<country>Россия</country>
<region>Ленинградская область</region>
<district>Выборгский район</district>
<locality-name>Выборг</locality-name>
<address>улица сторожевой башни, 2</address>
</location>
<sales-agent>
<phone>8-910-428-5459</phone>
<category>владелец</category>
</sales-agent>
<rooms>1</rooms>
</offer>
<!-- Загород -->
<offer internal-id="4">
<type>продажа</type>
<property-type>жилая</property-type>
<category>коттедж</category>
<url>http://yandex.ru/1/</url>
<creation-date>2010-10-20T12:32:45+04:00</creation-date>
<location>
<country>Россия</country>
<locality-name>Москва</locality-name>
<address>Льва Толстого</address>
</location>
<sales-agent>
<phone>8-495-220-3206</phone>
<category>владелец</category>
<name>Иван Иваныч</name>
</sales-agent>
<rooms>1</rooms>
</offer>
<!-- Максимальный набор полей -->
<offer internal-id="2357">
+7 (495) 973-83-87, 988-76-07
[email protected]
www.domex.ru
<type>продажа</type>
<property-type>жилая</property-type>
<category>дом с участком</category>
<url>http://anrd.ru/component/option,com_estateagent/act,object/task,showEO/id,436/</url>
<creation-date>2010-12-05T00:00:00+04:00</creation-date>
<expire-date>2011-12-12T00:00:00+04:00</expire-date>
<last-update-date>2010-12-12T00:00:00+04:00</last-update-date>
<location>
<country>Россия</country>
<region>Тверская область</region>
<district>Вышневолоцкий район</district>
<locality-name>г.Вышний Волочек</locality-name>
</location>
<sales-agent>
<name>Алексей</name>
<phone>8-903-808-00-53</phone>
<category>агентство</category>
<organization>Агентство недвижимости РУССКИЙ ДОМ</organization>
<url>http://anrd.ru/</url>
<email>[email protected]</email>
</sales-agent>
<price>
<value>2300000</value>
<currency>RUR</currency>
</price>
<image>http://anrd.ru/components/com_estateagent/pictures/ea1279882313.jpg</image>
<image>http://anrd.ru/components/com_estateagent/pictures/ea1279882363.jpg</image>
<image>http://anrd.ru/components/com_estateagent/pictures/ea1279882395.jpg</image>
<image>http://anrd.ru/components/com_estateagent/pictures/ea1279882424.jpg</image>
<image>http://anrd.ru/components/com_estateagent/pictures/ea1279882615.jpg</image>
<image>http://anrd.ru/components/com_estateagent/pictures/ea1279882707.jpg</image>
<image>http://anrd.ru/components/com_estateagent/pictures/ea1279882762.jpg</image>
<description>Тверская область, г.Вышний Волочек ( От МКАД 320км — по асфальтированной дороге.)
Продаю дом 80 кв.м с земельным участком 7 соток.
В доме — вода, газовое отопление, электричество. 3 комнаты, кухня, ванная, туалет.
Земельный участок разработан. На участке — гараж, баня, хоз.постройки.
</description>
<area>
<value>80</value>
<unit>кв.м</unit>
</area>
<lot-area>
<value>7</value>
<unit>cот.</unit>
</lot-area>
<rooms>3</rooms>
</offer>
</realty-feed>