Обзор

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