Method: properties.runAccessReport

Restituisce un report personalizzato dei record di accesso ai dati. Il report fornisce record relativi a ogni lettura dei dati dei report di Google Analytics da parte di un utente. I record degli accessi vengono conservati per un massimo di due anni.

È possibile richiedere i report di accesso ai dati per una proprietà. I report possono essere richiesti per qualsiasi proprietà, ma le dimensioni non correlate alla quota possono essere richieste solo nelle proprietà Google Analytics 360. Questo metodo è disponibile solo per gli amministratori.

Questi record sull'accesso ai dati includono i report sull'interfaccia utente di GA4, le esplorazioni dell'interfaccia utente di GA4, l'API di dati di GA4 e altri prodotti come Firebase e AdMob che possono recuperare i dati da Google Analytics tramite un collegamento. Questi record non includono le modifiche alla configurazione della proprietà, come l'aggiunta di uno stream o la modifica del fuso orario di una proprietà. Per la cronologia delle modifiche alla configurazione, consulta searchChangeHistoryEvents.

Richiesta HTTP

POST https://analyticsadmin.googleapis.com/v1beta/{entity=properties/*}:runAccessReport

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
entity

string

Il report sull'accesso ai dati supporta le richieste a livello di proprietà o di account. Se richiesto a livello di account, i report di accesso ai dati includono tutti gli accessi per tutte le proprietà di quell'account.

Per effettuare una richiesta a livello di proprietà, l'entità deve essere, ad esempio, "properties/123" se "123" è l'ID proprietà GA4. Per effettuare una richiesta a livello di account, l'entità deve essere, ad esempio, "accounts/1234" se "1234" è il tuo ID account GA4.

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Rappresentazione JSON
{
  "dimensions": [
    {
      object (AccessDimension)
    }
  ],
  "metrics": [
    {
      object (AccessMetric)
    }
  ],
  "dateRanges": [
    {
      object (AccessDateRange)
    }
  ],
  "dimensionFilter": {
    object (AccessFilterExpression)
  },
  "metricFilter": {
    object (AccessFilterExpression)
  },
  "offset": string,
  "limit": string,
  "timeZone": string,
  "orderBys": [
    {
      object (AccessOrderBy)
    }
  ],
  "returnEntityQuota": boolean,
  "includeAllUsers": boolean,
  "expandGroups": boolean
}
Campi
dimensions[]

object (AccessDimension)

Le dimensioni richieste e visualizzate nella risposta. Nelle richieste sono consentite fino a nove dimensioni.

metrics[]

object (AccessMetric)

Le metriche richieste e visualizzate nella risposta. Per le richieste sono consentite fino a 10 metriche.

dateRanges[]

object (AccessDateRange)

Intervalli di date dei record di accesso da leggere. Se sono richiesti più intervalli di date, ogni riga di risposta conterrà un indice di intervalli di date in base zero. Se due intervalli di date si sovrappongono, i record di accesso per i giorni che si sovrappongono vengono inclusi nelle righe di risposta per entrambi gli intervalli. Le richieste sono consentite fino a un massimo di 2 intervalli di date.

dimensionFilter

object (AccessFilterExpression)

I filtri delle dimensioni ti consentono di limitare la risposta al report a valori di dimensione specifici che corrispondono al filtro. Ad esempio, filtrando in base ai record di accesso di un singolo utente. Per scoprire di più, consulta gli esempi sulle Nozioni di base sui filtri delle dimensioni. Le metriche non possono essere utilizzate in questo filtro.

metricFilter

object (AccessFilterExpression)

I filtri delle metriche ti consentono di limitare la risposta del report a valori specifici delle metriche corrispondenti al filtro. I filtri delle metriche vengono applicati dopo aver aggregato le righe del report, in modo simile a una clausola relativa a SQL. Le dimensioni non possono essere utilizzate in questo filtro.

offset

string (int64 format)

Il conteggio delle righe della riga iniziale. La prima riga viene conteggiata come riga 0. Se l'offset non è specificato, viene considerato come 0. Se l'offset è pari a zero, questo metodo restituirà la prima pagina dei risultati con voci limit.

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

limit

string (int64 format)

Il numero di righe da restituire. Se non specificato, vengono restituite 10.000 righe. L'API restituisce un massimo di 100.000 righe per richiesta, indipendentemente da quante ne hai richieste. Il valore limit deve essere positivo.

L'API potrebbe restituire un numero inferiore di righe rispetto al valore limit richiesto, a patto che il numero di righe rimanente sia inferiore a quello dell'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.

timeZone

string

Fuso orario di questa richiesta, se specificato. Se non specificato, viene utilizzato il fuso orario della proprietà. Il fuso orario della richiesta viene utilizzato per interpretare le date di inizio e di fine del report.

Formattati come stringhe dal database dei fusi orari IANA (https://www.iana.org/time-zones); ad esempio "America/New_York" o "Asia/Tokyo".

orderBys[]

object (AccessOrderBy)

Specifica l'ordine delle righe nella risposta.

returnEntityQuota

boolean

Attiva/disattiva se restituire lo stato corrente della quota di questa proprietà Analytics. La quota viene restituita in AccessQuota. Per le richieste a livello di account, questo campo deve essere false.

includeAllUsers

boolean

Facoltativo. Consente di stabilire se includere nella risposta gli utenti che non hanno mai effettuato una chiamata API. Se true, tutti gli utenti con accesso alla proprietà o all'account specificati vengono inclusi nella risposta, indipendentemente dal fatto che abbiano effettuato o meno una chiamata API. Se il valore è false, verranno inclusi solo gli utenti che hanno effettuato una chiamata API.

expandGroups

boolean

Facoltativo. Decide se restituire gli utenti all'interno di gruppi di utenti. Questo campo funziona solo quando includiAllUsers è impostato su true. Se il valore è true, verranno restituiti tutti gli utenti con accesso alla proprietà o all'account specificati. Se il valore è false, verranno restituiti solo gli utenti con accesso diretto.

Corpo della risposta

In caso di esito positivo, il corpo della risposta contiene un'istanza di RunAccessReportResponse.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

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