Документация формата YAL
Yandex Realty XML - формат передачи данных для каталогов недвижимости
Введение
YAL (Yandex Realty XML) - это XML-формат, разработанный Яндексом для передачи данных о недвижимости. Формат используется для интеграции каталогов недвижимости с сервисами Яндекса.
- Стандартизированная структура данных
- Поддержка различных типов недвижимости
- Гибкая система фильтрации и поиска
- Интеграция с картами Яндекса
Структура XML файла
<?xml version="1.0" encoding="UTF-8"?>
<realty-feed xmlns="http://webmaster.yandex.ru/schemas/feed/realty/2010-06">
<generation-date>2024-01-15T12:00:00+03:00</generation-date>
<offer internal-id="12345">
<!-- Данные объекта недвижимости -->
</offer>
<offer internal-id="12346">
<!-- Данные объекта недвижимости -->
</offer>
<!-- Другие объекты -->
</realty-feed>
| Элемент | Описание | Обязательный |
|---|---|---|
realty-feed |
Корневой элемент фида | Да |
generation-date |
Дата и время генерации фида | Да |
offer |
Объект недвижимости | Да |
Обязательные поля для объекта
| Поле | Тип | Описание | Пример |
|---|---|---|---|
type |
string | Тип операции | продажа, аренда |
category |
string | Категория недвижимости | квартира, дом, коммерческая |
location |
object | Локация объекта | - |
price |
object | Цена и валюта | - |
area |
object | Общая площадь | - |
rooms |
integer | Количество комнат | 1, 2, 3 |
Структура элемента offer
<offer internal-id="12345">
<type>продажа</type>
<category>квартира</category>
<creation-date>2024-01-15T10:00:00+03:00</creation-date>
<location>...</location>
<price>...</price>
<area>...</area>
<living-space>...</living-space>
<kitchen-space>...</kitchen-space>
<rooms>2</rooms>
<floor>5</floor>
<floors-total>9</floors-total>
</offer>
Элемент location
<location>
<country>Россия</country>
<region>Московская область</region>
<locality-name>Москва</locality-name>
<address>ул. Примерная, д. 123</address>
<latitude>55.755826</latitude>
<longitude>37.617300</longitude>
</location>
| Поле | Обязательный | Описание |
|---|---|---|
country |
Да | Страна |
locality-name |
Да | Населенный пункт |
address |
Да | Адрес |
latitude |
Нет | Широта |
longitude |
Нет | Долгота |
Элемент price
<price>
<value>15000000</value>
<currency>RUB</currency>
</price>
| Поле | Обязательный | Описание | Допустимые значения |
|---|---|---|---|
value |
Да | Стоимость объекта | число > 0 |
currency |
Да | Валюта | RUB, USD, EUR |
Элементы площадей
<area>
<value>65.5</value>
<unit>кв. м</unit>
</area>
<living-space>
<value>42.3</value>
<unit>кв. м</unit>
</living-space>
<kitchen-space>
<value>15.2</value>
<unit>кв. м</unit>
</kitchen-space>
| Элемент | Обязательный | Описание |
|---|---|---|
area |
Да | Общая площадь объекта |
living-space |
Нет | Жилая площадь |
kitchen-space |
Нет | Площадь кухни |
Информация о здании
<building-name>ЖК "Примерный"</building-name>
<building-section>Корпус 1</building-section>
<built-year>2023</built-year>
<ready-quarter>4</ready-quarter>
<building-state>built</building-state>
<yandex-building-id>123456</yandex-building-id>
| Поле | Обязательный | Описание |
|---|---|---|
building-name |
Нет | Название ЖК |
built-year |
Нет | Год постройки |
building-state |
Нет | Состояние объекта |
Дополнительные поля
<description>Просторная квартира с ремонтом...</description>
<image>https://example.com/photo1.jpg</image>
<image tag="plan">https://example.com/plan.jpg</image>
<balcony>1 лоджия и 1 балкон</balcony>
<bathroom-unit>2</bathroom-unit>
<window-view>На улицу</window-view>
<new-flat>1</new-flat>
<apartments>false</apartments>
<deal-status>продажа от застройщика</deal-status>
Медиа-контент
image- фотографии объектаimage tag="plan"- планировкаdescription- описание
Характеристики
balcony- балконы/лоджииbathroom-unit- санузлыwindow-view- вид из оконnew-flat- новостройка
Полный пример объекта
<?xml version="1.0" encoding="UTF-8"?>
<realty-feed xmlns="http://webmaster.yandex.ru/schemas/feed/realty/2010-06">
<generation-date>2024-01-15T12:00:00+03:00</generation-date>
<offer internal-id="12345">
<type>продажа</type>
<creation-date>2024-01-15T10:00:00+03:00</creation-date>
<category>квартира</category>
<location>
<country>Россия</country>
<locality-name>Москва</locality-name>
<region>Московская область</region>
<address>ул. Примерная, д. 123</address>
<latitude>55.755826</latitude>
<longitude>37.617300</longitude>
</location>
<price>
<value>15000000</value>
<currency>RUB</currency>
</price>
<sales-agent>
<category>developer</category>
<url>https://developer.example.com</url>
<phone>+7 800 123-45-67</phone>
<email>info@example.com</email>
</sales-agent>
<area>
<value>65.5</value>
<unit>кв. м</unit>
</area>
<living-space>
<value>42.3</value>
<unit>кв. м</unit>
</living-space>
<kitchen-space>
<value>15.2</value>
<unit>кв. м</unit>
</kitchen-space>
<image>https://example.com/photo1.jpg</image>
<image tag="plan">https://example.com/plan.jpg</image>
<description>
Просторная 2-комнатная квартира в новом ЖК...
</description>
<last-update-date>2024-01-15T11:30:00+03:00</last-update-date>
<property-type>жилая</property-type>
<deal-status>продажа от застройщика</deal-status>
<rooms>2</rooms>
<floor>5</floor>
<floors-total>9</floors-total>
<building-name>ЖК "Примерный"</building-name>
<building-section>Корпус 1</building-section>
<built-year>2023</built-year>
<ready-quarter>4</ready-quarter>
<building-state>built</building-state>
<balcony>1 лоджия и 1 балкон</balcony>
<bathroom-unit>2</bathroom-unit>
<window-view>На улицу</window-view>
<new-flat>1</new-flat>
<apartments>false</apartments>
</offer>
</realty-feed>
Валидация данных
Общие правила
- Кодировка файла: UTF-8
- Формат дат: ISO 8601
- Максимальный размер файла: 50 МБ
- Обновление данных: не реже 1 раза в сутки
Требования к данным
- Уникальные internal-id
- Корректные координаты
- Актуальные цены
- Доступные изображения
Коды состояний объекта
| Код | Описание |
|---|---|
built |
Сданный дом |
construction |
Строящийся дом |
unfinished |
Незавершенное строительство |
project |
Проект |
Часто задаваемые вопросы
Ответы на популярные вопросы о формате YAL и интеграции
XML формат и интеграция
Ключевые преимущества для застройщиков:
Автоматизация процессов
Единовременная настройка интеграции позволяет автоматически обновлять данные во всех подключенных каталогах без ручного ввода.
Широкая дистрибуция
Данные одновременно публикуются на множестве площадок: Яндекс.Недвижимость, партнерские сайты, агрегаторы.
Увеличение охвата аудитории
Публикация на крупных площадках значительно увеличивает видимость объектов и привлекает больше потенциальных клиентов.
Экономия времени
Сокращение времени на публикацию объектов с часов до минут. Обновления цен и статусов происходят мгновенно.
Технические преимущества:
- Стандартизация данных - единый формат для всех площадок
- Масштабируемость - легко добавить новые площадки
- Централизованное управление - все изменения в одном месте
- Автоматическая валидация - система проверяет корректность данных
- Поддержка медиа-контента - фото, планировки, панорамы
- Геолокация - точное отображение на картах
Как начать работу?
1. Изучите документацию формата YAL
2. Подготовьте XML файл по шаблону
3. Загрузите файл в наш каталог
4. Получите уведомление о публикации
Для успешной публикации объектов в XML файле должны присутствовать следующие обязательные поля:
| Поле | Описание | Пример |
|---|---|---|
type |
Тип операции | продажа, аренда |
category |
Категория недвижимости | квартира, дом, коммерческая |
location |
Локация объекта | — |
price |
Цена и валюта | — |
area |
Общая площадь | — |
Полный список полей и их описание смотрите в разделе "Обязательные поля" выше.
Рекомендуемая частота обновления XML файла зависит от активности изменений в ваших объектах:
Минимальные требования:
- Ежедневно - при активных продажах
- 1-2 раза в неделю - стандартный режим
- При каждом изменении - цены, статусы
Что обновлять:
- Цены и акции
- Статусы объектов (свободно/продано)
- Добавление новых объектов
- Изменение описаний