Method: 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.

Richiesta HTTP

POST https://analyticsdata.googleapis.com/v1alpha:runReport

L'URL utilizza la sintassi di transcodifica gRPC.

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Rappresentazione JSON
{
  "entity": {
    object (Entity)
  },
  "dimensions": [
    {
      object (Dimension)
    }
  ],
  "metrics": [
    {
      object (Metric)
    }
  ],
  "dateRanges": [
    {
      object (DateRange)
    }
  ],
  "offset": string,
  "limit": string,
  "metricAggregations": [
    enum (MetricAggregation)
  ],
  "dimensionFilter": {
    object (FilterExpression)
  },
  "metricFilter": {
    object (FilterExpression)
  },
  "orderBys": [
    {
      object (OrderBy)
    }
  ],
  "currencyCode": string,
  "cohortSpec": {
    object (CohortSpec)
  },
  "keepEmptyRows": boolean,
  "returnPropertyQuota": boolean
}
Campi
entity

object (Entity)

Una proprietà i cui eventi vengono monitorati. All'interno di una richiesta batch, questa entità non deve essere specificata o deve essere coerente con l'entità a livello di batch.

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.

offset

string (int64 format)

Il conteggio delle righe della riga iniziale. La prima riga viene conteggiata come riga 0.

limit

string (int64 format)

Il numero di righe da restituire. Se il parametro limit non è specificato, vengono restituite 10.000 righe. L'API restituisce un massimo di 100.000 righe per richiesta, indipendentemente da quante ne chiedi.

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

dimensionFilter

object (FilterExpression)

La clausola di filtro delle dimensioni. Per l'utilizzo in questo filtro è necessario richiedere le dimensioni. Impossibile utilizzare metriche in questo filtro.

metricFilter

object (FilterExpression)

La clausola di filtro delle metriche. Applicato in fase di post-aggregazione, in modo simile alla clausola SQL. L'utilizzo delle metriche in questo filtro è obbligatorio. Impossibile utilizzare le dimensioni in questo filtro.

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 dell'entità.

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.

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