Przegląd

Reporting API

Interfejs API do raportowania pozwala sprzedawcy korzystać z danych o skuteczności w sposób zautomatyzowany za pomocą języka zapytań Merchant Center. Przypomina to możliwość tworzenia raportów niestandardowych bezpośrednio w Merchant Center. Interfejs Reporting API ma takie zalety:

  • Pozwala dużym sprzedawcom importować dane o skuteczności 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 wydajności chcą pobrać w odpowiedzi wywołania wyszukiwania, na przykład:

  • Dane, które mają zostać zwrócone (np. kliknięcia, wyświetlenia)
  • Wymiary, według których należy dzielić dane na segmenty (np. OfferId, Date)
  • Warunki, które muszą zostać spełnione (np. Kliknięcia > 100)

Język zapytań interfejsu API do raportowania może wysyłać do Content API for Shopping zapytania o dane o skuteczności (kliknięcia, wyświetlenia) i podział na segmenty według różnych wymiarów (raportowanych atrybutów zdarzeń, takich jak program i data, oraz atrybutów produktu, takich jak marka, kategoria itp.) za pomocą metody Search w usłudze Reports.

Wynik zapytania do usługi Reports to lista instancji ReportRow, z których każdy ReportRow reprezentuje wartości żądanych danych dotyczących segmentów określonych w zapytaniu. Jeśli nie podasz żadnych segmentów, zwrócony zostanie 1 wiersz z danymi zagregowanymi ze wszystkich segmentów. W przeciwnym razie, jeśli poprosisz o segmenty wraz z danymi, odpowiedź będzie zawierać po 1 wierszu na każdą krotkę unikalnego segmentu. W jednym zapytaniu można wybrać wiele segmentów i wielu rodzajów danych.

Zapytanie o dane

Możesz wysyłać zapytania o dane (kliknięcia, wyświetlenia, CTR itp.), które chcesz zwrócić. Aby przesłać zapytanie do usługi Raporty, musisz dodać filtr dotyczący zakresu dat. Przykładowe zapytanie poniżej zwraca 1 wiersz: łączną liczbę kliknięć w ramach dodanego warunku zakresu dat.

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

Przykładowa odpowiedź

Poniższa przykładowa odpowiedź kodu JSON pokazuje, jak ten sprzedawca uzyskał 4440 kliknięć łącznie we wszystkich jego produktach we wszystkich miejscach docelowych w okresie od 1 grudnia 2020 r. do 21 grudnia 2020 r.

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

Zapytanie dotyczące segmentów

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

Segmenty działają podobnie do GROUP BY w SQL. Segmenty dzielą wybrane dane i grupują je według każdego segmentu w klauzuli SELECT. Przykładowe zapytanie poniżej zwraca liczbę kliknięć dziennie uporządkowanych według dodanego warunku zakresu dat. Zwrócone zostaną tylko wiersze, w których co najmniej 1 z żądanych danych ma wartość inną niż 0.

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ź z kodem JSON poniżej pokazuje, że 1 grudnia 2020 r. sprzedawca uzyskał 1546 kliknięć wszystkich produktów we wszystkich miejscach docelowych oraz 829 kliknięć we wszystkich miejscach docelowych 2 grudnia 2020 r. 3 grudnia 2020 r. nie zostanie zwrócony żaden obiekt, ponieważ w tym dniu sprzedawca nie uzyskał ż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"
      }
    }
]}
Dalej
Gramatyka zapytania