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 tworzenie raportów niestandardowych bezpośrednio w Merchant Center. Interfejs Reporting API ma te zalety:
- Umożliwia dużych sprzedawcom importowanie danych o skuteczności informacji o produktach do wewnętrznych lub zewnętrznych systemów raportowania.
- Umożliwia dostęp do raportów użytkownikom, partnerom zewnętrznym i pośrednikom, którzy zarządzają kontami Merchant Center.
Użytkownicy interfejsu API mogą określić, jakie dane o skuteczności chcą pobierać w odpowiedzi na wywołanie funkcji wyszukiwania, na przykład:
- Dane, które mają zostać zwrócone (np. kliknięcia, wyświetlenia)
- Wymiary, według których dane są dzielone 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 interfejsu Content API for Shopping zapytania o dane o skuteczności (kliknięcia, wyświetlenia), które mogą być posegmentowane według różnych wymiarów (raportowanych atrybutów zdarzeń, takich jak program i data, oraz atrybutów produktów, takich jak marka, kategoria itp.), przy użyciu metody Search w usłudze Reports.
Wynikiem zapytania do usługi Reports jest lista wystąpień ReportRow, gdzie każde ReportRow reprezentuje wartości żądanych wskaźników z segmentów określonych w zapytaniu. Jeśli nie określisz żadnych segmentów, zwrócony zostanie 1 wiersz z danymi zagregowanymi ze wszystkich segmentów. W przeciwnym razie, jeśli wraz ze wskaźnikami zostaną wysłane jakieś segmenty, odpowiedź wyświetli 1 wiersz na każdą unikalną kropkę segmentu. W jednym zapytaniu możesz wybrać wiele segmentów i rodzajów danych.
Zapytanie o wskaźniki
Możesz wyszukiwać dane (kliknięcia, wyświetlenia, CTR itp.), które chcesz zwrócić. Aby przesłać zapytanie do usługi Raporty, musisz dodać do zakresu dat filtr. Przykładowe zapytanie poniżej zwraca jeden wiersz: łączną liczbę kliknięć uzyskanych 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ź w postaci kodu JSON pokazuje, jak ten sprzedawca uzyskał łącznie 4440 kliknięć dla wszystkich produktów 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ż wyszukiwać segmenty, które mogą być atrybutami produktu (offer_id, brand, category itp.) lub atrybutem raportowanego zdarzenia (date, program). Zarejestrowane zdarzenie to wyświetlenie lub kliknięcie produktu.
Segmenty działają podobnie do elementu GROUP BY w SQL. Segmenty dzielą wybrane dane, grupując według każdego segmentu w klauzuli SELECT. Widoczne poniżej przykładowe zapytanie zwraca kliknięcia dziennie uporządkowane malejąco według dodanego warunku zakresu dat. Zwrócone zostaną tylko wiersze, w których co najmniej jeden 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ź
W przykładowej odpowiedzi dotyczącej kodu JSON poniżej widać, że 1 grudnia 2020 r. sprzedawca uzyskał 1546 kliknięć wszystkich produktów we wszystkich miejscach docelowych 1 grudnia 2020 r. oraz 829 kliknięć wszystkich produktów we wszystkich miejscach docelowych 2 grudnia 2020 r. 3 grudnia 2020 r. nie zwrócimy żadnych obiektów, ponieważ sprzedawca nie uzyskał w tym dniu ż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"
}
}
]}