Method: properties.runReport

Restituisce un report personalizzato contenente i dati sugli eventi di Google Analytics. I report contengono statistiche derivate dai dati raccolti dal codice di monitoraggio di Google Analytics. I dati restituiti dall'API sono in formato di 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 a criteri comuni, come paese o nome evento.

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
property

string

Obbligatorio. 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à. All'interno di una richiesta batch, questa proprietà deve essere non specificata o coerente con la proprietà a livello di 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,
  "comparisons": [
    {
      object (Comparison)
    }
  ],
  "conversionSpec": {
    object (ConversionSpec)
  }
}
Campi
dimensions[]

object (Dimension)

Facoltativo. Le dimensioni richieste e visualizzate.
metrics[]

object (Metric)

Facoltativo. Le metriche richieste e visualizzate.
dateRanges[]

object (DateRange)

Facoltativo. Intervalli di date dei 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 due intervalli di date si sovrappongono, i dati sugli eventi per i giorni sovrapposti vengono inclusi nelle righe di risposta per entrambi gli intervalli di date. In una richiesta di coorte, questo dateRanges deve essere non specificato.
dimensionFilter

object (FilterExpression)

Facoltativo. I filtri delle dimensioni ti consentono di richiedere solo valori di dimensione specifici nel report. Per scoprire di più, consulta Nozioni di base sui filtri delle dimensioni per alcuni esempi. Le metriche non possono essere utilizzate in questo filtro.
metricFilter

object (FilterExpression)

Facoltativo. La clausola di filtro delle metriche. Applicato dopo l'aggregazione delle righe del report, in modo simile alla clausola HAVING di SQL. Le dimensioni non possono essere utilizzate in questo filtro.
offset

string (int64 format)

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

Durante l'impaginazione, la prima richiesta non specifica l'offset o, in modo equivalente, lo imposta su 0; la prima richiesta restituisce le prime limit righe. La seconda richiesta imposta l'offset sul valore limit della prima richiesta; la seconda richiesta restituisce il secondo limit di righe.

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

string (int64 format)

Facoltativo. Il numero massimo 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.

Per scoprire di più su questo parametro di impaginazione, vedi Impaginazione.
metricAggregations[]

enum (MetricAggregation)

Facoltativo. Aggregazione delle metriche. I valori delle metriche aggregate verranno visualizzati nelle righe in cui dimensionValues è impostato su "RESERVED_(MetricAggregation)". Gli aggregati che includono sia confronti che più intervalli di date verranno aggregati in base agli intervalli di date.
orderBys[]

object (OrderBy)

Facoltativo. Specifica l'ordine delle righe nella risposta. Le richieste che includono sia confronti che più intervalli di date avranno ordinamenti applicati ai confronti.
currencyCode

string

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

Facoltativo. Gruppo di coorte associato a questa richiesta. Se nella richiesta è presente un gruppo di coorti, deve essere presente la dimensione "coorte".
keepEmptyRows

boolean

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

Indipendentemente da questa impostazione keepEmptyRows, in un report possono essere visualizzati solo i dati registrati dalla proprietà Google Analytics.

Ad esempio, se una proprietà non registra mai un evento purchase, una query per la dimensione eventName e la metrica eventCount non avrà una riga eventName: "purchase" e eventCount: 0.
returnPropertyQuota

boolean

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

object (Comparison)

Facoltativo. La configurazione dei confronti richiesti e visualizzati. La richiesta richiede solo un campo di confronto per ricevere una colonna di confronto nella risposta.
conversionSpec

object (ConversionSpec)

Facoltativo. Controlla i report sulle conversioni. Questo campo è facoltativo. Se questo campo è impostato o vengono richieste metriche di conversione, il report sarà un report sulle conversioni.

Corpo della risposta

La tabella del report 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,
  "metadata": {
    object (ResponseMetaData)
  },
  "propertyQuota": {
    object (PropertyQuota)
  },
  "kind": string,
  "nextPageToken": 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, indipendentemente dal numero di righe restituite nella risposta. Ad esempio, se una query restituisce 175 righe e include limit = 50 nella richiesta API, la risposta conterrà rowCount = 175, ma solo 50 righe.

Per scoprire di più su questo parametro di impaginazione, vedi Impaginazione.
metadata

object (ResponseMetaData)

Metadati del report.
propertyQuota

object (PropertyQuota)

Lo stato della quota di questa proprietà Analytics, inclusa questa richiesta.
kind

string

Identifica il tipo di risorsa di questo messaggio. Questo kind è sempre la stringa fissa "analyticsData#runReport". Utile per distinguere i tipi di risposta in JSON.
nextPageToken

string

Un token, che può essere inviato come pageToken per recuperare la pagina successiva. Se questo campo viene omesso, non verranno visualizzate altre pagine.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

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

Confronto

Definisce un confronto individuale. La maggior parte delle richieste includerà più confronti, in modo che il report possa confrontarli.

Rappresentazione JSON 
{
  "name": string,

  // Union field one_comparison can be only one of the following:
  "dimensionFilter": {
    object (FilterExpression)
  },
  "comparison": string
  // End of list of possible types for union field one_comparison.
}
Campi
name

string

Ogni confronto produce righe separate nella risposta. Nella risposta, questo confronto è identificato da questo nome. Se il nome non è specificato, utilizzeremo il nome visualizzato dei confronti salvati.

Campo unione one_comparison.

one_comparison può essere solo uno dei seguenti tipi:
dimensionFilter

object (FilterExpression)

Un confronto di base.
comparison

string

Un confronto salvato identificato dal nome della risorsa del confronto. Ad esempio, "comparisons/1234".

ConversionSpec

Controlla i report sulle conversioni.

Rappresentazione JSON 
{
  "conversionActions": [
    string
  ],
  "attributionModel": enum (AttributionModel)
}
Campi
conversionActions[]

string

Gli ID delle azioni di conversione da includere nel report. Se vuoto, vengono incluse tutte le conversioni. Gli ID azione di conversione validi possono essere recuperati dal campo conversionAction all'interno dell'elenco conversions nella risposta del metodo properties.getMetadata. Ad esempio, "conversionActions/1234".
attributionModel

enum (AttributionModel)

Il modello di attribuzione da utilizzare nel report sulle conversioni. Se non specificato, viene utilizzato DATA_DRIVEN.

AttributionModel

Modello di attribuzione da utilizzare nel report sulle conversioni

Enum
ATTRIBUTION_MODEL_UNSPECIFIED Modello di attribuzione non specificato.
DATA_DRIVEN L'attribuzione si basava sul modello basato sui dati organici e a pagamento
LAST_CLICK L'attribuzione si basava sul modello dell'ultimo clic per canali a pagamento e organici