Übersicht

Reporting API

Über die Reporting API kann ein Händler seine Leistungsdaten abrufen. Programmatisch über die Merchant Center Query Language erstellen. Ähnlich wie bei die Möglichkeit, Benutzerdefinierte Berichte erstellen direkt im Merchant Center. Die Reporting API bietet folgende Vorteile:

• Ermöglicht Großhändlern, Leistungsdaten für Produkteinträge in oder Drittanbieter-Berichtssysteme.
• Ermöglicht Nutzern, Drittanbietern und Aggregatoren, die Händler verwalten Kontozugriff auf Berichte.

API-User können angeben, welche Leistungsdaten sie abrufen möchten im In Anrufantworten suchen, z. B.:

• Zurückzugebende Messwerte (z. B. Klicks, Impressionen)
• Dimensionen, in denen die Daten segmentiert werden sollen (z. B. OfferId, Date)
• Bedingungen, die erfüllt sein müssen (z. B. Klicks > 100)

Mit der Abfragesprache der Reporting API kann die Content API for Shopping Leistungsmesswerte (Klicks, Impressionen), möglicherweise segmentiert nach verschiedenen Dimensionen (gemeldete Ereignisattribute wie „Programm“ und „Datum“ und Attribute wie Marke, Kategorie usw., unter Verwendung der Search-Methode für Reports-Dienst.

Das Ergebnis einer Abfrage an den Dienst Reports ist eine Liste von ReportRow -Instanzen, wobei jeder ReportRow die Werte der angeforderten Messwerte darstellt die Sie in der Abfrage angegeben haben. Sind keine Segmente angegeben, wird mit Messwerten zurückgegeben, die für alle Segmente zusammengefasst sind. Andernfalls, falls vorhanden werden Segmente zusammen mit Messwerten angefordert, dann wird in der Antwort eine Zeile für für jedes einzelne Segmenttupel. Es ist möglich, mehrere Segmente auszuwählen und mehrere Messwerte in einer einzelnen Abfrage zu erfassen.

Abfrage von Messwerten

Sie können Messwerte wie Klicks, Impressionen oder CTR abfragen, zurückgegeben. Sie müssen einen Filter für den Zeitraum hinzufügen, um die Berichte abzufragen . Die folgende Beispielabfrage gibt eine einzelne Zeile zurück: die Gesamtmenge der Klicks innerhalb der hinzugefügten Bedingung eines Zeitraums.

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

Beispielantwort

Das folgende Beispiel für eine JSON-Codeantwort zeigt,dass dieser Händler 4.440 Klicks erhalten hat. für alle Produkte und Ziele addiert, 1. und 21. Dezember 2020.

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

Segmente abfragen

Neben Messwerten können Sie auch Segmente abfragen. Dies kann ein Attribut von ein Produkt (offer_id, brand, category usw.) oder ein Attribut eines gemeldeten Ereignis (date, program). Ein gemeldetes Ereignis ist eine Impression oder ein Klick für Produkt.

Segmente verhalten sich ähnlich wie GROUP BY in SQL. Segmente teilen die ausgewählten Messwerte, die in der SELECT-Klausel nach jedem Segment gruppiert sind. Die Beispielabfrage unten gibt Klicks pro Tag zurück, sortiert nach Klicks, absteigend innerhalb der hinzugefügten Bedingung eines Zeitraums. Nur Zeilen, in denen mindestens ein angeforderter Messwert ungleich null ist, werden zurückgegeben werden kann.

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

Beispielantwort

Das folgende Beispiel für eine JSON-Codeantwort zeigt,wie dieser Händler 1.546 Klicks hatte. für alle Produkte in allen Zielen am 1. Dezember 2020 und 829 Klicks auf alle Produkte des Unternehmens auf allen 2. Dezember 2020. Seit dem 3. Dezember 2020 wird kein Objekt zurückgegeben. Der Händler hatte an diesem Tag keine Klicks.

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