Method: accounts.runAccessReport

Restituisce un report personalizzato dei record di accesso ai dati. Il report fornisce record di ogni volta che un utente legge i dati dei report di Google Analytics. I record degli accessi vengono conservati per un massimo di 2 anni.

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

Questi record di accesso ai dati includono i report sull'interfaccia utente di GA, le esplorazioni dell'interfaccia utente di GA, l'API di dati di GA e altri prodotti come Firebase e AdMob in grado di 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, vedi searchChangeHistoryEvents.

Per inviare il tuo feedback su questa API, compila il modulo di feedback ai report di accesso a Google Analytics.

Richiesta HTTP

POST https://analyticsadmin.googleapis.com/v1alpha/{entity=accounts/*}:runAccessReport

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
entity

string

Il report di 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 tutto l'accesso per tutte le proprietà in 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 la 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. Le 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 intervallo di date basato su zero. Se due intervalli di date si sovrappongono, i record di accesso per i giorni che si sovrappongono sono inclusi nelle righe di risposta per entrambi gli intervalli di date. Per le richieste sono consentiti fino a due intervalli di date.

dimensionFilter

object (AccessFilterExpression)

I filtri delle dimensioni ti consentono di limitare le risposte ai report a valori specifici di dimensioni che corrispondono al filtro. Ad esempio, applicare un filtro in base ai record di accesso di un singolo utente. Per ulteriori informazioni, consulta la sezione Concetti fondamentali dei filtri delle dimensioni per alcuni esempi. Le metriche non possono essere utilizzate in questo filtro.

metricFilter

object (AccessFilterExpression)

I filtri delle metriche consentono di limitare le risposte ai report a valori specifici di metriche che corrispondono al filtro. I filtri delle metriche vengono applicati dopo aver aggregato le righe del report, in modo simile alla clausola 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 0. Se l'offset è zero, questo metodo restituirà la prima pagina dei risultati con voci limit.

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

limit

string (int64 format)

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

L'API potrebbe restituire meno righe rispetto al valore limit richiesto, se il numero di righe rimanente è inferiore a quello di limit. Ad esempio, esistono meno di 300 valori possibili per la dimensione country. Di conseguenza, 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, consulta Pagination.

timeZone

string

Il 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 i valori di inizio & date di fine del report.

Formattate come stringhe dal database del fuso orario 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

Consente di scegliere se restituire lo stato attuale 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) Determina se includere nella risposta gli utenti che non hanno mai effettuato una chiamata API. Se impostato su true, tutti gli utenti con accesso alla proprietà o all'account specificati sono inclusi nella risposta, indipendentemente dal fatto che abbiano effettuato o meno una chiamata API. Se il valore è false, vengono inclusi solo gli utenti che hanno effettuato una chiamata API.

expandGroups

boolean

(Facoltativo) Decide se restituire gli utenti all'interno dei gruppi di utenti. Questo campo funziona solo quando includeAllUsers è impostato su true. Se impostato su 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