Interfejs API do raportowania

Interfejs Reporting API umożliwia sprzedawcy interakcję z danymi o skuteczności za pomocą języka zapytań Merchant Center. Jest to podobne do możliwości tworzenia raportów niestandardowych bezpośrednio w Merchant Center. Interfejs Reporting API zapewnia te korzyści:

• Umożliwia dużym sprzedawcom importowanie danych o skuteczności dotyczących informacji o produktach do wewnętrznych lub zewnętrznych systemów raportowania.
• Umożliwia użytkownikom, partnerom zewnętrznym i agregatorom, którzy zarządzają kontami Merchant Center, dostęp do raportów.

Użytkownicy interfejsu API mogą określić, które dane o skuteczności chcą pobrać w odpowiedzi na wywołanie Search, np.:

• Dane do zwrócenia (np. kliknięcia, wyświetlenia)
• Wymiary, według których chcesz podzielić dane na segmenty (np. OfferId, Date).
• Warunki, które muszą zostać spełnione (np. Kliknięcia > 100)

Język zapytań interfejsu Reporting API może wysyłać zapytania do interfejsu Content API for Shopping o dane dotyczące skuteczności (kliknięcia, wyświetlenia), które mogą być podzielone na segmenty według różnych wymiarów (atrybuty raportowanego zdarzenia, takie jak program i data, oraz atrybuty produktu, takie jak marka, kategoria itp.) za pomocą metody Search w usłudze Reports.

Wynikiem zapytania do usługi Reports jest lista ReportRowinstancji, z których każda ReportRowreprezentuje wartości żądanych danych dla segmentów określonych w zapytaniu. Jeśli nie podasz żadnych segmentów, zwracany jest jeden wiersz z danymi zagregowanymi we wszystkich segmentach. W przeciwnym razie, jeśli wraz z danymi są żądane jakiekolwiek segmenty, odpowiedź zawiera jeden wiersz dla każdej unikalnej krotki segmentów. W jednym zapytaniu można wybrać wiele segmentów i rodzajów danych.

Wysyłanie zapytań o dane

Możesz wysyłać zapytania o dane (kliknięcia, wyświetlenia, CTR itp.), które chcesz uzyskać. Aby wysyłać zapytania do usługi Raporty, musisz dodać filtr zakresu dat. Przykładowe zapytanie poniżej zwraca jeden wiersz: łączną liczbę kliknięć w dodanych warunkach zakresu dat.

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

Przykładowa odpowiedź

Przykładowa odpowiedź w formacie JSON poniżej pokazuje, że ten sprzedawca uzyskał łącznie 4440 kliknięć wszystkich produktów we wszystkich miejscach docelowych w okresie od 1 do 21 grudnia 2020 r.

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

Wykonywanie zapytań o segmenty

Oprócz danych możesz też wysyłać zapytania o segmenty, które mogą być atrybutem produktu (offer_id, brand, category itp.) lub atrybutem zgłoszonego zdarzenia (date, program). Zgłoszone zdarzenie to wyświetlenie lub kliknięcie produktu.

Segmenty działają podobnie do klauzuli GROUP BY w SQL. Segmenty dzielą wybrane dane, grupując je według poszczególnych segmentów w klauzuli SELECT. Przykładowe zapytanie poniżej zwraca kliknięcia według dnia, uporządkowane malejąco według liczby kliknięć w ramach dodanego warunku zakresu dat. Zostaną zwrócone tylko wiersze, w których co najmniej jeden z żądanych rodzajów danych ma wartość inną niż zero.

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

Przykładowa odpowiedź

Przykładowa odpowiedź w formacie JSON poniżej pokazuje, że 1 grudnia 2020 r. ten sprzedawca uzyskał 1546 kliknięć wszystkich produktów we wszystkich miejscach docelowych, a 2 grudnia 2020 r. – 829 kliknięć wszystkich produktów we wszystkich miejscach docelowych. Nie zostanie zwrócony żaden obiekt dla 3 grudnia 2020 r., ponieważ w tym dniu sprzedawca nie miał żadnych kliknięć.

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