Войти

Добро пожаловать в Центр поддержки

Получите помощь с интеграцией и запущенными кампаниями.

Добро пожаловать в Центр поддержки. Получите помощь с интеграцией и запущенными кампаниями.

Criteo REST API для реселлеров

Ниже вы найдете ключевые инструкции по программе Criteo Reseller Program REST API для управления ставками и бюджетами на уровне магазина-партнера.

Аутентификация API

Мы используем JWT для проверки подлинности на основе токена в нашем REST API. Для создания вызовов в нашем API вам потребуется передать токен в любой из этих вызовов.

Для получения токена нужно произвести вызов POST для «/oauth2/token», используя client_id и client_secret в качестве параметров (см. раздел «Начало работы»).

ПРИМЕЧАНИЕ. Каждый токен действителен в течение 5 минут. Если срок действия вашего токена истек, вы получите код состояния HTTP-ответа 401.

Получение AdvertiserID

Чтобы получить свой AdvertiserID, необходимо произвести вызов GET для «/portfolio/».

Получение CampaignID

Чтобы получить свой CampaignID, выполните вызов GET для /sellers/endpoint.

Добавление магазина-участника в программу Criteo Reseller Program 

Чтобы добавить нового партнера (магазин), следует убедиться, что он надлежащим образом отмечен в товарном фиде, который вы ранее предоставили Criteo.  
Чтобы убедиться, что партнер отмечен корректно, введите в поля столбца seller name уникальный идентификатор партнера (магазина-участника), который является названием магазина, для каждого товара из его фида.

Важный момент: Магазин-партнер активируется в программе, как только вы предоставите нам список рекламируемых товаров в фиде, размер ставки за клик и бюджета.
После выполнения вышеуказанных шагов вы сможете предоставить нам бюджет и ставки за клик ваших магазинов-партнеров с помощью описанных выше endpoints, в частности:

  • PUT /v1/sellers/bids для отправки ставки за клик 
  • POST /v1/sellers/budgets для отправки бюджета

Важный момент: Полный список магазинов-партнеров с указанием их статуса (активен или неактивен) можно получить с помощью вызова GET для «/merchants/partners/», указав свой идентификатор кампании программы (CampaignID) в качестве параметра.   

ПОДСКАЗКА

Магазин-партнер:

  • Активен, если: для него указаны бюджет и ставка за клик, а в товарном фиде имеется как минимум один рекламируемый товар.
  • неактивен, если:
    • в его первоначальном статусе вы задали параметр sellerName в фиде продуктов, но еще не указали никакой бюджет и (или) ставку;
    • у него нет активного бюджета (см.далее budgetStatus).

Исключение магазина-партнера из программы Criteo Reseller Program

Если вы хотите исключить партнера из Criteo Reseller Program, выберите его в списке вашей кампании и остановите его (см.раздел «Как остановить рекламу партнера»).

Также вы можете просто удалить товары партнера из товарного фида. Однако данные изменения вступят в силу только после обновления товарного фида и категорий Criteo. Добавление товаров партнера также займет некоторое время по той же причине: системе необходимо обновить фид и категории. Как только партнер исключен из фида, статистика по его товарам станет недоступной.

Запуск кампании 

 

Для запуска кампании Criteo Reseller Program вы должны отправить нам свой фид, содержащий товары от всех магазинов-партнеров, которых вы выбрали для размещения рекламы. Обратите внимание, что каждый из этих товаров должен иметь уникальный ID партнера в соответствующем поле.

Важный момент: Если вы уже работаете с Criteo, вы можете скопировать уже отправленный нам фид, указав в нем уникальный идентификатор магазина-партнера в соответствующем поле.  

Ваша кампания будет создана сразу же после обработки вашего фида.
Для активации кампании требуется как минимум один партнер, для которого уже установлены бюджет и ставка. Установить их можно через endpoints PUT /v1/sellers/bids для ставки за клик и POST /v1/sellers /budgets для бюджета. 

Остановка активной кампании

Чтобы остановить кампанию Criteo Reseller Program целиком (для всех магазинов-партнеров), свяжитесь с вашим аккаунт-стратегом.

 

Остановка конкретного партнера

Чтобы остановить размещение рекламы для одного или нескольких партнеров в рамках вашей кампании, отметьте их бюджеты как «Неактивные» в соответствующем поле. Как только вы деактивируете их бюджеты, система сразу же остановит показ рекламы товаров данного партнера или партнеров.

Чтобы деактивировать бюджет, выполните вызов PUT call для /sellers/budget, как описано ниже:

  • PUT /sellers/budgets with status = Inactive

Важный момент: Размещение партнера с деактивированным бюджетом невозможно возобновить. Если вы хотите заново запустить показ рекламы для партнера с деактивированным бюджетом, вам необходимо создать для него новый бюджет (см. далее “Создание нового бюджета”).

Как остановить партнера, если его бюджет практически израсходован. 

Вам не нужно предпринимать какие-либо действия. Мы отслеживаем расходование бюджета по всем магазинам-партнерам и приостанавливаем их размещение, если их бюджет заканчивается.

Установка размера ставки за клик и бюджета

Чтобы задать бюджет и CPC для конкретного партнера, необходимо использовать следующие endpoints.

  • Ставки за клик: для инициализации и обновления выполните вызов PUT для «/sellers/bids endpoint».
  • Бюджеты:
    • Для инициализации ставки выполните вызов POST для «/v1/sellers/budgets endpoint»;
    • Для обновления бюджета выполните вызов PUT для /v1/sellers/budgets

Увеличение бюджета и ставок

Чтобы увеличить бюджет или CPC для конкретного партнера, необходимо произвести вызов PUT для endpoints «/v1/sellers/budgets» и « /v1/sellers/bids endpoints.».

Уменьшение ставок

Если ваш магазин-партнер хочет уменьшить цену за клик (CPC), необходимо выполнить вызов POST для «/v1/sellers/bids endpoint.».

Уменьшение бюджетов

Если ваш продавец или партнер хочет уменьшить бюджет, следует задать значение «Неактивен» для параметра budgetStatus — так вы отключите расходование текущего бюджета на размещение рекламы. После вы сможете задать новый бюджет желаемой величины. (см. далее «Как создать новый бюджет»). Изменения вступят в силу со следующего дня по времени UTC.

ПРИМЕР.

День 0. Для магазина A изначально задан бюджет на сумму в 1 000 долларов США в рамках кампании Criteo Reseller Program.

День 2. У партнера A остался бюджет в размере 800 долларов США, но он принимает решение сократить бюджет до 500 долларов США.

В этом случае необходимо создать следующие вызовы:

  • вызов POST для «/merchants/partners/budgets»:
    • задайте для параметра budgetStatus значение Неактивен;
    • (Необязательно точно указывать сумму бюджета, budgetStatusимеет приоритетное значение);
  • вызов POST для «/sellers/budgets/ endpoint»:
    • Задайте для параметра amount } значение 500
    • (Необязательно точно указывать значение status в этом случае; если оставить поле пустым, считается, что выбрано значение Активен)

Важный момент: Обратите внимание, что любое уменьшение бюджета вступает в силу немедленно со следующим эффектом:

  • Кампания для конкретного партнера немедленно приостанавливается до конца дня.
  • Кампания будет запущена заново на следующий день в 00:00 по времени UTC с новым значением бюджета.

Создание нового бюджета

Вы можете создать новый бюджет в следующих целях:

  • У ваc не установлен бюджет на сегодняшний день
  • Ваш бюджет на сегодняшний день неактивен

Чтобы создать новый бюджет для магазина-партнера, вам необходимо

  • вызов POST для «/sellers/budgets/ endpoint»:

Изменения бюджета вступят в силу:

  • Немедленно, если у вас не установлен бюджет на сегодняшний день
  • Со следующего дня, если ваш бюджет на сегодняшний день неактивен

Правка некорректных бюджетов 

Для начала необходимо, чтобы ваш партнер предоставил вам обновленный бюджет.
Далее возможны три варианта, которые предусматривают разные действия.

  • У вас уже имеется новый бюджет, и он меньше изначально установленного бюджета:
    • выполните действия, указанные в разделе «Как уменьшить бюджет или CPC».
  • У вас уже имеется новый бюджет, и он больше изначально установленного бюджета:
    • Выполните действия, указанные в разделе «Как увеличить бюджет или CPC».
  • У вас нет нового или правильного бюджета:
    • Выполните действия, описанные в разделе «Как остановить размещение магазина-партнера».

Правка некорректных СРС

Для начала необходимо, чтобы ваш продавец или партнер предоставил вам обновленную ставку за клик (CPC). Затем следует произвести вызов PUT для sellers/bids/», чтобы задать обновленную ставку.

Что если мой партнер изменил название?

Поскольку наш API фактически использует sellerName – имя партнера – в ходе управления ставками и бюджетами, любое изменение имени продавца или партнера автоматически приведет к созданию новой записи в нашей системе, не привязанной к предыдущему имени партнера. По сути, если продавец или партнер изменит свое имя на вашей платформе, вам потребуется:

  • обновить свой фид, указав новое значение sellerName;
  • Произвести инициализацию ставки за клик и бюджета партнера с помощью отправки нам PUT /v1/sellers/bids и POST /v1/sellers/budgets.

ПРИМЕЧАНИЕ. Вы сможете получить статистические данные по предыдущему значению sellerName посредством «statistics».

Аналитика израсходованных бюджетов партнеров

Чтобы просмотреть траты для отдельного партнера в рамках кампании Criteo Reseller Program, выполните вызов GET для «/v1/sellers». Информация будет доступна в виде параметра spentAmount.

Аналитика оставшихся бюджетов партнеров

Чтобы просмотреть траты для отдельного партнера в рамках кампании Criteo Reseller Program, выполните вызов GET для «/v1/sellers». Информация будет доступна в виде параметра remainingAmount

Отчеты

Вы можете выполнить запрос POST для «/v1/sellers/stats». Анализировать число просмотров, кликов и траты можно только на уровне продавца или партнера с детализацией на уровне одного дня.

Можно использовать не более трех параметров обязательно указывается параметр партнера.

Доступные характеристики:

  • идентификатор рекламодателя;
  • campaignID
  • Seller – Mandatory
  • год
  • неделя
  • день

Доступные показатели:

  • Показы
  • Клики
  • Стоимость для рекламодателя
Была ли эта статья полезной?
Пользователи, считающие этот материал полезным: 0 из 0