Method: properties.reportTasks.query

Recupera i contenuti di un'attività del report. Dopo aver richiesto il reportTasks.create, puoi recuperare i contenuti del report quando il report è ATTIVO. Questo metodo restituisce un errore se lo stato dell'attività del report non è ACTIVE. Una risposta alla query restituirà i valori delle righe e delle colonne tabulari 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 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 del report. La prima riga viene conteggiata come riga 0.

Quando viene utilizzata la paginazione, la prima richiesta non specifica l'offset; in alternativa, imposta l'offset su 0; la prima richiesta restituisce le prime limit 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 paginazione, consulta la sezione Paginazione.
limit

string (int64 format)

Facoltativo. Il numero di righe da restituire dal report. Se non specificato, vengono restituite 10.000 righe. L'API restituisce un massimo di 250.000 righe per richiesta, indipendentemente da quante ne richiedi. limit deve essere positivo.

L'API può anche restituire meno righe rispetto al limit richiesto, se non sono presenti gli stessi valori delle dimensioni del limit. Il numero di righe disponibili per una richiesta QueryReportTask è ulteriormente limitato dal limite della ReportTask associata. Una query può recuperare al massimo ReportTask.limit righe. Ad esempio, se la richiesta ReportTask ha un limite di 1000, una richiesta reportTasks.query con offset=900 e limit=500 restituirà al massimo 100 righe.

Per scoprire di più su questo parametro di paginazione, consulta la sezione Paginazione.

Corpo della risposta

I contenuti del report corrispondenti a un'attività del 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 di intestazioni delle dimensioni e l'ordine delle intestazioni delle dimensioni corrispondono alle dimensioni presenti nelle righe.
metricHeaders[]

object (MetricHeader)

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

object (Row)

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

object (Row)

Se richiesto, i valori totalizzati 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 del 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 contenenti informazioni aggiuntive sui contenuti del report.

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

boolean

Se true, indica che alcuni bucket di combinazioni di dimensioni vengono raggruppati nella riga "(other)". Questo può accadere per i report con una cardinalità elevata.

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 nel 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 nei dati aggregati di input utilizzati per generare questo report era presente una perdita di dati da un'altra riga.

Per scoprire di più, consulta Informazioni sulla riga (other) e sul campionamento dei dati.
samplingMetadatas[]

object (SamplingMetadata)

Se i risultati di questo report sono campionati, viene descritta la percentuale di eventi utilizzati in questo report. Viene compilato un samplingMetadatas per ogni intervallo di date. Ogni samplingMetadatas corrisponde a un intervallo di date in base all'ordine in cui sono stati specificati nella richiesta.

Tuttavia, se i risultati non vengono campionati, questo campo non verrà definito.
schemaRestrictionResponse

object (SchemaRestrictionResponse)

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

string

Il codice valuta utilizzato in questo report. Da utilizzare per la formattazione delle metriche in valuta, come purchaseRevenue, per la visualizzazione. Se il codice valuta è stato specificato nella richiesta, questo parametro di risposta ripeterà il parametro della richiesta; in caso contrario, questo parametro di risposta è il codice valuta corrente della proprietà.

I codici valuta sono codifiche di stringhe dei tipi di valuta dello standard ISO 4217 (https://en.wikipedia.org/wiki/ISO_4217); ad esempio "USD", "EUR", "JPY". Per scoprire di più, consulta https://support.google.com/analytics/answer/9796179.
timeZone

string

Il fuso orario corrente della struttura. Destinato a essere utilizzato per interpretare dimensioni basate sul tempo come hour e minute. Formattate come stringhe del database dei fusi orari 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 è true, questo report è soggetto a una soglia e restituisce solo i dati che soddisfano le soglie minime di aggregazione. È possibile che una richiesta sia soggetta a una soglia e che non manchino dati nel report. Ciò accade quando tutti i dati sono superiori alle soglie. Per scoprire di più, consulta Soglie di dati e Informazioni su Dati demografici e interessi.

SchemaRestrictionResponse

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

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

object (ActiveMetricRestriction)

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

ActiveMetricRestriction

Una metrica limitata attivamente durante la creazione del report.

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

enum (RestrictedMetricType)

Il motivo della limitazione di questa metrica.
metricName

string

Il nome della metrica limitata.

RestrictedMetricType

Categorie di dati la cui visualizzazione potrebbe essere limitata in determinate proprietà Google Analytics.

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