Отправка взаимодействий с рекламным местом

Отправка событий

Ниже на схеме показаны основные события, связанные с показом и взаимодействием с рекламой в 4 случаях, когда в плейсмент:

• не приходит реклама, /choose возвращает пустой ответ

• приходит баннер (формат Banner)

• приходит товарная кампания тип Single (одна кампания с несколькими слотами)

• приходит товарная кампания тип Multi-campaign (в каждом слоте своя кампания)

Примеры разных вариантов ответов есть в коллекции Postman.

Общие действия после запроса рекламы такие:

1. Когда пользователь открывает экран или страницу с плейсментом, вы запрашиваете кампании для плейсмента /choose, передавая placementId. Есть 2 способа учесть потенциальный показ:

   • Указать параметр data.options.isImplicitImpression: true в запросе /choose.

   • Отправить Ad Impression (AIMP). Так система понимает емкость инвентаря. Если ответ на запрос choose содержит рекламный юнит, то вы отправляете в Ad Impression еще и его идентификаторы: campaignId, adsetId, creativeId, testId. Это в системе будет означать рекламный показ.

2. Когда рекламное место попадает в область видимости на более чем 50% в течение 1 секунды, вы отправляете событие Visible Impression (WRIMP).

3. Когда пользователь взаимодействуют с рекламным местом включая:

   • клик по области виджета

   • добавление товара в корзину

   • клик по товару с переходом на страницу товара

   вы отправляете событие Ad Click (ADCLICK). Это событие использует для расчета CTR рекламного блока.

4. (только для товарных кампаний) Когда блок с товарами попадает область видимости, вы отправляете события PIMP с помощью метода /batch или /productInteraction. Это в дополнение к WRIMP.

5. (только для товарных кампаний) Когда происходит клик по товару, включая:

   • добавление товара в корзину

   • клик по товару с переходом на страницу товара

   вы отправляете событие Product Click (PCLICK), с указанием sku товара в slots. Это в дополнение к ADCLICK.

Отправка AIMP/WRIPM

AIMP - Ad impression. Потенциальный показ

WRIMP - Widget real impression. Рекламный юнит попадает в область видимости на более чем 50% в течение 1 секунды (не зависито от того, есть реклама или нет).

post

Store event impression. AIMP - impression ad sets (auto send from choose), WRIMP - view ad set or placement

Authorizations

API Key - 1

Body

application/json

secstringRequired

Section id

Responses

200

Successful response

application/json

post

/impression

HTTPcURLJavaScriptPython

POST /impression HTTP/1.1
Host: srv.gravityads.ai
Content-Type: application/json
Accept: */*
Content-Length: 727

{
  "sec": "646689c3404f91f26103faa6",
  "user": {
    "uid": "6655ad2d98276864840da6e3"
  },
  "session": {
    "ses": "b368b83f-0cc6-4bc3-aa98-31c1047099fa"
  },
  "ctx": {
    "type": "CATEGORY",
    "data": [
      "Parent category",
      "Sub category"
    ],
    "lng": "msk",
    "url": "http://site.ru/cat/1"
  },
  "device": {
    "user_time": "2019-08-24T14:15:22Z",
    "ua": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/109.0.0.0 Safari/537.36",
    "ip": "127.0.0.1"
  },
  "data": [
    {
      "placementId": "662ca212bee2113d4d0413b7",
      "type": "WRIMP",
      "creativeId": "6628fbaed61912a88b0add87",
      "testId": "662ca3803787f5708d014085",
      "adsetId": "662ca3803787f5708d014086",
      "campaignId": "6628fbaed61912a88b0add85",
      "adSec": "6628fbaed61912a88b0add70",
      "adAccount": "6628fbaed61912a88b0add71",
      "pid": 10
    }
  ]
}

StoreWrimpStoreWrimpEmptyPlacement

200

Successful response

No content

Отправка ADCLICK

ADCLICK - ad click. Нажатие на рекламный блок (любую область, включая кнопки добавить в корзину и т.п.).

post

Store event click ad impression

Authorizations

API Key - 1

Body

application/json

secstringRequired

Section id

Responses

200

Successful response

application/json

post

/click

HTTPcURLJavaScriptPython

POST /click HTTP/1.1
Host: srv.gravityads.ai
Content-Type: application/json
Accept: */*
Content-Length: 712

{
  "sec": "646689c3404f91f26103faa6",
  "user": {
    "uid": "6655ad2d98276864840da6e3"
  },
  "session": {
    "ses": "b368b83f-0cc6-4bc3-aa98-31c1047099fa"
  },
  "ctx": {
    "type": "CATEGORY",
    "data": [
      "Parent category",
      "Sub category"
    ],
    "lng": "msk",
    "url": "http://site.ru/cat/1"
  },
  "device": {
    "user_time": "2019-08-24T14:15:22Z",
    "ua": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/109.0.0.0 Safari/537.36",
    "ip": "127.0.0.1"
  },
  "data": [
    {
      "placementId": "662ca212bee2113d4d0413b7",
      "creativeId": "6628fbaed61912a88b0add87",
      "testId": "662ca3803787f5708d014085",
      "adsetId": "662ca3803787f5708d014086",
      "campaignId": "6628fbaed61912a88b0add85",
      "adSec": "6628fbaed61912a88b0add70",
      "adAccount": "6628fbaed61912a88b0add71",
      "pid": 10
    }
  ]
}

200

Successful response

{}

Отправка PIMP/PCLICK

PIMP - Product impression. Показ товара в области видимости.

PCLICK - Product click. Нажатие на определенный товар в рекламном блоке.

post

Store product event impression

Authorizations

API Key - 1

Body

application/json

secstringRequired

Section id

Responses

200

Successful response

application/json

post

/productInteraction

HTTPcURLJavaScriptPython

POST /productInteraction HTTP/1.1
Host: srv.gravityads.ai
Content-Type: application/json
Accept: */*
Content-Length: 881

{
  "sec": "646689c3404f91f26103faa6",
  "user": {
    "uid": "6655ad2d98276864840da6e3"
  },
  "session": {
    "ses": "b368b83f-0cc6-4bc3-aa98-31c1047099fa"
  },
  "ctx": {
    "type": "CATEGORY",
    "data": [
      "Parent category",
      "Sub category"
    ],
    "lng": "msk",
    "url": "http://site.ru/cat/1"
  },
  "device": {
    "user_time": "2019-08-24T14:15:22Z",
    "ua": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/109.0.0.0 Safari/537.36",
    "ip": "127.0.0.1"
  },
  "data": [
    {
      "placementId": "662ca212bee2113d4d0413b7",
      "type": "PIMP",
      "creativeId": "6628fbaed61912a88b0add87",
      "testId": "662ca3803787f5708d014085",
      "adsetId": "662ca3803787f5708d014086",
      "campaignId": "6628fbaed61912a88b0add85",
      "adSec": "6628fbaed61912a88b0add70",
      "adAccount": "6628fbaed61912a88b0add71",
      "strategyId": "6628fbaed61912a88b0add82",
      "feedId": "6628fbaed61912a88b0add81",
      "fallback": false,
      "pid": 10,
      "slots": [
        {
          "sku": "123",
          "fallback": false,
          "strId": 1,
          "slotId": 1
        }
      ]
    }
  ]
}

200

Successful response

{}

Пакетная отправка событий

AIMP, WRIMP, ADCLICK, PIMP, PCLICK

post

Store batch multiple events

Authorizations

API Key - 1

Body

application/json

secstringRequired

Section id

Responses

200

Successful response

application/json

post

/batch

HTTPcURLJavaScriptPython

POST /batch HTTP/1.1
Host: srv.gravityads.ai
Content-Type: application/json
Accept: */*
Content-Length: 1175

{
  "sec": "646689c3404f91f26103faa6",
  "user": {
    "uid": "6655ad2d98276864840da6e3"
  },
  "session": {
    "ses": "b368b83f-0cc6-4bc3-aa98-31c1047099fa"
  },
  "ctx": {
    "type": "CATEGORY",
    "data": [
      "Parent category",
      "Sub category"
    ],
    "lng": "msk",
    "url": "http://site.ru/cat/1"
  },
  "device": {
    "user_time": "2019-08-24T14:15:22Z",
    "ua": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/109.0.0.0 Safari/537.36",
    "ip": "127.0.0.1"
  },
  "data": [
    {
      "placementId": "662ca212bee2113d4d0413b7",
      "type": "WRIMP",
      "creativeId": "6628fbaed61912a88b0add87",
      "testId": "662ca3803787f5708d014085",
      "adsetId": "662ca3803787f5708d014086",
      "campaignId": "6628fbaed61912a88b0add85",
      "adSec": "6628fbaed61912a88b0add70",
      "adAccount": "6628fbaed61912a88b0add71",
      "pid": 10
    },
    {
      "placementId": "662ca212bee2113d4d0413b7",
      "type": "PIMP",
      "creativeId": "6628fbaed61912a88b0add87",
      "testId": "662ca3803787f5708d014085",
      "adsetId": "662ca3803787f5708d014086",
      "campaignId": "6628fbaed61912a88b0add85",
      "adSec": "6628fbaed61912a88b0add70",
      "adAccount": "6628fbaed61912a88b0add71",
      "strategyId": "6628fbaed61912a88b0add82",
      "feedId": "6628fbaed61912a88b0add81",
      "fallback": false,
      "pid": 10,
      "slots": [
        {
          "sku": "123",
          "fallback": false,
          "strId": 1,
          "slotId": 1
        }
      ]
    }
  ]
}

200

Successful response

{}