API отчетности

API отчётов позволяет торговцам программно взаимодействовать с данными об эффективности своей деятельности с помощью языка запросов Merchant Center. Это аналогично возможности создания пользовательских отчётов непосредственно в Merchant Center. API отчётов обладает следующими преимуществами:

• Позволяет крупным торговцам импортировать данные об эффективности листингов продуктов в свои внутренние или сторонние системы отчетности.
• Позволяет пользователям, сторонним партнерам и агрегаторам, управляющим учетными записями Merchant Center, получать доступ к отчетам.

Пользователи API могут указать, какие данные о производительности они хотели бы получить в ответе на вызов поиска, например:

• Возвращаемые показатели (например: клики, показы)
• Измерения, по которым следует сегментировать данные (например: OfferId, Date)
• Условия, которые необходимо выполнить (например: Клики > 100)

Язык запросов API отчетов может запрашивать у API контента для покупок показатели эффективности (клики, показы), возможно, сегментированные по различным измерениям (атрибуты зарегистрированных событий, такие как программа и дата, а также атрибуты продукта, такие как бренд, категория и т. д.), используя метод Search в службе Reports .

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

Запрос метрик

Вы можете запросить нужные вам метрики (клики, показы, CTR и т. д.). Для запроса к службе отчётов необходимо добавить фильтр по диапазону дат. Пример запроса ниже возвращает одну строку: совокупное количество кликов в рамках добавленного условия диапазона дат.

SELECT metrics.clicks
FROM MerchantPerformanceView
WHERE segments.date BETWEEN '2020-12-01' AND '2020-12-21';

Образец ответа

Пример ответа кода JSON ниже показывает, как этот продавец получил 4440 кликов, суммированных по всем своим продуктам и во всех своих пунктах назначения в период с 1 декабря 2020 г. по 21 декабря 2020 г.

{"results": [
    {
      "metrics": {
        "clicks": "4,440"
      }
    }
]}

Запрос сегментов

Помимо метрик, вы также можете запрашивать сегменты, которые могут быть атрибутами продукта ( offer_id , brand , category и т. д.) или атрибутами зарегистрированного события ( date , program ). Зарегистрированное событие — это показ или клик по товару.

Сегменты действуют аналогично оператору GROUP BY в SQL. Сегменты разделяют выбранные метрики, группируя их по каждому сегменту в предложении SELECT . Пример запроса ниже возвращает количество кликов в день, отсортированное по убыванию количества кликов в пределах добавленного условия диапазона дат. Будут возвращены только строки, в которых хотя бы одна запрошенная метрика не равна нулю.

SELECT
  segments.date,
  metrics.clicks
FROM MerchantPerformanceView
WHERE segments.date BETWEEN '2020-12-01' AND '2020-12-03'
ORDER BY metrics.clicks DESC;

Образец ответа

Пример ответа кода JSON ниже показывает, что у этого продавца было 1546 кликов по всем его товарам во всех его пунктах назначения 1 декабря 2020 г. и 829 кликов по всем его товарам во всех его пунктах назначения 2 декабря 2020 г. За 3 декабря 2020 г. объект возвращен не будет, поскольку у продавца в этот день не было кликов.

{
  "results": [
    {
      "segments": {
        "date": {
          "year": 2020,
          "month": 12,
          "day": 1
        }
      },
      "metrics": {
        "clicks": "1546"
      }
    },
    {
      "segments": {
        "date": {
          "year": 2020,
          "month": 12,
          "day": 2
        }
      },
      "metrics": {
        "clicks": "829"
      }
    }
]}