Method: properties.reportTasks.query

Recupera i contenuti di un'attività di report. Dopo aver richiesto reportTasks.create, potrai recuperare i contenuti del report una volta che il report sarà ATTIVO. Questo metodo restituirà un errore se lo stato dell'attività di report non è ACTIVE. Una risposta a una query restituirà la riga tabulare & valori di colonna del report.

Richiesta HTTP

POST https://analyticsdata.googleapis.com/v1alpha/{name=properties/*/reportTasks/*}:query

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
name

string

Obbligatorio. Il nome dell'origine del report. Formato: properties/{property}/reportTasks/{report}

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "offset": string,
  "limit": string
}
Campi
offset

string (int64 format)

(Facoltativo) Il conteggio delle righe della riga iniziale nel report. La prima riga viene conteggiata come riga 0.

Durante il paging, la prima richiesta non specifica l'offset; o equivalente, imposta l'offset su 0; la prima richiesta restituisce il primo limit di righe. La seconda richiesta imposta l'offset sul limit della prima richiesta. la seconda richiesta restituisce il secondo limit di righe.

Per scoprire di più su questo parametro di impaginazione, consulta Pagination.
limit

string (int64 format)

(Facoltativo) Il numero di righe da restituire dal report. 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. Il numero di righe disponibili per una QueryReportTaskRequest è ulteriormente limitato dal limite del ReportTask associato. Una query può recuperare al massimo righe ReportTask.limit. Ad esempio, se ReportTask ha un limite di 1.000, una richiesta reportTasks.query con offset=900 e limit=500 restituirà al massimo 100 righe.

Per scoprire di più su questo parametro di impaginazione, consulta Pagination.

Corpo della risposta

I contenuti del report corrispondenti a un'attività di report.

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

object (ResponseMetaData)

Metadati per il report.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

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

ResponseMetaData

Metadati della risposta con informazioni aggiuntive sui contenuti del report.

Rappresentazione JSON 
{
  "dataLossFromOtherRow": boolean,
  "schemaRestrictionResponse": {
    object (SchemaRestrictionResponse)
  },
  "currencyCode": string,
  "timeZone": string,
  "emptyReason": string,
  "subjectToThresholding": boolean
}
Campi
dataLossFromOtherRow

boolean

Se il valore è true, indica che alcuni bucket di combinazioni di dimensioni vengono raggruppati nella categoria "(other)" riga di comando. Questo può accadere per i report ad alta cardinalità.

Il parametro dei metadati dataLossFromOtherRow viene compilato in base alla tabella di dati aggregati utilizzata nel report. Il parametro verrà compilato con precisione indipendentemente dai filtri e dai limiti del report.

Ad esempio, la riga (other) potrebbe essere eliminata dal report perché la richiesta contiene un filtro su sessionSource = google. Questo parametro verrà comunque compilato se è presente una perdita di dati da un'altra riga nei dati aggregati di input utilizzati per generare questo report.

Per saperne di più, consulta Informazioni sulla riga (other) e sul campionamento dei dati.
schemaRestrictionResponse

object (SchemaRestrictionResponse)

Descrive le limitazioni dello schema applicate attivamente durante la creazione di questo report. Per scoprire di più, consulta Gestione delle restrizioni relative a dati e accessi.
currencyCode

string

Codice valuta utilizzato in questo report. Destinato all'utilizzo nella formattazione di metriche di valuta come purchaseRevenue per la visualizzazione. Se currencyCode è stato specificato nella richiesta, questo parametro di risposta eco al parametro di richiesta; altrimenti questo parametro di risposta è l'attuale currencyCode della proprietà.

I codici valuta sono codifiche stringa dei tipi di valuta secondo lo standard ISO 4217 (https://en.wikipedia.org/wiki/ISO_4217). ad esempio "USD", "EUR", "JPY". Per ulteriori informazioni, consulta la pagina https://support.google.com/analytics/answer/9796179.
timeZone

string

Il fuso orario attuale della proprietà. È destinata a essere utilizzata per interpretare dimensioni basate sul tempo come hour e minute. Formattate come stringhe dal database del fuso orario IANA (https://www.iana.org/time-zones); ad esempio "America/New_York" o "Asia/Tokyo".
emptyReason

string

Se viene specificato un motivo vuoto, il report è vuoto per questo motivo.
subjectToThresholding

boolean

Se subjectToThresholding è impostato su true, questo report è soggetto a soglie e restituisce solo i dati che soddisfano le soglie minime di aggregazione. È possibile che una richiesta sia soggetta a una soglia di soglia e che nel report non siano assenti dati, anche quando tutti i dati sono al di sopra delle soglie. Per ulteriori informazioni, consulta gli articoli Soglie di dati e Informazioni sui dati demografici e sugli interessi.

SchemaRestrictionResponse

Limitazioni dello schema applicate attivamente durante la creazione di questo report. Per scoprire di più, consulta Gestione delle restrizioni relative a dati e accessi.

Rappresentazione JSON 
{
  "activeMetricRestrictions": [
    {
      object (ActiveMetricRestriction)
    }
  ]
}
Campi
activeMetricRestrictions[]

object (ActiveMetricRestriction)

Tutte le restrizioni sono state applicate attivamente durante la creazione del report. Ad esempio, purchaseRevenue ha sempre il tipo di limitazione REVENUE_DATA. Tuttavia, questa limitazione delle risposte attive viene compilata solo se il ruolo personalizzato dell'utente non consente l'accesso a REVENUE_DATA.

ActiveMetricRestriction

Una metrica con limitazioni attiva per la creazione del report.

Rappresentazione JSON 
{
  "restrictedMetricTypes": [
    enum (RestrictedMetricType)
  ],
  "metricName": string
}
Campi
restrictedMetricTypes[]

enum (RestrictedMetricType)

Il motivo della restrizione di questa metrica.
metricName

string

Il nome della metrica soggetta a limitazioni.

RestrictedMetricType

Categorie di dati che potrebbero non essere visualizzate su determinate proprietà GA4.

Enum
RESTRICTED_METRIC_TYPE_UNSPECIFIED Tipo non specificato.
COST_DATA Metriche relative ai costi come adCost.
REVENUE_DATA Metriche relative alle entrate, ad esempio purchaseRevenue.