API di reporting

L'API di reporting consente a un commerciante di interagire con i propri dati sul rendimento in modo programmatico tramite il linguaggio di query Merchant Center. Questa funzionalità è 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 reporting interni o di terze parti.
• Consente a utenti, partner di terze parti e aggregatori che gestiscono account Merchant Center di accedere ai report.

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

• Metriche da restituire (ad esempio: clic, impressioni)
• Dimensioni in cui segmentare i dati (ad esempio: OfferId, Date)
• Condizioni da soddisfare (ad esempio: clic > 100)

Il linguaggio di query dell'API Reporting può eseguire query su Content API for Shopping per metriche sul rendimento (clic, impressioni), eventualmente segmentate in base a varie dimensioni (attributi degli eventi segnalati come programma e data e attributi dei prodotti 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, in cui ogni ReportRow rappresenta i valori delle metriche richieste per i segmenti specificati nella query. Se non vengono specificati segmenti, viene restituita una singola riga con le metriche aggregate in tutti i segmenti. Altrimenti, se vengono richiesti segmenti insieme alle metriche, la risposta mostra una riga per ogni tupla di segmenti univoca. È possibile selezionare più segmenti e più metriche in una singola query.

Eseguire query per le metriche

Puoi eseguire query per le metriche (clic, impressioni, CTR e così via) che vuoi che vengano restituite. Per eseguire query sul servizio Reports, devi aggiungere un filtro all'intervallo di date. La query di esempio riportata di seguito restituisce una singola riga: l'importo aggregato dei 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 sommati per tutti i suoi prodotti in tutte le sue destinazioni tra il 1° dicembre 2020 e il 21 dicembre 2020.

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

Eseguire query per i segmenti

Oltre alle metriche, puoi anche eseguire query per i 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 si comportano in modo simile a un GROUP BY in SQL. I segmenti dividono le metriche selezionate, raggruppandole in base a ciascun segmento nella clausola SELECT. La query di esempio riportata di seguito restituisce i clic al giorno, ordinati in ordine decrescente in base ai clic all'interno della condizione aggiunta di un intervallo di date. Vengono restituite 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

Il seguente codice JSON di esempio mostra come questo commerciante ha ricevuto 1546 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. Non verrà restituito alcun oggetto per il 3 dicembre 2020, poiché il commerciante non ha ricevuto clic in 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"
      }
    }
]}