Описание YML - Adlabs.Retail

advertisement
http://retail.adlabs.ru
Описание ХML
ХML — это стандарт для принятия и размещения информации в базе данных Retail Adlabs. Единый формат представления данных
позволяет быстро и качественно обрабатывать предоставляемую магазинами информацию о товарах.
Настройте экспорт информации о товарах из вашей базы данных в ХML-файл или используйте CMS со встроенными
возможностями экспорта данных в формат ХML. Разместите файл на сайте вашего магазина по URL, который указывается при
создании магазина в Личном кабинете на http://retail.adlabs.ru. ХML-файл регулярно скачивается роботом и обновленные данные
импортируются в базу Retail Adlabs.
Чтобы легко и быстро подготовить ХML-файл и выгрузить данные в сервис по подбору товаров, руководствуйтесь приведенными
ниже положениями.
Общие требования к ХML-файлу
1.
Стандарт ХML учитывает порядок следования элементов, поэтому важно соблюдать его в соответствии с примером.
2.
Стандарт ХML не допускает использования в текстовых данных непечатаемых символов с ASCII-кодами в диапазоне
значений от 0 до 31 (за исключением символов с кодами 9, 10, 13 — табуляция, перевод строки, возврат каретки). Это
требует обязательной замены некоторых символов на эквивалентные им символьные коды:
Символ в тексте
Код для ХML-файла
"
"
&
&
>
>
<
&lt;
'
&apos;
XML header
Это стандартный XML-заголовок со ссылкой на файл описания формата. Заголовок должен начинаться с первой строки, с нулевого
символа.
Пример:
<?xml version="1.0" encoding=" windows-1251"?>
<yml_catalog>
Любой XML-документ может содержать только один корневой элемент - <yml_catalog>. Атрибут date элемента < yml_catalog>
должен соответствовать дате и времени генерации YML-файла на стороне магазина. Дата должна иметь формат YYYY-MM-DD
hh:mm.
1
http://retail.adlabs.ru
Пример:
<yml_catalog date="2010-04-01 17:00">
<shop>
...
</shop>
</yml_catalog>
<shop>
Элемент <shop> содержит описание магазина и его товарных предложений.
Пример:
<shop>
<name>BestShop</name>
<company>Best online seller Inc.</company>
<currencies> ... </currencies>
<categories> ... </categories>
<offers> ... </offers>
</shop>
Магазин описывается следующими элементами:
Элемент
Описание
<name>
Короткое название магазина. Оно не должно содержать более 20 символов. Название магазина должно совпадать с
фактическим названием магазина, которое публикуется на сайте.
Полное наименование компании, владеющей магазином. Не публикуется, используется для внутренней идентификации.
<company>
<currencies>
Элемент <currencies> задает список курсов валют магазина. Каждая из валют описывается отдельным элементом <currency>.
Данные о ценах принимаются в рублях (RUR, RUB), гривнах (UAH), белорусских рублях (BYR), тенге (KZT), долларах (USD) и евро
(EUR). В Шоуруме цены отображаются в рублях. Если в вашем ХML-файле не задан курс для отображаемой валюты, то
используется курс Центрального Банка страны, к которой относится регион пользователя. Применяется курс, установленный на
текущий день. Курс обновляется ежедневно в 00.00.
Пример:
<currencies>
<currency id="RUR" rate="1"/>
<currency
<currency
<currency
<currency
</currencies>
id="USD"
id="EUR"
id="UAH"
id="KZT"
rate="23.98"/>
rate="CBRF"/>
rate="NBU"/>
rate="CB"/>
Параметр id элемента <currency> указывает код одной или нескольких валют, которые могут быть использованы в ХML-файле.
Параметр rate указывает курс валюты к курсу основной валюты, взятой за единицу (валюта, для которой rate="1"). Параметр rate
может иметь следующие значения:

Постоянное число — внутренний курс, который вы используете.
2
http://retail.adlabs.ru

CBRF — курс по Центральному банку РФ.

NBU — курс по Национальному банку Украины.

NBK — курс по Национальному банку Казахстана.

СВ — курс по банку той страны, к которой относится магазин по своему региону, указанному в партнерском интерфейсе.
В качестве основной валюты (для которой установлено rate="1") могут быть использованы только рубль (RUR, RUB), белорусский
рубль (BYR), гривна (UAH) или тенге (KZT).
Обратите внимание!
В качестве разделителя целой и дробной частей любых чисел в ХML независимо от региональных установок используется точка
(не запятая!).
<categories>
В элементе <categories> содержится список категорий магазина. Каждая категория описывается отдельным элементом <category>.
Описание категории должно включать ее идентификатор (параметр id) для всех категорий и идентификатор категории более
высокого уровня для подкатегорий. Идентификатор категории должен быть уникальным положительным целым числом. Ни у одной
категории параметр id не может быть равен «0». Если элемент <parentId> не указан, то категория считается корневой.
Параметры:

id — идентификатор вашей категории товаров.

parentId — идентификатор более высокой по иерархии (родительской) категории товаров.
Пример:
<categories>
<category id="1">Женская одежда</category>
<category id="2" parentId="1">Платья</category>
<category id="3" parentId="1">Юбки</category>
<category id="4">Женская обувь</category>
<category id="5" parentId="4">Балетки</category>
<category id="6">Аксессуары</category>
<category id="7">Мужские сумки</category>
</categories>
<offers>
В элементе <offers> содержится список товарных предложений магазинов. Каждое товарное предложение описывается отдельным
элементом <offer>.
<offers>
<offer>...</offer>
...
</offers>
<offer id="1">
<vendor>Dolce&Gabbana</vendor>
<model>Сарафан</model>
<categoryId>1</categoryId>
<description>Описание товара</description>
<url>http://shop.ru/sarafan</url>
<price>2000</price>
<oldprice>3000</oldprice>
<picture>http://shop.ru/images/uploads/sarafan.jpg</picture>
<picture>http://shop.ru/images/uploads/sarafan_2.jpg</picture>
<currencyId>1</currencyId>
<attrs>
<sizetype>RUS</sizetype>
<size>40</size>
3
http://retail.adlabs.ru
<size>42</size>
<size>48</size>
<color>green</color>
<color>голубой</color>
<color>orange</color>
<gender>жен.</gender>
<comment>Весна-лето 2012</comment>
</attrs>
</offer>
Элементы, входящие в <offer>:
Элементы
Описание
vendor
Название бренда/производителя
model
Наименование товара (этот текст будет выводиться под изображением товара в шоуруме в общем списке товаров)
categoryId
Идентификатор категории товара (целое число не более 18 знаков). Товарное предложение может принадлежать только одной
категории.
Обязательный элемент. Элемент <offer> может содержать несколько элементов <categoryId>.
description
Описание товарного предложения.
Необязательный элемент.
url
URL страницы товара. Максимальная длина URL — 255 символов.
price
Цена, по которой данный товар можно приобрести. Цена товарного предложения округляется, формат, в котором она
отображается, зависит от настроек пользователя.
Обязательный элемент.
oldprice
Цена, по которой данный товар продавался изначально (передается в том случае, если в текущий момент времени товар
продается со скидкой)
picture
Ссылка на картинку соответствующего товарного предложения. Недопустимо давать ссылку на «заглушку», т.е. на страницу,
где написано «картинка отсутствует», или на логотип магазина.
Желательно передавать несколько изображений товара. На первом картинке товар должен быть изображен полностью в
ракурсе анфас или ¾.
currencyId
Идентификатор валюты товара (RUR, USD, UAH, KZT). Для корректного отображения цены в национальной валюте
необходимо использовать идентификатор (например, UAH) с соответствующим значением цены.
4
http://retail.adlabs.ru
Обязательный элемент.
attrs
Элемент предназначен для указания характеристик (атрибутов) товара. Для описания каждого параметра используется
отдельный элемент <attrs>.
sizetype
Идентификатор типа размерной линейки: российской, европейской, американской, литерной
size
Доступные размеры данного товара, каждый размер прописывается в отдельном теге <size>.
Обязательный элемент.
color
Доступные цвета данного товара, каждый цвет прописывается в отдельном теге <color>.
Обязательный элемент.
comment
Любая полезная информация, относящаяся к товару.
Необязательный элемент
gender
Тег, описывающий, кому предназначен товар (мужчинам или женщинам).
Обязательный элемент.
5
Скачать