Method: properties.runReport

Restituisce un report personalizzato dei dati sugli eventi di Google Analytics. I report contengono statistiche ricavate dai dati raccolti dal codice di monitoraggio di Google Analytics. I dati restituiti dall'API sono una tabella con colonne per le dimensioni e le metriche richieste. Le metriche sono misurazioni individuali dell'attività utente nella tua proprietà, ad esempio utenti attivi o conteggio eventi. Le dimensioni suddividono le metriche in base ad alcuni criteri comuni, come il paese o il nome dell'evento.

Per una guida alla creazione di richieste e all'interpretazione delle risposte, consulta la sezione Creazione di un report.

Richiesta HTTP

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

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. Viene 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 batch.

Esempio: Properties/1234

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "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
}
Campi
dimensions[]

object (Dimension)

Le dimensioni richieste e visualizzate.
metrics[]

object (Metric)

Le metriche richieste e visualizzate.
dateRanges[]

object (DateRange)

Intervalli di date di 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 si sovrappongono due intervalli di date, i dati sugli eventi per i giorni sovrapposti vengono inclusi nelle righe di risposta per entrambi gli intervalli. 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 scoprire di più, consulta la sezione Nozioni di base sui filtri delle dimensioni per alcuni esempi. Impossibile utilizzare metriche 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 con SQL. Impossibile utilizzare le dimensioni 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 delle righe. La seconda richiesta imposta l'offset al valore limit della prima richiesta, mentre la seconda restituisce il secondo valore limit delle righe.

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

string (int64 format)

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

L'API può anche restituire meno righe rispetto al valore limit richiesto, se il numero di valori della dimensione è inferiore a limit. Ad esempio, sono disponibili 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 Impaginazione.
metricAggregations[]

enum (MetricAggregation)

Aggregazione delle metriche. I valori aggregati delle metriche verranno mostrati nelle righe in cui i valori delle dimensioni sono impostati su "RESERVED_(MetricAggregation)".
orderBys[]

object (OrderBy)

Specifica in che modo vengono ordinate le 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 coorte associato a questa richiesta. Se la richiesta include un gruppo di coorte, deve essere presente la dimensione "coorte".
keepEmptyRows

boolean

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

Indipendentemente dall'impostazione 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à i valori eventName della riga: "purchase" e eventCount: 0.
returnPropertyQuota

boolean

Consente di attivare/disattivare la restituzione dello stato corrente della quota di questa proprietà Analytics. La quota viene restituita in PropertyQuota.

Corpo della risposta

In caso di esito positivo, il corpo della risposta contiene un'istanza di RunReportResponse.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

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