Method: properties.runRealtimeReport

Restituisce un report personalizzato dei dati degli eventi in tempo reale per la proprietà. Gli eventi vengono visualizzati nei report in tempo reale alcuni 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 ai 30 minuti precedenti (fino a 60 minuti per le proprietà Google Analytics 360).

Per una guida alla creazione di richieste in tempo reale e all'interpretazione delle risposte, consulta la sezione Creare 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 della proprietà GA4 di Google Analytics i cui eventi vengono monitorati. Specificato nel percorso dell'URL e non nel corpo. Per scoprire di più, scopri dove trovare il tuo ID proprietà.

Esempio: Properties/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 relativa al filtro per le 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 specificato, vengono restituite 10.000 righe. L'API restituisce un massimo di 250.000 righe per richiesta, indipendentemente da quante ne hai richieste. Il valore limit deve essere positivo.

L'API può anche restituire un numero inferiore di righe rispetto al valore limit richiesto, se il numero di valori di dimensione è inferiore a 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.

metricAggregations[]

enum (MetricAggregation)

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

orderBys[]

object (OrderBy)

Specifica l'ordine delle righe nella risposta.

returnPropertyQuota

boolean

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

minuteRanges[]

object (MinuteRange)

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

Corpo della risposta

La tabella del report in tempo reale sulle risposte 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 di DimensionHeaders e l'ordine di DimensionHeaders corrisponde 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 richiesti, 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 di 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 questa richiesta.

kind

string

Identifica il tipo di risorsa di questo messaggio. 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

Una serie contigua di minuti: startMinutesAgo, startMinutesAgo + 1, ..., endMinutesAgo. Sono consentite richieste con intervalli di un massimo di 2 minuti.

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

string

Assegna un nome a questo intervallo di minuti. Questo nome viene attribuito alla dimensione dateRange in una risposta al 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 in base zero nella richiesta: date_range_0, date_range_1 e così via.

startMinutesAgo

integer

Il minuto di inizio inclusivo per la query espresso come un numero di minuti precedente alla data corrente. 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 viene specificato, il valore predefinito di startMinutesAgo è 29. Le proprietà Analytics standard possono richiedere fino agli ultimi 30 minuti di dati sugli eventi (startMinutesAgo <= 29), mentre le proprietà Analytics 360 possono richiedere fino agli ultimi 60 minuti di dati sugli eventi (startMinutesAgo <= 59).

endMinutesAgo

integer

Il minuto di fine inclusivo della query espresso come un numero di minuti precedente alla data corrente. Non può essere precedente al giorno startMinutesAgo. Ad esempio, "endMinutesAgo": 15 specifica che il report deve includere i dati sugli eventi precedenti ai 15 minuti precedenti.

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