Method: properties.reportTasks.query

Recupera i contenuti di un'attività di report. Dopo aver richiesto il reportTasks.create, puoi recuperare i contenuti del report una volta che questo è ATTIVO. Questo metodo restituirà un errore se lo stato dell'attività di report non è ACTIVE. Una risposta alla query restituirà i valori di riga e colonna tabellari 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 del report. 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 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 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. Il numero di righe disponibili per una QueryReportTaskRequest è ulteriormente limitato dal limite di ReportTask associato. Una query può recuperare al massimo ReportTask.limit righe. Ad esempio, se ReportTask ha un limite di 1000, una richiesta reportTasks.query con offset=900 e limite=500 restituirà al massimo 100 righe.

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

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