Panoramica

API di reporting

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

  • Consente ai commercianti di grandi dimensioni di importare i dati sul rendimento delle schede di prodotto nei propri sistemi di generazione di report interni o di terze parti.
  • Consente agli utenti, ai partner di terze parti e agli aggregatori che gestiscono gli account Merchant Center di accedere ai report.

Gli utenti dell'API possono specificare i dati sul rendimento che vogliono recuperare nella risposta della chiamata di ricerca, ad esempio:

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

Il linguaggio di query dell'API Reporting può eseguire query sull'API Content for Shopping per ottenere le metriche sul rendimento (clic, impressioni), eventualmente segmentate in base a varie dimensioni (attributi evento registrati come programma e data e attributi prodotto come brand, categoria e così via), utilizzando il metodo Search sul servizio Reports.

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

Eseguire query sulle metriche

Puoi eseguire query per le metriche (clic, impressioni, CTR e così via) che vuoi recuperare. Per eseguire query sul servizio Report, devi aggiungere un filtro all'intervallo di date. La query di esempio riportata di seguito restituisce una singola riga: il valore aggregato di clic all'interno della 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 seguente risposta del codice JSON di esempio mostra come questo commerciante ha registrato 4440 clic tra il 1° dicembre 2020 e il 21 dicembre 2020 su tutti i suoi prodotti e su tutte le sue destinazioni.

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

Eseguire query sui segmenti

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

I segmenti agiscono in modo simile a un GROUP BY in SQL. I segmenti suddividono le metriche selezionate, raggruppandole in base a ciascun segmento nella clausola SELECT. La query di esempio riportata di seguito restituisce i clic giornalieri, ordinati in ordine decrescente in base ai clic all'interno della condizione aggiuntiva di un intervallo di date. Verranno riportate solo le righe in cui almeno una metrica richiesta è diversa da zero.

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 del codice JSON di esempio riportata di seguito mostra che questo commerciante ha registrato 1.546 clic su tutti i suoi prodotti in tutte le sue destinazioni il 1° dicembre 2020 e 829 clic su tutti i suoi prodotti in tutte le sue destinazioni il 2 dicembre 2020. Nessun oggetto verrà restituito per il 3 dicembre 2020 poiché il commerciante non ha registrato 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"
      }
    }
]}