Method: properties.batchRunReports

Restituisce più report in gruppo. Tutti i report devono essere relativi alla stessa proprietà GA4.

Richiesta HTTP

POST https://analyticsdata.googleapis.com/v1beta/{property=properties/*}:batchRunReports

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
property

string

Un identificatore di proprietà GA4 di Google Analytics di cui vengono monitorati gli eventi. Specificato nel percorso dell'URL e non nel corpo. Per scoprire di più, scopri dove trovare il tuo ID proprietà. Questa proprietà deve essere specificata per il batch. La proprietà all'interno di RunReportRequest potrebbe non essere specificata o essere coerente con questa proprietà.

Esempio: proprietà/1234

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Rappresentazione JSON
{
  "requests": [
    {
      object (RunReportRequest)
    }
  ]
}
Campi
requests[]

object (RunReportRequest)

Richieste individuali. Ogni richiesta ha una risposta al report separata. A ogni richiesta batch è consentito un massimo di 5 richieste.

Corpo della risposta

La risposta batch contenente più report.

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

Rappresentazione JSON
{
  "reports": [
    {
      object (RunReportResponse)
    }
  ],
  "kind": string
}
Campi
reports[]

object (RunReportResponse)

Risposte individuali. Ogni risposta ha una richiesta di report separata.

kind

string

Identifica il tipo di risorsa di questo messaggio. Questo kind è sempre la stringa fissa "analyticsData#batchRunreports". Utile per distinguere tra i tipi di risposta in JSON.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics

RunReportRequest

La richiesta di generare un report.

Rappresentazione JSON
{
  "property": string,
  "dimensions": [
    {
      object (Dimension)
    }
  ],
  "metrics": [
    {
      object (Metric)
    }
  ],
  "dateRanges": [
    {
      object (DateRange)
    }
  ],
  "dimensionFilter": {
    object (FilterExpression)
  },
  "metricFilter": {
    object (FilterExpression)
  },
  "offset": string,
  "limit": string,
  "metricAggregations": [
    enum (MetricAggregation)
  ],
  "orderBys": [
    {
      object (OrderBy)
    }
  ],
  "currencyCode": string,
  "cohortSpec": {
    object (CohortSpec)
  },
  "keepEmptyRows": boolean,
  "returnPropertyQuota": boolean,
  "comparisons": [
    {
      object (Comparison)
    }
  ]
}
Campi
property

string

Un identificatore di proprietà GA4 di Google Analytics di cui vengono monitorati gli eventi. Specificato nel percorso dell'URL e non nel corpo. Per scoprire di più, scopri dove trovare il tuo ID proprietà. All'interno di una richiesta batch, questa proprietà non deve essere specificata o deve essere coerente con la proprietà a livello di batch.

Esempio: proprietà/1234

dimensions[]

object (Dimension)

Le dimensioni richieste e visualizzate.

metrics[]

object (Metric)

Le metriche richieste e visualizzate.

dateRanges[]

object (DateRange)

Intervalli di date dei dati da leggere. Se sono richiesti più intervalli di date, ogni riga di risposta conterrà un indice di intervallo di date basato su zero. Se due intervalli di date si sovrappongono, i dati sugli eventi per i giorni che si sovrappongono vengono inclusi nelle righe di risposta per entrambi gli intervalli di date. In una richiesta di coorte, questo dateRanges non deve essere specificato.

dimensionFilter

object (FilterExpression)

I filtri delle dimensioni ti consentono di richiedere solo valori di dimensione specifici nel report. Per ulteriori informazioni, consulta la sezione Concetti fondamentali dei filtri delle dimensioni per alcuni esempi. Le metriche non possono essere utilizzate in questo filtro.

metricFilter

object (FilterExpression)

La clausola di filtro delle metriche. Applicato dopo aver aggregato le righe del report, in modo simile alla clausola SQL. Le dimensioni non possono essere utilizzate in questo filtro.

offset

string (int64 format)

Il conteggio delle righe della riga iniziale. La prima riga viene conteggiata come riga 0.

Durante il paging, la prima richiesta non specifica l'offset; o equivalente, imposta l'offset su 0; la prima richiesta restituisce il primo limit di righe. La seconda richiesta imposta l'offset sul limit della prima richiesta. la seconda richiesta restituisce il secondo limit di righe.

Per scoprire di più su questo parametro di impaginazione, consulta Pagination.

limit

string (int64 format)

Il numero di righe da restituire. Se non vengono specificate, vengono restituite 10.000 righe. L'API restituisce un massimo di 250.000 righe per richiesta, indipendentemente da quante sono le richieste. limit deve essere positivo.

L'API può anche restituire meno righe rispetto al valore limit richiesto, se il numero di valori di dimensione è inferiore a quello di limit. Ad esempio, esistono meno di 300 valori possibili per la dimensione country. Di conseguenza, quando generi report solo su country, non puoi ottenere più di 300 righe, anche se imposti limit su un valore più alto.

Per scoprire di più su questo parametro di impaginazione, consulta Pagination.

metricAggregations[]

enum (MetricAggregation)

Aggregazione delle metriche. I valori aggregati delle metriche verranno mostrati nelle righe in cui i valori di dimensionValue sono impostati su "RESERVED_(MetricAggregation)".

orderBys[]

object (OrderBy)

Specifica l'ordine delle righe nella risposta.

currencyCode

string

Un codice valuta in formato ISO4217, ad esempio "AED", "USD", "JPY". Se il campo è vuoto, il report utilizza la valuta predefinita della proprietà.

cohortSpec

object (CohortSpec)

Gruppo di coorti associato a questa richiesta. Se nella richiesta è presente un gruppo di coorte, la "coorte" deve essere presente.

keepEmptyRows

boolean

Se il valore è false o non specificato, non verrà restituita ogni riga con tutte le metriche uguali a 0. Se impostato su true, queste righe vengono restituite se non vengono rimosse separatamente da un filtro.

Indipendentemente da questa impostazione di keepEmptyRows, in un report possono essere visualizzati solo i dati registrati dalla proprietà Google Analytics (GA4).

Ad esempio, se una proprietà non registra mai un evento purchase, una query per la dimensione eventName e la metrica eventCount non avrà la riga eventName: "purchase" e eventCount: 0.

returnPropertyQuota

boolean

Consente di scegliere se restituire lo stato attuale della quota di questa proprietà Analytics. La quota viene restituita in PropertyQuota.

comparisons[]

object (Comparison)

(Facoltativo) La configurazione dei confronti richiesti e visualizzati. La richiesta richiede solo un campo di confronto per ricevere una colonna di confronto nella risposta.