Реклама і банери

В цьому розділі описано роботу з рекламою. Базова адреса для функцій даного розділу /advertising/.

Отримати випадковий банер

GET /advertising/banner/random
Query Parameters:
 
  • banner_code – Тип банеру.
  • advert – ID Акції.

Приклад відповіді:

{
    "banner": {
        "uuid": "B691005056BA876F11EC0A62A4D7CFA6",
        "banner_url": "https://b2b.bm.parts/img/banners/solgy_cup.jpg",
        "banner_code": "home"
    }
}

Отримати список банерів

GET /advertising/banners
Query Parameters:
 
  • banner_code – Тип банеру.
  • advert – ID Акції.

Приклад відповіді:

{
    "banners": [
        {
            "uuid":"81DC005056AC66D611E92552352FD2C2",
            "banner_code": "home",
            "banner_url": "https://b2b.bm.parts/img/banners/solgy_cup.jpg"
        }
    ]
}

Отримати список акцій

GET /advertising/list
Параметр Опис
promo Список ID для фільтрації. Приклад: ?promo=811C005056AC1EA911E853995D337585&promo=811C005056AC1EA911E853995D123456.
public Публічний опис акції.
filter Фільтр по акціям може приймати значення current, archived, all. За замовчуванням, current.
page Сторінка видачі.
per_page К-сть елементів у видачі

Метод вертає список активних рекламних компаній.

Приклад відповіді:

{
  "adverts": [
    {
      "end_at": "2018-05-30T00:00:00Z",
      "begin_at": "2018-05-01T00:00:00Z",
      "name": "Чашка в подарунок до кожного насосу ГУР от Solgy",
        "banners": {
            "home": {
              "banner_code": "home",
              "banner_url": "https://cdn.bm.parts/promo/Offers/Meyle_2021/sept_oct_meyle_800-500_lottery.jpg"
            },
            "app": {
              "banner_code": "app",
              "banner_url": "https://cdn.bm.parts/promo/Offers/Meyle_2021/sept_oct_meyle_700-320_lottery.jpg"
            },
            "busmarket_": {
              "banner_code": "busmarket_",
              "banner_url": "https://cdn.bm.parts/promo/Offers/Meyle_2021/sept_oct_meyle_800-500_lottery.jpg"
            }
          },
       "description": "действующая <b>акция</b>",
       "uuid": "811C005056AC1EA911E853995D337585",
       "show_progress": true,
       "finished": false,
       "target_type": 0,
       "periodicity": 1,
       "one_time_gift": false,
       "is_member": false
      }
    ]
}

Прогрес акції

GET /advertising/promo/(promo_uuid)/progress
Query Parameters:
 
  • promo_uuid – ID акції (Обов’язковий). Щоб отримати прогрес по всім акціям використовуйте параметр _all
Параметр Опис
uuid Ідентифікатор акції
name Назва акції
finished Чи закінчена акція: true, false
progress_period Період, за який розраховується виконання акції, може бути Весь період акції, місяць, поточний тиждень, сьогодні
progress Сума або кількість продажів по цілі
show_progress Обчислюється прогрес по даній акції (показувати прогрес)
target_type Вид цілі акції. Може приймати значення: eur, qnt
percentage Позиція вказівника
progress_total Всього виконано за розрахунковий період акції
promo_type Тип акції: рейтингова або накопичувальна
place Позиція в конкурсі
one_time_gift Разовий подарунок
nearest_gift_in Найближчий подарунок
nearest_place_in Лишилось накопичити
total Обіг
gifts[] Масив з подарунками з акції
gifts[].uuid Ідентифікатор подарунку
gifts[].count Кількість зароблених подарунків
gifts[].target Ціль, яку потрібно досягнути, щоб заробити подарунок
gifts[].default_image Зображення подарунку
gifts[].percentage Відсоток для відображення
gifts[].title Назва подарунку
winners_number Кількість призових місць

Приклад відповіді:

{
  "uuid": "81CA005056AC66D611E87DF8B8260B43",
  "name": "Фірмові бірки від..",
  "target_type": "Кол-во",
  "show_progress": true,
  "one_time_gift": false,
  "progress_total": 0.00,
  "progress_period": "В этом месяце",
  "percentage": 0.00,
  "promo_type": "accumulation",
  "winners_number": 0,
  "place": null,
  "total": null,
  "nearest_place_in": null,
  "nearest_gift_in": 50.000,
  "finished": false,
  "gifts": [
    {
      "percentage": 100.00,
      "uuid": "913E75269237F7EC40E288B0E5B92A9D",
      "target": 50.000,
      "title": "Бирка для замены масла .. (1к-кт = 50 шт)",
      "default_image": "https://cdn.bm.parts/photos/320x320/g/w/v/p/t/e4806f3f.jpeg",
      "count": 0
    }
  ]
}

Якщо використовується параметр _all, то відповідь буде в форматі:

{
  "adverts": [
    {
      "uuid": "B6A3005056BA86AD11EC002A67B56744",
      "name": "Розіграш призів разом з MEYLE",
      "target_type": "EUR",
      "show_progress": true,
      "one_time_gift": true,
      "progress_total": 0.92,
      "progress_period": "Весь период акции",
      "promo_type": "accumulation",
      "winners_number": 0,
      "place": null,
      "nearest_place_in": null,
      "total": null,
      "gifts": [
        {
          "percentage": 100.00,
          "uuid": "A2946EF92E4C4AFB46C58456C9D217A5",
          "target": 1000.000,
          "title": "Участь у розіграші подарунків",
          "default_image": "https://cdn.bm.parts/photos/320x320/w/s/a/s/z/6fa2e38a.jpeg",
          "count": 0
        }
      ],
      "nearest_gift_in": 999.08,
      "percentage": 0.09,
      "finished": false,
      "progress": 0.92
    }
  ]
}

Отримати акцію

GET /advertising/promo/(promo_uuid)
Параметр Опис
promo_uuid ID акції (Обов’язковий).)
public Публічний опис акції.

Приклад відповіді:

{
  "adverts": {
    "uuid": "B6A3005056BA86AD11EC002A67B56744",
    "finished": false,
    "target_type": 0,
    "description": "<div><span>действующая акция</span></div>",
    "banners": {
      "home": {
        "banner_url": "https://cdn.bm.parts/promo/Offers/Meyle_2021/sept_oct_meyle_800-500_lottery.jpg",
        "banner_code": "home"
      },
      "app": {
        "banner_url": "https://cdn.bm.parts/promo/Offers/Meyle_2021/sept_oct_meyle_700-320_lottery.jpg",
        "banner_code": "app"
      },
      "busmarket_": {
        "banner_url": "https://cdn.bm.parts/promo/Offers/Meyle_2021/sept_oct_meyle_800-500_lottery.jpg",
        "banner_code": "busmarket_"
      }
    },
    "show_progress": true,
    "periodicity": 0,
    "one_time_gift": true,
    "name": "Розіграш призів разом з MEYLE",
    "begin_at": "2021-09-01T00:00:00+00:00",
    "end_at": "2022-01-30T00:00:00+00:00",
    "is_member": false
  }
}