1. База знаний МедиаСкаут
  2. Инструкция
  3. Товарные фиды

Товарные фиды


В ОРД МедиаСкаут реализована регистрация товарных фидов.

Токен(erid) выдается на контейнер. В одном контейнере содержится один фид, фид может быть связан с несколькими контейнерами, в одном фиде может быть не ограниченное количество элементов фида. Каждый товар регистрируется как отдельный элемент фида.

Создать контейнер можно после того, как, хотя бы один элемент фида перейдет в статус Активный.

  • В один фид может входить любое количество контейнеров и элементов фида;
  • Контейнер связан с одним фидом и доходным или изначальным договором.

Маркировка товарного фида

Контейнер — рамочный креатив, который в себе может содержать элементы конкретного фида, на который он ссылается.

В кликовой ссылке должны передаваться два параметра:

  • erid —идентификатор рекламы;
  • subId — идентификатор элемента фида, в системе ОРД МедиаСкаут это параметр Id.

Пример кликовой ссылки: https://site.ru/?erid=Kra23jgC2&subId=15826118f

Регистрация элемента фида

При необходимости можете сжать медиаданные через сторонние библиотеки к примеру FFmpeg для видео, ImageMagick для изображений.

Регистрация элементов фида проходит в 2 этапа.

1 этап запрос на создание элемента фида в ОРД МедиаСкаут.

Создаем пачку элементов фида методом POST/webapi/v3/feeds/elements/bulk

Рекомендованный размер пачки не более 50 000 элементов фида.
Важно! Файлы должны быть доступны для скачивания без авторизации и ссылка должна вести на конечный файл, а не на папку с файлами.

После отправки запроса на создание элементов фида, получаем идентификаторы пачек.
Метод создания пачки асинхронный - система ОРД сначала получает все запросы и только потом начинает создавать элементы фидов и скачивать медиаданные.

Поэтому ожидайте минимум 2 часа после запроса на создание, затем запрашивайте статус по идентификатору пачки GET/webapi/v3/feeds/elements/bulk

Последующие запросы статуса пачки делайте с интервалом в 5 часов, на 1 этапе вам могут быть интересны 3 критичных статуса WaitingForRetry, Duplicate, Failed. Все остальные статусы на данном этапе говорят, что с пачкой все хорошо.

  • WaitingForRetry - не смогли скачать, хотя бы один из файлов элемента фида, далее будет 3 попытки скачивания с интервалом 6 часов. Пожалуйста, проверьте доступность файлов по ссылке;
  • Duplicate - повторное создание элемента фида, который есть в ОРД, параметр nativeCustomerId должен быть уникальным в рамках Фида. Фид определяется по одному из идентификаторов feedNativeCustomerId или feedId;
  • Failed - если допущена ошибка в заполнении полей или после того, как, система сделала 3 попытки скачивания файлов.
    Смотрите пояснения в полях:
    feedElementCreatingErrors - ошибки создания;
    mediaDownloadError - ошибка скачивания.

2 этап регистрация элементов фида в ЕРИР

После успешной загрузки медиаданных. Элементы фида регистрируются в ЕРИР не менее 24 часов, поэтому нет смысла запрашивать статус, каждую минуту, первый запрос рекомендуем послать через 30 часов после отправки запроса на создание первого элемента фида. Для этого используем метод:  GET/webapi/v3/feeds/elements

В запросе фильтруем по FeedNativeCustomerId и статусу Active.

Если хотим проверить есть ли ошибки регистрации элементов фида, то фильтруем по статусу RegistrationError
Следующие запросы на проверку статуса отправлять раз в час.

Регистрация контейнера

После того, как, хотя бы 1 элемент фида перешел в статус Активный можно создать контейнер.

Создаем контейнер методом POST/webapi/v3/feeds/containers
Метод синхронный, после обработки запроса, получаем erid.

Регистрация в ЕРИР занимает 24 часа, после этого времени можно, проверить статус контейнера GET/webapi/v3/feeds/containers
Следующие запросы на проверку статуса отправлять раз в час.

Редактирование элемента фида

Отредактировать один элемент синхронным методом PATCH/webapi/v3/feeds/elements
В запросе указать nativeCustomerId элемента фида и полный исправленный набор полей.  Ответ получим сразу.

Отредактировать пачку элементов асинхронным методом PATCH/webapi/v3/feeds/elements/bulk
В ответ получим идентификатор пачки, через 2 часа можно проверить результат редактирования.

Новые текстовые и медиаданнные добавятся к имеющимся. Заменить или удалить данные нельзя.

Редактирование контейнера

Отредактировать контейнер синхронным методом PATCH/webapi/v3/feeds/containers
Ответ получим сразу.

Предыдущая статья Креативы саморекламы
Следующая статья Акты