Обзор

API отчетов

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

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

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

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

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

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

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

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

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

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

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

{"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"
      }
    }
]}
Далее
Грамматика запроса