Przegląd

Interfejs API do raportowania

Interfejs API do raportowania umożliwia sprzedawcy dostęp do danych o skuteczności w sposób programowy 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 dla informacji o produktach do swoich systemów raportowania wewnętrznych lub zewnętrznych.
  • 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ć, jakie 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 w celu uzyskania danych dotyczących skuteczności (kliknięć i wyświetleń), które mogą być podzielone według różnych wymiarów (np. atrybutów zdarzenia raportowanego, 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żda ReportRow reprezentuje wartości żądanych danych dla segmentów określonych w zapytaniu. Jeśli nie podasz żadnych segmentów, zwrócony zostanie jeden wiersz z danymi zagregowanymi we wszystkich segmentach. Jeśli jednak żądasz segmentów wraz z danymi, odpowiedź zawiera po jednym wierszu dla każdego unikalnego ciągu segmentów. W jednym zapytaniu możesz wybrać wiele segmentów i wiele rodzajów danych.

Wysyłanie zapytań o dane

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

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

Przykładowa odpowiedź

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

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

Wykonywanie zapytań dotyczących segmentów

Oprócz danych możesz też wysyłać zapytania dotyczące segmentów, 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 jak GROUP BY w SQL. Segmenty dzielą wybrane dane, tworząc grupy według każdego segmentu w nawiasach klamrowych SELECT. Przykładowe zapytanie poniżej zwraca kliknięcia na dzień, posortowane według kliknięć malejąco w ramach dodanego zakresu dat. Zwrócone zostaną tylko wiersze, w których co najmniej 1 żądany wskaźnik ma wartość różną od 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ź kodu JSON poniżej pokazuje, że 1 grudnia 2020 r. ten sprzedawca miał 1546 kliknięć wszystkich swoich produktów we wszystkich swoich miejscach docelowych, a 2 grudnia 2020 r. – 829 kliknięć wszystkich swoich produktów we wszystkich swoich miejscach docelowych. W przypadku 3 grudnia 2020 r. nie zostanie zwrócony żaden obiekt, 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"
      }
    }
]}
Dalej
Gramatyka zapytania