Method: properties.runRealtimeReport

Restituisce un report personalizzato dei dati sugli eventi in tempo reale per la tua proprietà. Gli eventi vengono visualizzati nei report in tempo reale pochi secondi dopo l'invio a Google Analytics. I report In tempo reale mostrano gli eventi e i dati sull'utilizzo per periodi di tempo che vanno dal momento attuale fino a 30 minuti fa (fino a 60 minuti per le proprietà Google Analytics 360).

Per una guida alla creazione di richieste in tempo reale consulta la sezione Creazione di un report In tempo reale.

Richiesta HTTP

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

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à.

Esempio: proprietà/1234

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "dimensions": [
    {
      object (Dimension)
    }
  ],
  "metrics": [
    {
      object (Metric)
    }
  ],
  "dimensionFilter": {
    object (FilterExpression)
  },
  "metricFilter": {
    object (FilterExpression)
  },
  "limit": string,
  "metricAggregations": [
    enum (MetricAggregation)
  ],
  "orderBys": [
    {
      object (OrderBy)
    }
  ],
  "returnPropertyQuota": boolean,
  "minuteRanges": [
    {
      object (MinuteRange)
    }
  ]
}
Campi
dimensions[]

object (Dimension)

Le dimensioni richieste e visualizzate.
metrics[]

object (Metric)

Le metriche richieste e visualizzate.
dimensionFilter

object (FilterExpression)

La clausola del filtro delle dimensioni. Le metriche non possono essere utilizzate in questo filtro.
metricFilter

object (FilterExpression)

La clausola di filtro delle metriche. Applicato nella fase di post-aggregazione, in modo simile alla clausola SQL. Le dimensioni non possono essere utilizzate in questo filtro.
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.
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.
returnPropertyQuota

boolean

Consente di scegliere se restituire lo stato attuale della quota In tempo reale di questa proprietà Analytics. La quota viene restituita in PropertyQuota.
minuteRanges[]

object (MinuteRange)

Gli intervalli minuti di dati sugli eventi da leggere. Se non specificato, verrà utilizzato un intervallo di un minuto per gli ultimi 30 minuti. Se sono richiesti più intervalli di minuti, ogni riga di risposta conterrà un indice di intervallo di minuti basato su zero. Se gli intervalli di due minuti si sovrappongono, i dati degli eventi relativi ai minuti sovrapposti vengono inclusi nelle righe di risposta di entrambi gli intervalli di minuti.

Corpo della risposta

Tabella del report In tempo reale della risposta corrispondente a una richiesta.

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

Rappresentazione JSON 
{
  "dimensionHeaders": [
    {
      object (DimensionHeader)
    }
  ],
  "metricHeaders": [
    {
      object (MetricHeader)
    }
  ],
  "rows": [
    {
      object (Row)
    }
  ],
  "totals": [
    {
      object (Row)
    }
  ],
  "maximums": [
    {
      object (Row)
    }
  ],
  "minimums": [
    {
      object (Row)
    }
  ],
  "rowCount": integer,
  "propertyQuota": {
    object (PropertyQuota)
  },
  "kind": string
}
Campi
dimensionHeaders[]

object (DimensionHeader)

Descrive le colonne delle dimensioni. Il numero e l'ordine delle intestazioni DimensionHeaders corrispondono alle dimensioni presenti nelle righe.
metricHeaders[]

object (MetricHeader)

Descrive le colonne delle metriche. Il numero di MetricHeaders e l'ordine di MetricHeaders corrisponde alle metriche presenti nelle righe.
rows[]

object (Row)

Righe di combinazioni di valori di dimensioni e valori delle metriche nel report.
totals[]

object (Row)

Se richiesto, i valori totali delle metriche.
maximums[]

object (Row)

Se richiesto, i valori massimi delle metriche.
minimums[]

object (Row)

Se richiesto, i valori minimi delle metriche.
rowCount

integer

Il numero totale di righe nel risultato della query. rowCount è indipendente dal numero di righe restituite nella risposta e dal parametro di richiesta limit. Ad esempio, se una query restituisce 175 righe e include limit su 50 nella richiesta API, la risposta conterrà rowCount di 175 ma solo 50 righe.
propertyQuota

object (PropertyQuota)

Lo stato della quota In tempo reale di questa proprietà Analytics, inclusa la richiesta.
kind

string

Identifica il tipo di risorsa di questo messaggio. Questo kind è sempre la stringa fissa "analyticsData#runRealtimeReport". 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

MinuteRange

Un insieme contiguo di minuti: startMinutesAgo, startMinutesAgo + 1, ..., endMinutesAgo. Sono consentiti intervalli di massimo 2 minuti.

Rappresentazione JSON 
{
  "name": string,
  "startMinutesAgo": integer,
  "endMinutesAgo": integer
}
Campi
name

string

Assegna un nome a questo intervallo di minuti. Questo nome viene assegnato alla dimensione dateRange in una risposta a un report. Se impostato, non può iniziare con date_range_ o RESERVED_. Se non viene configurato, gli intervalli di minuti vengono denominati in base al relativo indice su base zero nella richiesta: date_range_0, date_range_1 e così via.
startMinutesAgo

integer

Il minuto di inizio inclusivo per la query, esattamente un numero di minuti prima. Ad esempio, "startMinutesAgo": 29 specifica che il report deve includere i dati sugli eventi risalenti ai 29 minuti precedenti. Non può essere successiva a endMinutesAgo.

Se non specificato, il valore predefinito di startMinutesAgo è 29. Le proprietà Analytics standard possono richiedere dati sugli eventi degli ultimi 30 minuti (startMinutesAgo <= 29), mentre le proprietà Analytics 360 possono richiedere dati sugli eventi degli ultimi 60 minuti (startMinutesAgo <= 59).
endMinutesAgo

integer

Il minuto di fine inclusivo della query, esattamente un numero di minuti prima. Non può essere precedente al giorno startMinutesAgo. Ad esempio, "endMinutesAgo": 15 specifica che il report deve includere i dati sugli eventi precedenti a 15 minuti fa.

Se non specificato, il valore predefinito di endMinutesAgo è 0. Le proprietà Analytics standard possono richiedere qualsiasi minuto negli ultimi 30 minuti di dati sugli eventi (endMinutesAgo <= 29), mentre le proprietà Analytics 360 possono richiedere qualsiasi minuto negli ultimi 60 minuti di dati sugli eventi (endMinutesAgo <= 59).