Method: properties.batchRunReports

Restituisce più report in un batch. Tutti i report devono riguardare la stessa proprietà Google Analytics.

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à Google Analytics di cui vengono monitorati gli eventi. Specificato nel percorso dell'URL e non nel corpo. Per saperne di più, consulta la sezione Dove trovare l'ID proprietà. Questa proprietà deve essere specificata per il batch. La proprietà all'interno di RunReportRequest può essere non specificata o coerente con questa proprietà.

Esempio: properties/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 del report separata. Ogni richiesta batch può contenere fino a 5 richieste.

Corpo della risposta

La risposta in 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 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à Google Analytics di cui vengono monitorati gli eventi. Specificato nel percorso dell'URL e non nel corpo. Per saperne di più, consulta la sezione Dove trovare l'ID proprietà. All'interno di una richiesta batch, questa proprietà deve essere non specificata o coerente con la proprietà a livello di batch.

Esempio: properties/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 vengono richiesti più intervalli di date, ogni riga di risposta conterrà un indice dell'intervallo di date basato su zero. Se due intervalli di date si sovrappongono, i dati sugli eventi per i giorni sovrapposti vengono inclusi nelle righe di risposta per entrambi gli intervalli di date. In una richiesta di coorte, questo dateRanges deve essere non specificato.
dimensionFilter

object (FilterExpression)

I filtri di dimensione consentono di richiedere solo valori di dimensione specifici nel report. Per saperne di più, consulta la sezione Nozioni di base sui filtri di dimensione per esempi. Le metriche non possono essere utilizzate in questo filtro.
metricFilter

object (FilterExpression)

La clausola di filtro delle metriche. Applicata dopo l'aggregazione delle righe del report, in modo simile alla clausola having di 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.

Quando si esegue la paginazione, la prima richiesta non specifica l'offset o, in modo 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 saperne di più su questo parametro di paginazione, consulta la sezione Paginazione.
limit

string (int64 format)

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

L'API può anche restituire meno righe del limit richiesto, se non sono presenti tanti valori di dimensione quanto il limit. Ad esempio, esistono meno di 300 valori possibili per la dimensione country, quindi quando generi report solo su country, non puoi ottenere più di 300 righe, anche se imposti limit su un valore più alto.

Per saperne di più su questo parametro di paginazione, consulta la sezione Paginazione.
metricAggregations[]

enum (MetricAggregation)

Aggregazione delle metriche. I valori delle metriche aggregate verranno mostrati nelle righe in cui i valori di dimensione sono impostati su "RESERVED_(MetricAggregation)". Gli aggregati che includono sia i confronti sia più intervalli di date verranno aggregati in base agli intervalli di date.
orderBys[]

object (OrderBy)

Specifica l'ordine delle righe nella risposta. Le richieste che includono sia i confronti sia più intervalli di date avranno gli ordini applicati ai confronti.
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 coorti, deve essere presente la dimensione "coorte".
keepEmptyRows

boolean

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

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

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

boolean

Attiva/disattiva la restituzione dello stato attuale della quota di questa proprietà Google 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 confronti per ricevere una colonna di confronto nella risposta.