Panoramica

API di reporting

L'API di reporting consente a un commerciante di interagire con i dati sul rendimento in modo programmatico attraverso il linguaggio di query di Merchant Center. Questo sistema è simile alla 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 delle schede di prodotto nei loro sistemi di generazione di report interni o di terze parti.
  • Consente a utenti, partner terzi 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 che devono essere soddisfatte (ad es. Clic > 100)

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

Il risultato di una query al servizio Reports è un elenco di istanze ReportRow, dove 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 per tutti i segmenti. In caso contrario, se vengono richiesti segmenti insieme alle metriche, la risposta mostrerà una riga per ogni tupla del segmento unico. In una singola query puoi selezionare più segmenti e metriche.

Query sulle metriche

Puoi eseguire query per le metriche (clic, impressioni, CTR e così via) che vuoi restituire. Devi aggiungere un filtro nell'intervallo di date per eseguire una query sul servizio Report. La seguente query di esempio restituisce una singola riga: il numero complessivo 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 in che modo questo commerciante ha ottenuto sommati 4440 clic per tutti i suoi prodotti in tutte le destinazioni tra il 1° dicembre 2020 e il 21 dicembre 2020.

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

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 funzionano in modo simile a GROUP BY in SQL. I segmenti suddividono le metriche selezionate raggruppando i segmenti per ciascun segmento nella clausola SELECT. La seguente query di esempio restituisce clic al giorno, ordinati in base ai clic in ordine decrescente all'interno della condizione aggiunta di un intervallo di date. Verranno 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

La risposta del codice JSON di esempio riportata di seguito mostra come questo commerciante ha ottenuto 1546 clic per tutti i suoi prodotti in tutte le destinazioni il 1° dicembre 2020 e 829 clic per tutti i prodotti in tutte le destinazioni il 2 dicembre 2020. Non verrà restituito alcun oggetto per il 3 dicembre 2020, poiché 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"
      }
    }
]}