Panoramica

API di reporting

L'API di reporting consente a un commerciante di interagire con i suoi dati sul rendimento in modo programmatico tramite il linguaggio di query di Merchant Center. È simile a la possibilità di creare report personalizzati direttamente in Merchant Center. L'API di reporting offre i seguenti vantaggi:

  • Consente ai grandi commercianti di importare i dati sul rendimento per le schede di prodotto i propri sistemi di generazione di report interni o di terze parti.
  • Consente a utenti, partner terzi e aggregatori che gestiscono Merchant Center Gli account Centro accedono ai report.

Gli utenti dell'API possono specificare i dati sulle prestazioni che desiderano recuperare Cerca risposta alla chiamata, ad esempio:

  • Metriche da restituire (ad esempio Clic, Impressioni)
  • Dimensioni in cui segmentare i dati (ad esempio: OfferId, Date)
  • Condizioni che devono essere soddisfatte (ad es. Clic > 100)

Il linguaggio di query dell'API di reporting può interrogare l'API Content for Shopping per metriche sul rendimento (clic, impressioni), eventualmente segmentate dimensioni (attributi dell'evento segnalato come programma, data e prodotto come brand, categoria e così via), utilizzando il metodo Search nella Servizio Reports.

Il risultato di una query al servizio Reports è un elenco di ReportRow istanze, dove ogni ReportRow rappresenta i valori delle metriche richieste per i segmenti specificati nella query. Se non vengono specificati segmenti, viene viene restituita con le metriche aggregate in tutti i segmenti. In caso contrario, se presenti segmenti vengono richiesti insieme alle metriche, la risposta mostra una riga ciascuna tupla di segmenti univoci. È possibile selezionare più segmenti e in una singola query.

Query sulle metriche

Puoi eseguire query per le metriche (clic, impressioni, CTR e così via) che desideri restituito. Devi aggiungere un filtro sull'intervallo di date per eseguire query sui report servizio. La seguente query di esempio restituisce una singola riga: la quantità aggregata di clic nella condizione aggiunta di un intervallo di date.

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

Esempio di risposta

La risposta in codice JSON di esempio riportata di seguito mostra come questo commerciante ha ottenuto 4440 clic sommati per tutti i prodotti in tutte le destinazioni tra 1° dicembre 2020 e 21 dicembre 2020.

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

Query per i segmenti

Oltre alle metriche, puoi anche eseguire query sui segmenti, che possono essere un attributo un prodotto (offer_id, brand, category e così via) o un attributo di un report (date, program). Un evento segnalato è un'impressione o un clic per un prodotto.

I segmenti funzionano in modo simile a GROUP BY in SQL. I segmenti suddividono il segmento selezionato raggruppando i dati in base a ogni segmento nella clausola SELECT. La query di esempio riportata di seguito restituisce i clic al giorno, ordinati in base ai clic in ordine decrescente all'interno della condizione aggiunta di un intervallo di date. Solo le righe in cui almeno una metrica richiesta è diversa da zero da restituire.

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

Esempio di risposta

La risposta in codice JSON di esempio riportata di seguito mostra come questo commerciante ha ottenuto 1546 clic su tutti i prodotti in tutte le destinazioni il 1° dicembre 2020 e 829 clic per tutti i loro prodotti in tutte le destinazioni su 2 dicembre 2020. Non verrà restituito alcun oggetto per il 3 dicembre 2020 a partire dal giorno il commerciante non ha avuto clic quel giorno.

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