Method: properties.reportTasks.query

Recupera i contenuti di un'attività report. Dopo aver richiesto reportTasks.create, puoi recuperare i contenuti del report quando diventa ATTIVO. Questo metodo restituirà un errore se lo stato dell'attività di report non è ACTIVE. Una risposta alla query restituirà i valori di righe e 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

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

Campo 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 delle righe. La seconda richiesta imposta l'offset al valore limit della prima richiesta, mentre la seconda restituisce il secondo valore limit delle righe.

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

string (int64 format)

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

L'API può anche restituire meno righe rispetto al valore limit richiesto, se il numero di valori della dimensione è inferiore a limit. Il numero di righe disponibili per un 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 1000, 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 Impaginazione.

Corpo della risposta

I contenuti del report corrispondenti a un'attività 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 QuoteHeader e l'ordine di QuoteHeaders corrisponde 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 che includono 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 true, indica che alcuni bucket di combinazioni di dimensioni vengono raggruppati nella riga "(other)". 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 nei dati aggregati di input utilizzati per generare il 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.
schemaRestrictionResponse

object (SchemaRestrictionResponse)

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

string

Il codice valuta utilizzato in questo report. Destinato a essere utilizzato nella formattazione di metriche di valuta come purchaseRevenue per la visualizzazione. Se nella richiesta è stato specificato currencyCode, questo parametro di risposta emetterà un'eco del parametro della richiesta; in caso contrario, questo parametro di risposta sarà l'attuale currencyCode 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 ulteriori informazioni, consulta la pagina https://support.google.com/analytics/answer/9796179.
timeZone

string

Il fuso orario corrente della proprietà. Destinato a essere utilizzato per interpretare le 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 sarà vuoto per questo motivo.
subjectToThresholding

boolean

Se subjectToThresholding è true, questo report è soggetto a soglia e restituisce solo i dati che soddisfano le soglie minime di aggregazione. È possibile che una richiesta sia soggetta a soglia di soglia e che non siano assenti dati nel report, ovvero quando tutti i dati superano le soglie. Per scoprire di più, consulta Soglie di dati e Informazioni su dati demografici e interessi.

SchemaRestrictionResponse

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.

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

object (ActiveMetricRestriction)

Tutte le restrizioni sono 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 attivamente limitata 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 con restrizioni.

RestrictedMetricType

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

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