NAV navbar
logo

Performance API

baseUri performance.ozon.ru:443
protocols HTTP

Начало работы

Чтобы использовать API отчетов по рекламным кампаниям Ozon, необходимо зарегистрировать приложение и получить client_id и client_secret. Сейчас регистрация приложения осуществляется по запросу на почту performance@ozon.ru, позже в рекламном кабинете появится возможность управлять зарегистрированными приложениями.

Для использования API необходимо:

  1. Получить авторизационный токен с помощью CLIENT_ID и CLIENT_SECRET в сервисе авторизации.
  2. Выполнить необходимые запросы с использованием полученного авторизационного токена. Если срок действия токена истёк, необходимо получить новый токен.

Получение авторизационного токена

Запрос:

POST /api/client/token HTTP/1.1
Host: https://performance.ozon.ru
Content-Type: application/json
Accept: application/json

{
  "client_id":"XYZ@advertising.performance.ozon.ru", 
  "client_secret":"b1u5XXDQW3wEqQ7dG...ancMyuhQtMNBI", 
  "grant_type":"client_credentials"
}

Ответ:

{
  "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.WyJFTWhVVU...qTz2XXZBv41h4",
  "expires_in": 1800,
  "token_type": "Bearer"
}

Список методов

Рекламные кампании

Список рекламных кампаний

GET /api/client/campaign

Возвращает список всех рекламных кампаний авторизованного пользователя.


Параметры ответа


id integer

Идентификатор кампании.

title string

Название кампании.

state string

Состояние кампании.

  • CAMPAIGN_STATE_RUNNING — активная кампания.
  • CAMPAIGN_STATE_PLANNED — кампания, сроки проведения которой ещё не наступили.
  • CAMPAIGN_STATE_STOPPED — кампания, сроки проведения которой завершились.
  • CAMPAIGN_STATE_INACTIVE — неактивная кампания.
  • CAMPAIGN_STATE_ARCHIVED — архивная кампания.
  • CAMPAIGN_STATE_MODERATION_DRAFT — отредактированная кампания до отправки на модерацию.
  • CAMPAIGN_STATE_MODERATION_IN_PROGRESS — кампания, отправленная на модерацию.
  • CAMPAIGN_STATE_MODERATION_FAILED — кампания, непрошедшая модерацию.

advObjectType string

Тип рекламируемого объекта. Подробнее о типах рекламных кампаний

  • SKU — реклама товаров в спонсорских полках. Размещается на карточке товаров, в поиске и категории.
  • BANNER — баннерная рекламная кампания.
  • SIS — реклама магазина.
  • BRAND_SHELF — брендовая полка.
  • BOOSTING_SKU — повышение товаров в каталоге.
  • ACTION — рекламная кампания для селлерских акции.
  • ACTION_CAS — рекламная кампания для акции.

fromDate string

Дата старта рекламной кампании в формате YYYY-MM-DD.

toDate string

Дата старта рекламной кампании в формате YYYY-MM-DD.

dailyBudget integer

Дневной бюджет рекламной кампании. Единица измерения — одна миллионная доля рубля, округляется до копеек.

GET /api/client/campaign HTTP/1.1
Host: performance.ozon.ru:443
Content-Type: application/json
Accept: application/json
Token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.WyJFTWhVVU...qTz2XXZBv41h4
{}
Response status  200 
{
  "list": [
    {
      "id": "48949",
      "title": "Баннерная кампания",
      "state": "CAMPAIGN_STATE_RUNNING",
      "advObjectType": "BANNER",
      "fromDate": "2019-10-07",
      "toDate": "2021-10-07",
      "dailyBudget": "504000000"
    },
    {
      "id": "48852",
      "title": "Реклама товаров no. 1",
      "state": "CAMPAIGN_STATE_INACTIVE",
      "advObjectType": "SKU",
      "fromDate": "",
      "toDate": "",
      "dailyBudget": "0"
    }
  ]
}

Создать кампанию с оплатой за показы

POST /api/client/campaign/cpm/product


Параметры запроса

title string

Название рекламной кампании.

fromDate string

Дата старта рекламной кампании в формате YYYY-MM-DD. Если не задано, кампания считается неограниченной во времени и начинается сразу после активации и/или модерации.

toDate string

Дата старта рекламной кампании в формате YYYY-MM-DD. Должна быть задана, если задано значение fromDate.

dailyBudget integer

Дневной бюджет рекламной кампании. Единица измерения — одна миллионная доля рубля, округляется до копеек.

placement * string

Место размещения рекламируемых товаров.

  • PLACEMENT_PDP — карточка товара и категорий.
  • PLACEMENT_SEARCH_AND_CATEGORY — поиск.


Параметры ответа


campaignId integer

Идентификатор кампании.

POST /api/client/campaign/cpm/product HTTP/1.1
Host: performance.ozon.ru:443
Content-Type: application/json
Accept: application/json
Token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.WyJFTWhVVU...qTz2XXZBv41h4
{
  "title": "Test campaign CPM",
  "fromDate": "2020-07-29",
  "toDate": "2020-07-31",
  "dailyBudget": 500,
  "placement": "PLACEMENT_SEARCH_AND_CATEGORY"
}
Response status  200 
{
  "campaignId": "48852"
}

Создать кампании с оплатой за клики

POST /api/client/campaign/cpc/product

Создание рекламных кампаний с моделью оплаты за клики ограничено и может быть недоступно.


Параметры запроса

title string

Название рекламной кампании.

fromDate string

Дата старта рекламной кампании в формате YYYY-MM-DD. Если не задано, кампания считается неограниченной во времени и начинается сразу после активации и/или модерации.

toDate string

Дата старта рекламной кампании в формате YYYY-MM-DD. Должна быть задана, если задано значение fromDate.

dailyBudget integer

Дневной бюджет рекламной кампании. Единица измерения — одна миллионная доля рубля, округляется до копеек.

placement * string

Место размещения рекламируемых товаров.

  • PLACEMENT_PDP — карточка товара и категорий.
  • PLACEMENT_SEARCH_AND_CATEGORY — поиск.


Параметры ответа


campaignId integer

Идентификатор кампании.

POST /api/client/campaign/cpc/product HTTP/1.1
Host: performance.ozon.ru:443
Content-Type: application/json
Accept: application/json
Token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.WyJFTWhVVU...qTz2XXZBv41h4
{
  "title": "Test campaign CPC",
  "fromDate": "2020-07-29",
  "toDate": "2020-07-31",
  "dailyBudget": 5000,
  "placement": "PLACEMENT_PDP"
}
Response status  200 
{
  "campaignId": "48852"
}

Активировать кампании

POST /api/client/campaign/{campaignId}/activate


URI Parameters

campaignId integer

Идентификатор кампании.

POST /api/client/campaign/{campaignId}/activate HTTP/1.1
Host: performance.ozon.ru:443
Content-Type: application/json
Accept: application/json
Token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.WyJFTWhVVU...qTz2XXZBv41h4
{}
Response status  200 
{}

Деактивировать кампании

POST /api/client/campaign/{campaignId}/deactivate


URI Parameters

campaignId integer

Идентификатор кампании.

POST /api/client/campaign/{campaignId}/deactivate HTTP/1.1
Host: performance.ozon.ru:443
Content-Type: application/json
Accept: application/json
Token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.WyJFTWhVVU...qTz2XXZBv41h4
{}
Response status  200 
{}

Изменить сроки проведения кампании

PUT /api/client/campaign/{campaignId}/period


URI Parameters

campaignId integer

Идентификатор кампании.


Параметры запроса

fromDate string

Дата старта рекламной кампании в формате YYYY-MM-DD. Если не задано, кампания считается неограниченной во времени и начинается сразу после активации и/или модерации.

toDate string

Дата старта рекламной кампании в формате YYYY-MM-DD. Должна быть задана, если задано значение fromDate.

PUT /api/client/campaign/{campaignId}/period HTTP/1.1
Host: performance.ozon.ru:443
Content-Type: application/json
Accept: application/json
Token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.WyJFTWhVVU...qTz2XXZBv41h4
{
  "fromDate": "2020-08-01",
  "toDate": "2020-08-31"
}
Response status  200 
{}

Изменить дневной бюджет кампании

PUT /api/client/campaign/{campaignId}/daily_budget


URI Parameters

campaignId integer

Идентификатор кампании.


Параметры запроса

dailyBudget integer

Дневной бюджет рекламной кампании. Единица измерения — одна миллионная доля рубля, округляется до копеек.

PUT /api/client/campaign/{campaignId}/daily_budget HTTP/1.1
Host: performance.ozon.ru:443
Content-Type: application/json
Accept: application/json
Token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.WyJFTWhVVU...qTz2XXZBv41h4
{
  "dailyBudget": 5000
}
Response status  200 
{}

Товары рекламной кампании

Список товаров в рекламной кампании

GET /api/client/campaign/{campaignId}/products

Возвращает список всех товаров в рекламной кампании.


URI Parameters

campaignId integer

Идентификатор кампании.


Параметры ответа


products object

Список всех товаров рекламной кампании.

sku integer

SKU рекламируемого товара.

bid integer

Ставка за 1000 показов (CPM) или 1000 кликов (CPC). Единица измерения — одна миллионная доля рубля, округляется до копеек.

groupId integer

Только для рекламных кампаний с размещением на страницах каталога и поиска. Идентификатор ранее созданной группы товаров — общего набора стоп-слов и поисковых фраз со ставками.

stopWords string

Список стоп-слов.

phrases object

Список поисковых фраз со ставками.

phrase string

Поисковая фраза.

bid integer

Ставка за 1000 показов (CPM) или 1000 кликов (CPC). Единица измерения — одна миллионная доля рубля, округляется до копеек.

relevanceStatus string

Cтатус соответствия поисковой фразы рекламируемому товару.

  • relevant — релевантно.
  • not_relevant — не релевантно.
  • in_progress — релевантность еще не определена.
  • on_moderation — релевантность еще не определена, необходима ручная модерация.

GET /api/client/campaign/{campaignId}/products HTTP/1.1
Host: performance.ozon.ru:443
Content-Type: application/json
Accept: application/json
Token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.WyJFTWhVVU...qTz2XXZBv41h4
{}
Response status  200 
{
    "products": [
      {
        "sku": "156184048",
        "bid": "25000000",
        "groupId": "12475",
        "stopWords": [
          "слова",
          "стоп"
        ],
        "phrases": [
          {
            "phrase": "samsung",
            "bid": "100000000",
            "relevanceStatus": "in_progress"
          },
          {
            "phrase": "нерелевантная фраза",
            "bid": "35000000",
            "relevanceStatus": "not_relevant"
          }
        ]
      }
    ]
  }
  

Разместить в карточке товара и категориях

POST /api/client/campaign/{campaignId}/products

В кампанию можно добавить до 500 товаров.


URI Parameters

campaignId integer

Идентификатор кампании.


Параметры запроса

sku * integer

SKU рекламируемого товара.

bid * integer

Ставка за 1000 показов (CPM) или 1000 кликов (CPC). Единица измерения — одна миллионная доля рубля, округляется до копеек.

POST /api/client/campaign/{campaignId}/products HTTP/1.1
Host: performance.ozon.ru:443
Content-Type: application/json
Accept: application/json
Token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.WyJFTWhVVU...qTz2XXZBv41h4
{
  "bids": [
      {
       "sku": 123456789, 
       "bid": 25000000
      },
      {
       "sku": 987654321, 
       "bid": 25000000
      }
    ]
}
Response status  200 
{}

Разместить на страницах поиска (в созданную группу)

POST /api/client/campaign/{campaignId}/products

В кампанию можно добавить до 500 товаров.


URI Parameters

campaignId integer

Идентификатор кампании.


Параметры запроса

sku * integer

SKU рекламируемого товара.

groupId * integer

Идентификатор группы товаров.

POST /api/client/campaign/{campaignId}/products HTTP/1.1
Host: performance.ozon.ru:443
Content-Type: application/json
Accept: application/json
Token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.WyJFTWhVVU...qTz2XXZBv41h4
{
  "bids": [
      {
       "sku": 123456789, 
       "groupId": 123456
      },
      {
       "sku": 987654321, 
       "groupId": 234567
      }
    ]
}
Response status  200 
{}

Разместить на страницах поиска (без группы)

POST /api/client/campaign/{campaignId}/products

В кампанию можно добавить до 500 товаров.


URI Parameters

campaignId integer

Идентификатор кампании.


Параметры запроса

sku * integer

SKU рекламируемого товара.

stopWords string

Список стоп-слов.

phrases object

Список поисковых фраз со ставками.

phrase string

Поисковая фраза.

bid integer

Ставка за 1000 показов (CPM) или 1000 кликов (CPC). Единица измерения — одна миллионная доля рубля, округляется до копеек.

POST /api/client/campaign/{campaignId}/products HTTP/1.1
Host: performance.ozon.ru:443
Content-Type: application/json
Accept: application/json
Token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.WyJFTWhVVU...qTz2XXZBv41h4
{
  "bids": [
      {
       "sku": 123456789, 
       "stopWords": [
          "word1", 
          "word2"
        ],
       "phrases": [
         {
           "phrase": "search query", 
           "bid": 25000000
         }
        ]
      }
    ]
}
Response status  200 
{}

Удалить товары из кампании

POST /api/client/campaign/{campaignId}/products/delete


URI Parameters

campaignId integer

Идентификатор кампании.


Параметры запроса

sku * integer

SKU рекламируемого товара.

POST /api/client/campaign/{campaignId}/products/delete HTTP/1.1
Host: performance.ozon.ru:443
Content-Type: application/json
Accept: application/json
Token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.WyJFTWhVVU...qTz2XXZBv41h4
{
  "sku": [
    123456789, 
    987654321
  ]
}
Response status  200 
{}

Ставки

Обновить ставки в карточке товара и категориях

PUT /api/client/campaign/{campaignId}/products

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


URI Parameters

campaignId integer

Идентификатор кампании.


Параметры запроса

sku * integer

SKU рекламируемого товара.

bid * integer

Ставка за 1000 показов (CPM) или 1000 кликов (CPC). Единица измерения — одна миллионная доля рубля, округляется до копеек.

PUT /api/client/campaign/{campaignId}/products HTTP/1.1
Host: performance.ozon.ru:443
Content-Type: application/json
Accept: application/json
Token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.WyJFTWhVVU...qTz2XXZBv41h4
{
  "sku": "156184048",
  "bid": "25000000"
}
Response status  200 
{}
  

Обновить ставки на страницах поиска (без группы)

PUT /api/client/campaign/{campaignId}/products

Обновление ставок у товаров на страницах поиска (без группы). Товары, для которых изменяется ставка, должны уже быть в кампании. Метод перезаписывает список стоп-слов и фразы со ставками — исходные стоп-слова и фразы со ставками удаляются. Для обновления ставок в группах используем другой метод — Редактирование группы товаров.


URI Parameters

campaignId integer

Идентификатор кампании.


Параметры запроса

sku * integer

SKU рекламируемого товара.

stopWords string

Список стоп-слов.

phrases object

Список поисковых фраз со ставками.

phrase string

Поисковая фраза.

bid integer

Ставка за 1000 показов (CPM) или 1000 кликов (CPC). Единица измерения — одна миллионная доля рубля, округляется до копеек.

PUT /api/client/campaign/{campaignId}/products HTTP/1.1
Host: performance.ozon.ru:443
Content-Type: application/json
Accept: application/json
Token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.WyJFTWhVVU...qTz2XXZBv41h4
{
  "bids": [
      {
       "sku": 123456789, 
       "stopWords": [
          "word1", 
          "word2"
        ],
       "phrases": [
         {
           "phrase": "search query", 
           "bid": 25000000
         }
        ]
      }
    ]
}
Response status  200 
{}

Группы товаров

Создание группы товаров

POST /api/client/campaign/{campaignId}/group

Возвращает идентификатор созданной группы.


URI Parameters

campaignId integer

Идентификатор кампании.


Параметры запроса

title string

Название группы товаров.

stopWords string

Список стоп-слов.

phrases object

Список поисковых фраз со ставками.

phrase string

Поисковая фраза.

bid integer

Ставка за 1000 показов (CPM) или 1000 кликов (CPC). Единица измерения — одна миллионная доля рубля, округляется до копеек.


Параметры ответа


POST /api/client/campaign/{campaignId}/group HTTP/1.1
Host: performance.ozon.ru:443
Content-Type: application/json
Accept: application/json
Token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.WyJFTWhVVU...qTz2XXZBv41h4
{
  "title": "Test group",
  "stopWords": [
      "word1",
      "word2"
    ], 
  "phrases": [
      {
        "phrase": "search query",
        "bid": 25000000
        }
        ]
    }
Response status  200 
{
    "groupId": 12345
}

Редактирование группы товаров

PUT /api/client/campaign/{campaignId}/group/{groupId}

Заменяет параметры группы новыми. Старые значения удаляются.


URI Parameters

campaignId integer

Идентификатор кампании.

groupId integer

Идентификатор группы товаров.


Параметры запроса

title string

Название группы товаров.

stopWords string

Список стоп-слов.

phrases object

Список поисковых фраз со ставками.

phrase string

Поисковая фраза.

bid integer

Ставка за 1000 показов (CPM) или 1000 кликов (CPC). Единица измерения — одна миллионная доля рубля, округляется до копеек.

PUT /api/client/campaign/{campaignId}/group/{groupId} HTTP/1.1
Host: performance.ozon.ru:443
Content-Type: application/json
Accept: application/json
Token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.WyJFTWhVVU...qTz2XXZBv41h4
{
  "title": "Test group",
  "stopWords": [
      "word1",
      "word2"
    ], 
  "phrases": [
      {
        "phrase": "search query",
        "bid": 25000000
        }
        ]
    }
Response status  200 
{}

Обновить группы товаров на страницах каталога и поиска

PUT /api/client/campaign/{campaignId}/products

Товары, для которых изменяется группа, должны уже быть в кампании. Чтобы удалить товар из группы, необходимо использовать значение groupId = 0. Товар останется в кампании, но у него не будет ставки и стоп-слова.


URI Parameters

campaignId integer

Идентификатор кампании.


Параметры запроса

sku * integer

SKU рекламируемого товара.

groupId * integer

Идентификатор группы товаров.

PUT /api/client/campaign/{campaignId}/products HTTP/1.1
Host: performance.ozon.ru:443
Content-Type: application/json
Accept: application/json
Token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.WyJFTWhVVU...qTz2XXZBv41h4
{
  "bids": [
      {
       "sku": 123456789, 
       "groupId": 123456
      },
      {
       "sku": 987654321, 
       "groupId": 234567
      }
    ]
}
Response status  200 
{}

Статистика по кампаниям

Статистика по кампаниям

POST /api/client/statistics

Возвращает статистику по указанным в запросе кампаниям. Даты в отчетах рекламного кабинета группируются по московскому времени.

Лимиты
Максимальное количество одновременных заданий в очереди генерации отчетов — 3.
Максимальное кличество кампаний в одном отчете — 10.


Параметры запроса

campaigns * integer

Список идентификаторов кампаний, для которых необходимо подготовить отчет. Если в списке только одна кампания, отчет будет в формате .csv. Если в списке несколько кампаний, отчет будет в виде .zip-архива с файлами .csv. Каждый файл — одна кампания из списка. Имя файла в формате<идентификатор кампании>.csv.

dateFrom * string

Начальная дата периода отчета. Дата указываются в формате RFC 3339. Максимальный период, за который можно получить отчет — 1 год.

dateTo * string

Конечная дата периода отчета. Дата указываются в формате RFC 3339. Максимальный период, за который можно получить отчет — 1 год.

groupBy string

Тип группировки кампаний в отчете.

  • DATE — группировка по дате (по дням).
  • START_OF_WEEK — группировка по неделям.
  • START_OF_MONTH — группировка по месяцам.


Параметры ответа


uuid string

Уникальный идентификатор отправленного запроса, с помощью которого можно проверить статус выполнения запроса и скачать отчёт.

POST /api/client/statistics HTTP/1.1
Host: performance.ozon.ru:443
Content-Type: application/json
Accept: application/json
Token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.WyJFTWhVVU...qTz2XXZBv41h4
{
  "campaigns":
    [
      "48852"
    ],
  "dateFrom":"2020-06-01",
  "dateTo":"2020-07-20",
  "groupBy":"DATE",
}
Response status  200 
{
  "UUID":"0c159c60-ab92-46d9-9a6b-d225dbf5c7b1",
}

Отчет по фразам

POST /api/client/statistics/phrases


Параметры запроса

campaigns * integer

Список идентификаторов кампаний, для которых необходимо подготовить отчет. Если в списке только одна кампания, отчет будет в формате .csv. Если в списке несколько кампаний, отчет будет в виде .zip-архива с файлами .csv. Каждый файл — одна кампания из списка. Имя файла в формате<идентификатор кампании>.csv.

dateFrom * string

Начальная дата периода отчета. Дата указываются в формате RFC 3339. Максимальный период, за который можно получить отчет — 1 год.

dateTo * string

Конечная дата периода отчета. Дата указываются в формате RFC 3339. Максимальный период, за который можно получить отчет — 1 год.

objects * string

Список идентификаторов рекламных объектов из указанной кампании, для которых будет построен отчет.


Параметры ответа


uuid string

Уникальный идентификатор отправленного запроса, с помощью которого можно проверить статус выполнения запроса и скачать отчёт.

POST /api/client/statistics/phrases HTTP/1.1
Host: performance.ozon.ru:443
Content-Type: application/json
Accept: application/json
Token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.WyJFTWhVVU...qTz2XXZBv41h4
{
  "campaigns": [
    "48852"
  ],
  "objects": [
    "1021",
    "1053"
  ],
  "dateFrom": "2020-06-01",
  "dateTo": "2020-07-20"
}
Response status  200 
{
  "UUID": "0c159c60-ab92-46d9-9a6b-d225dbf5c7b1"
}

Cтатус запроса

GET /api/client/statistics/{uuid}

Используйте идентификатор запроса, который был в ответе методов для генерации отчетов.


URI Parameters

uuid string

Уникальный идентификатор запроса.


Параметры ответа


uuid string

Уникальный идентификатор отправленного запроса, с помощью которого можно проверить статус выполнения запроса и скачать отчёт.

state string

Текущее состояние запроса.

  • NOT_STARTED — запрос ожидает выполнения.
  • IN_PROGRESS — запрос выполняется в данный момент.
  • ERROR — выполнение запроса завершилось ошибкой.
  • OK — запрос успешно выполнен.

createdAt datetime

Дата и время получения запроса сервером, часовой пояс UTC.

updatedAt datetime

Дата и время последнего обновления состояния запроса, часовой пояс UTC.

request object

Структура исходного запроса, отправленного на сервер и соответствующего заданному уникальному идентификатору.

error string

Если выполнение запроса вызвало ошибку, в этом поле будет её описание.

link string

Относительная ссылка на отчёт в формате .csv.

GET /api/client/statistics/{uuid} HTTP/1.1
Host: performance.ozon.ru:443
Content-Type: application/json
Accept: application/json
Token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.WyJFTWhVVU...qTz2XXZBv41h4
{

}
Response status  200 
{
  "UUID": "0c159c60-ab92-46d9-9a6b-d225dbf5c7b1",
  "state": "OK",
  "createdAt": "2020-03-23T19:30:58.264653Z",
  "updatedAt": "2020-03-23T19:30:58.689007Z",
  "request": {
    "campaigns": ["12558"],
    "dateFrom": "2020-03-01",
    "dateTo": "2020-03-20",
    "groupBy": "DATE",
    "objects": []
  },
  "link": "/external/api/statistics/report?UUID=0c159c60-ab92-46d9-9a6b-d225dbf5c7b1"
}

Печать отчета

GET /api/client/statistics/report?UUID={uuid}

Формат скачанного файла указан в заголовке Content-Type и зависит от того, сколько кампаний было в исходном запросе (поле campaigns). Имя файла в формате <идентификатор кампании>.csv

  • Одна кампания — файл .csv.
  • Если в списке несколько кампаний, отчет будет в виде .zip-архива с файлами .csv. Каждый файл — одна кампания из списка.


URI Parameters

uuid string

Уникальный идентификатор запроса.

GET /api/client/statistics/report?UUID={uuid} HTTP/1.1
Host: performance.ozon.ru:443
Content-Type: application/json
Accept: application/json
Token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.WyJFTWhVVU...qTz2XXZBv41h4
{}
Response status  200 
{}

Отчет по медийной рекламе

POST /api/client/statistics/attribution


Параметры запроса

campaigns integer

Список идентификаторов кампаний, для которых необходимо подготовить отчет. Если в списке только одна кампания, отчет будет в формате .csv. Если в списке несколько кампаний, отчет будет в виде .zip-архива с файлами .csv. Каждый файл — одна кампания из списка. Имя файла в формате<идентификатор кампании>.csv.

attributionDays integer

Количество дней для атрибуции.

dateFrom * string

Начальная дата периода отчета. Дата указываются в формате RFC 3339. Максимальный период, за который можно получить отчет — 1 год.

dateTo * string

Конечная дата периода отчета. Дата указываются в формате RFC 3339. Максимальный период, за который можно получить отчет — 1 год.

groupBy string

Тип группировки кампаний в отчете.

  • DATE — группировка по дате (по дням).
  • START_OF_WEEK — группировка по неделям.
  • START_OF_MONTH — группировка по месяцам.


Параметры ответа


uuid string

Уникальный идентификатор отправленного запроса, с помощью которого можно проверить статус выполнения запроса и скачать отчёт.

POST /api/client/statistics/attribution HTTP/1.1
Host: performance.ozon.ru:443
Content-Type: application/json
Accept: application/json
Token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.WyJFTWhVVU...qTz2XXZBv41h4
{
  "campaigns":
  [
    "48852"
  ],
  "attributionDays": "2',,
  "dateFrom":"2020-06-01",
  "dateTo":"2020-07-20",
  "groupBy":"DATE",
}
Response status  200 
{
  "UUID": "0c159c60-ab92-46d9-9a6b-d225dbf5c7b1"
}

Объекты рекламы

Возвращает список рекламируемых объектов для определенной кампании.

Объекты рекламы

GET /campaign/{campaignId}/objects


URI Parameters

campaignId integer

Идентификатор кампании.


Параметры ответа


id string

Идентификатор рекламируемого объекта.

  • SKU — для рекламы товаров в спонсорских полках и в каталоге.
  • Числовой идентификатор — для баннерных кампаний.

GET /api/client/campaign/{campaignId}/objects HTTP/1.1
Host: performance.ozon.ru:443
Content-Type: application/json
Accept: application/json
Token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.WyJFTWhVVU...qTz2XXZBv41h4
{}
Response status  200 
{}