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 essere stati inviati a Google Analytics. I report in tempo reale mostrano gli eventi e i dati sull'utilizzo per i periodi di tempo che vanno dal momento attuale a 30 minuti prima (fino a 60 minuti per le proprietà Google Analytics 360).

Per una guida alla creazione di richieste in tempo reale e alla comprensione delle risposte, consulta 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à Google Analytics di cui vengono monitorati gli eventi. Specificato nel percorso dell'URL e non nel corpo. Per saperne di più, consulta Dove trovare l'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 di 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 having di 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 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 quanti sono i 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 delle metriche. I valori delle metriche aggregate verranno visualizzati nelle righe in cui dimensionValues è impostato su "RESERVED_(MetricAggregation)".
orderBys[]

object (OrderBy)

Specifica l'ordine delle righe nella risposta.
returnPropertyQuota

boolean

Attiva/disattiva la restituzione dello stato attuale della quota in tempo reale di questa proprietà Google Analytics. La quota viene restituita in PropertyQuota.
minuteRanges[]

object (MinuteRange)

Gli intervalli di minuti dei dati sugli eventi da leggere. Se non specificato, verrà utilizzato un intervallo di un minuto per gli ultimi 30 minuti. Se vengono richieste più intervalli di minuti, ogni riga di risposta conterrà un indice dell'intervallo di minuti basato su zero. Se due intervalli di 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 delle 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 e l'ordine di DimensionHeaders corrispondono alle dimensioni presenti nelle righe.
metricHeaders[]

object (MetricHeader)

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

object (Row)

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

object (Row)

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

object (Row)

Se richiesti, 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à Google Analytics, inclusa questa richiesta.
kind

string

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

MinuteRange

Un insieme contiguo di minuti: startMinutesAgo, startMinutesAgo + 1, ..., endMinutesAgo. Le richieste sono consentite fino a intervalli di 2 minuti.

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

string

Assegna un nome a questo intervallo di minuti. La dimensione dateRange è valutata in base a questo nome in una risposta del report. Se impostato, non può iniziare con date_range_ o RESERVED_. Se non vengono impostati, gli intervalli di minuti vengono denominati in base al loro 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 come numero di minuti prima di ora. Ad esempio, "startMinutesAgo": 29 specifica che il report deve includere i dati sugli eventi a partire da 29 minuti fa. Non può essere successiva al giorno endMinutesAgo.

Se non 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 finale inclusivo per la query come numero di minuti prima di ora. Non può essere antecedente 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, endMinutesAgo è impostato automaticamente su 0. Le proprietà Analytics standard possono richiedere qualsiasi minuto degli ultimi 30 minuti di dati sugli eventi (endMinutesAgo <= 29), mentre le proprietà Analytics 360 possono richiedere qualsiasi minuto degli ultimi 60 minuti di dati sugli eventi (endMinutesAgo <= 59).