AnyQuery — Региональный фид

📖

Обзор

Роль регионального фида и его связь с глобальным

Региональный фид содержит данные, отличающиеся по регионам: цены, доступность товара, а также опциональные параметры для настройки логики поиска и вывода бейджей. Полная информация о товарах (наименование, описание, изображения, категории и т.д.) берётся из глобального фида.

Глобальный фид

название, описание,
изображения, категории

+

Региональный фид

цены, наличие,
региональные параметры

→

Выдача для региона

актуальные данные
для пользователя

🔗

Документация по подготовке глобального фида: Инструкция по компоновке фида

📋

Формат и состав регионального фида

Официальный формат — YML

Пример регионального фида

Региональный фид с ограниченным набором полей + URL в случае отличий в регионах (не изменяйте пример):

yml / xml

<yml_catalog date="2022-04-09 04:16">
    <shop>
        <name>name</name>
        <company>name</company>
        <url>https://site.ru</url>
        <categories>
            <category id="1">Авто</category>
            <category id="2" parentId="1">Автомобильный свет / фонари / лампы переноски</category>
            <category id="3" parentId="1">Дневные ходовые огни</category>
        </categories>
        <offers>
            <offer id="1234" available="true">
                <price>799</price>
                <oldPrice>1399</oldprice>
                <categoryId>2</categoryId>
            </offer>
            <offer id="12345" available="false">
                <price>499</price>
                <currencyId>RUB</currencyId>
                <categoryId>3</categoryId>
            </offer>
        </offers>
    </shop>
</yml_catalog>

Теги для передачи цен и доступности

Используйте следующие теги для передачи цен и доступности в региональном фиде:

yml / xml

<price> <oldPrice>
<offer available="true|false">

Опциональные параметры для региональных отличий

Опциональные параметры для региональных отличий (логика поиска, бейджи) передавайте в формате:

yml / xml

<param name="НАЗВАНИЕ">REGION_ID:ЗНАЧЕНИЕ</param>

🆔

Идентификаторы региональных фидов и привязка

Как AnyQuery сопоставляет регион пользователя с нужным фидом

Помимо ссылок на региональные фиды передайте ID региона (в текстовом виде) для каждого региона. Эти ID добавляются в админ‑панели AnyQuery и используются для привязки соответствующих региональных фидов.

ID региона может быть числовым или текстовым (например, "MSK"). При выборе региона на сайте AnyQuery сопоставляет ID региона на сайте с ID в админ‑панели и подставляет данные (цены, наличие, параметры) из привязанного к этому ID фида.

🔌

Способы передачи ID региона на сайт

Значение должно быть доступно на всех страницах и реактивно меняться при переключении региона

Переменная в глобальной области видимости

Рекомендуемое имя: window.dgRegionId. Переменная может иметь любое название и должна быть доступна из глобальной области видимости.

javascript

window.dgRegionId = "MSK";

⭐

Рекомендуемый способ. Простой, надёжный и доступен из любого скрипта на странице.

Атрибут в DOM‑дереве

Рекомендуемое имя атрибута: data-region-id. Атрибут может иметь любое название и быть расположен в доступном элементе, который присутствует на всех страницах сайта.

html

<div id="region-root" data-region-id="MSK"></div>

Рекомендуемое имя: region_id. Возможна передача ID региона через cookie, где в значении cookie хранится ID региона.

javascript

document.cookie = "region_id=MSK; path=/";

dataLayer (массив объектов для аналитики)

Передайте значение RegionId в одном из объектов массива dataLayer.

javascript

window.dataLayer = window.dataLayer || [];
dataLayer.push({ RegionId: "MSK" });

⚠️

Не рекомендуется использовать этот способ, если вам доступен один из указанных выше.

📌

Примечания и требования

Обязательные условия для корректной работы региональных фидов

📄Формат фида — YML.

🔄ID региона должен реактивно меняться при переключении города / региона пользователем.

🌐Элемент / переменная / cookie / dataLayer с ID региона должны быть доступны на всех страницах сайта.

🔀Если ID региона не определён, используйте fallback‑регион: Global.

🕐Частоту обновления фидов и задержку применения изменений уточняйте у вашего менеджера интеграции / сопровождения или поддержки.

📦Полный набор товарного контента (название, описание, изображения, категории и пр.) должен быть передан в глобальном фиде: Инструкция по компоновке фида.