Техническое описание XML-файла
В предоставляемом файле XML не допустимо использовать первые 32 ASCII-символа в текстовых полях (исключения — табуляция, перевод строки, возврат каретки). Также стандарт строго требует кодировать в тексте следующие символы:
Кодировка
Кодировка файла — UTF-8.
Заголовок документа
XML-документ должен начинаться со стандартного XML-заголовка с нулевого символа первой строки.
| Символ, который нужно заменить | Код для XML-файла |
|---|---|
| " | " |
| & | & |
| > | > |
| < | < |
| ' | ' |
<?xml version="1.0" encoding="utf-8"?>
Корневой элемент
Корневой элемент XML-фида (realty-feed) должен содержать обязательные атрибуты target="israela.ru" format-version="1" и вложенные элементы offer, в каждом из которых должна находиться информация из одного объявления.
<realty-feed target="israela.ru" format-version="1"> <offer> . . . </offer> ... </realty-feed>
Требования к объявлениям в фиде
- Фид с объявлениями необходимо разместить на своем домене и предоставить в виде URL-ссылки.
- Структура фида должна соответствовать описанному здесь формату
- В фиде надо передавать только те параметры, которые указаны в объявлении. Если в объявлении есть несколько значений одного параметра (например, несколько фотографий), используйте несколько одинаковых тегов.
- Каждое объявление должно быть посвящено одному объекту недвижимости.
- Чтобы добавить новую информацию в объявление, необходимо обновить существующее объявление, но не удалять и не дублировать его. Обновленное объявление должно иметь тот же
internal-id. - В текстах объявлений и в описании характеристик объектов не должно быть HTML-кода.
Рассмотрим структуру правильного фида:
<?xml version="1.0" encoding="UTF-8"?> <realty-feed target="israela.ru" format-version="1"> <offer internal-id="101"> <type>краткосрочная аренда</type> <category>квартира</category> <area> <value>58</value> <unit>кв. м</unit> </area> <rooms>2</rooms> <floor>4</floor> <floors-total>10</floors-total> <location> <region>Хайфский округ</region> <locality-name>Хайфа</locality-name> <sub-locality-name>Бат-Галим</sub-locality-name> <address>ХаАлия ХаШния, 20</address> </location> <sales-agent> <name>Имя агента</name> <phone>+972 XX XXX-XX-XX</phone> <email>example@gmail.com</email> <organization>Название фирмы</organization> </sales-agent> <price> <value>120</value> <currency>USD</currency> </price> <images> <image>http://site.com/upload/photo1.jpg</image> <image>http://site.com/upload/photo2.jpg</image> </images> <title>Заголовок объявления от 15 до 64 символов</title> <description> Подробное описание Вашего объекта недвижимости </description> </offer> </realty-feed>Как видно из примера, в Вашем XML-файле должен быть только один корневой элемент
realty-feed
Внутри этого элемента располагаются теги offer
Каждый объект недвижимости должен заключаться в отдельный блок тегами
<offer internal-id="101"> . . . </offer>
где internal-id - это уникальный идентификатор объекта (только целое число). В вашем фиде не должно быть двух объектов с одинаковым идентификатором.
Обязательные теги
Объявление будет импортировано на нашу доску в том случае, если в вашем XML-фиде заполнены следующие обязательные теги:| XML-тег | Описание тега |
|---|---|
| offer | С этого тега начинается и заканчивается каждый отдельный объект недвижимости. В теге offer должен присутствовать обязательный атрибут internal-id, который должен иметь уникальное числовое значение для каждого объекта. |
| type | Этот тег указывает на тип сделки. Допускается только одно из трёх значений:
|
| category | Этот тег указывает на недвижимости. Допускается только одно из пяти значений:
|
| rooms | Этот тег обязателен только для квартир. В этом теге указывается общее количество комнат (только целое положительное число) |
| location | Обязательный тег, который должен содержать в себе как минимум 1 вложенный тег locality-name |
| locality-name | Обязательный тег, расположенный внутри секции <location> . . . </location> В этом теге должно содержаться название населённого пункта, в котором находится объект недвижимости. Важно! Для корректного импорта названия городов в Вашем XML-фиде должны в точности совпадать с названиями городов на нашем сайте. См. тут - https://www.israela.ru/regions |
| sales-agent | Обязательный тег, внутри которого должно располагаться как минимум два вложенных тега – name и phone |
| name | В данном теге должно быть указано контактное лицо. Сам тег должен находится внутри секции <sales-agent> . . . </sales-agent> |
| phone | В данном теге должен быть указан контактный номер телефона. Сам тег должен находится внутри секции <sales-agent> . . . </sales-agent> |
| image | Каждое объявление должно иметь как минимум одну ссылку на изображение. В тегах <image> . . . </image> должен быть прописан абсолютный путь до фотографии. В объявлении может быть любое количество изображений, но на наш сайт будут импортированы только первые пять штук. |
| description | Подробное текстовое описание Вашего объекта недвижимости |
Необязательные теги
Описанные ниже теги не являются обязательными, но их использование поможет Вам более подробно описать Ваши объекты.| XML-тег | Описание тега |
|---|---|
| area | Данный тег служит для указания общей площади объекта. Значение и единица измерения площади передаются во вложенных тэгах: <area> |
| floor | Этаж, на котором расположена квартира или комната |
| floors-total | Общее количество этажей в здании |
| region | Это вложенный тег внутри секции <location> . . . </location>. Здесь должен быть указан округ Израиля. Важно! Для корректного импорта названия регионов в Вашем XML-фиде должны в точности совпадать с названиями регионов на нашем сайте. См. тут - https://www.israela.ru/regions |
| sub-locality-name | Этот тег также является вложенным в секции location. Здесь можно указать район города. |
| address | Этот тег также является вложенным в секции location. Здесь можно указать адрес объекта недвижимости. |
Этот тег является вложенным в секции sales-agent. Здесь можно указать контактный Email адрес. Если адрес не указан, то все уведомления будут приходить на почту, указанную при отправке фида. | |
| organization | Этот тег является вложенным в секции sales-agent. Здесь можно указать название Вашей организации или торговую марку. |
| price | Набор элементов, описывающих цену объекта. <price>В value допускается целое число без пробелов (стоимость объекта)В currency допускается только одно из 3 значений
|
| title | Здесь Вы можете указать заголовок объявления. (до 64 символов) Если этот тег отсутствует в Вашем фиде, то заголовок объявления сгенерируется автоматически из имеющихся данных. Хотя данный тег является необязательным, мы всё-таки рекомендуем Вам использовать его, ведь заголовок является очень важным маркетинговым инструментом. Здесь можно указать Важнейшие преимущества вашего объекта, например "... с видом на море" или "... 5 минут пешком до моря" и т.д. |