Panoramica

La versione 1 dell'API Admin di Google Analytics ti consente di generare report di accesso ai dati utilizzando il metodo runAccessReport. Il report fornisce record di 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. I report di accesso ai dati sono disponibili solo per gli utenti con il ruolo di Amministratore.

Creazione di un report di accesso ai dati

I report sugli accessi ai dati sono forniti dal metodo runAccessReport.

Funzionalità condivise con i report principali

Le richieste dei report di accesso ai dati hanno la stessa semantica delle richieste di report principali, per molte funzionalità condivise. Ad esempio, nei report di accesso ai dati, nei report di accesso ai dati, le specifiche per impaginazione, filtri delle dimensioni e intervalli di date si comportano allo stesso modo dei report principali.

Acquisisci familiarità con la panoramica della funzionalità di reporting di base dell'API di dati v1, poiché la parte restante di questo documento è incentrata sulle funzionalità specifiche per le richieste di report Accesso ai dati.

Selezione di un'entità di reporting

Analogamente alla funzionalità di generazione di report principale dell'API di dati v1, il metodo runAccessReport dell'API Google Analytics Admin v1 richiede che l'identificatore della proprietà Google Analytics 4 venga specificato all'interno di un percorso di richiesta dell'URL sotto forma di properties/GA4_PROPERTY_ID, ad esempio:

  POST  https://analyticsadmin.googleapis.com/v1beta/properties/GA4_PROPERTY_ID:runAccessReport

Il report sugli accessi ai dati risultante verrà generato in base ai record di accesso ai dati di Google Analytics per la proprietà Google Analytics 4 specificata.

Se utilizzi una delle librerie client dell'API Admin, non è necessario modificare manualmente il percorso dell'URL della richiesta. La maggior parte dei client API fornisce un parametro property che prevede una stringa nella forma di properties/GA4_PROPERTY_ID. Consulta lo snippet di codice alla fine di questa guida per un esempio sull'utilizzo delle librerie client.

Dimensioni e metriche

Le dimensioni descrivono e raggruppano i dati di accesso per la tua proprietà. Ad esempio, la dimensione userEmail indica l'email dell'utente che ha eseguito l'accesso ai dati dei report. I valori di dimensione nelle risposte al report sono stringhe.

Le metriche rappresentano le misurazioni quantitative di un report. La metrica accessCount restituisce il numero totale di record di accesso ai dati.

Consulta lo schema di accesso ai dati per un elenco completo dei nomi di dimensioni e metriche disponibili nelle richieste di report di accesso ai dati.

Richiesta report di accesso ai dati

Per richiedere i report di accesso ai dati, crea un oggetto RunAccessReportRequest. Ti consigliamo di iniziare con questi parametri di richiesta:

  • Almeno una voce valida nel campo degli intervalli di date.
  • Almeno una voce valida nel campo dimensioni.
  • Se non utilizzi la dimensione epochTimeMicros, almeno una voce valida nel campo metrics per ricevere dati quantitativi per ogni combinazione di valori di dimensione in un report.

Ecco una richiesta di esempio con i campi consigliati. Questa query genererà un elenco di email degli utenti, l'ultima volta in cui hanno eseguito l'accesso alla proprietà specificata nell'intervallo degli ultimi 7 giorni e il numero di accessi corrispondente.

HTTP

POST https://analyticsadmin.googleapis.com/v1beta/properties/GA4_PROPERTY_ID:runAccessReport
{
  "dateRanges": [
    {
      "startDate": "7daysAgo",
      "endDate": "today"
    }
  ],
  "dimensions": [
    {
      "dimensionName": "mostRecentAccessEpochTimeMicros"
    },
    {
      "dimensionName": "userEmail"
    }
  ],
  "metrics": [
    {
      "metricName": "accessCount"
    }
  ]
}

Segnala risposta

Concettualmente simile alla funzionalità di reporting principale dell'API di dati v1, la risposta al report di accesso ai dati della richiesta del report di accesso è principalmente un'intestazione e delle righe. L'intestazione è composta da AccessDimensionHeaders e AccessMetricHeaders, che elencano le colonne del report.

Ogni riga del report di accesso è composta da AccessDimensionValues e AccessMetricValues per le colonne del report. L'ordine delle colonne è coerente nella richiesta, nell'intestazione e in ogni riga.

Ecco un esempio di risposta per la precedente richiesta di esempio:

{
  "dimensionHeaders": [
    {
      "dimensionName": "mostRecentAccessEpochTimeMicros"
    },
    {
      "dimensionName": "userEmail"
    }
  ],
  "metricHeaders": [
    {
      "metricName": "accessCount"
    }
  ],
  "rows": [
    {
      "dimensionValues": [
        {
          "value": "1667591408427733"
        },
        {
          "value": "Bola@example.net"
        }
      ],
      "metricValues": [
        {
          "value": "1238"
        }
      ]
    },
    {
      "dimensionValues": [
        {
          "value": "1667710959827161"
        },
        {
          "value": "Alex@example.net"
        }
      ],
      "metricValues": [
        {
          "value": "475"
        }
      ]
    },
    {
      "dimensionValues": [
        {
          "value": "1667868650762743"
        },
        {
          "value": "Mahan@example.net"
        }
      ],
      "metricValues": [
        {
          "value": "96"
        }
      ]
    }
  ],
  "rowCount": 3
}

Filtro dei record di accesso

Utilizza il campo dimensionFilter dell'oggetto RunAccessReportRequest per limitare la risposta del report a valori specifici della dimensione che corrispondono al filtro.

L'esempio seguente genera un report basato sui singoli record di accesso ai dati, filtrando in base ai record di accesso di un singolo utente con indirizzo email Alex@example.net. Il report contiene l'ora di ogni record di accesso, l'email e l'indirizzo IP dell'utente.

HTTP

POST https://analyticsadmin.googleapis.com/v1beta/properties/GA4_PROPERTY_ID:runAccessReport
{
  "dateRanges": [
    {
      "startDate": "7daysAgo",
      "endDate": "today"
    }
  ],
  "dimensions": [
    {
      "dimensionName": "epochTimeMicros"
    },
    {
      "dimensionName": "userEmail"
    },
    {
      "dimensionName": "userIP"
    }
  ],
  "dimensionFilter": {
    "accessFilter": {
      "fieldName": "userEmail",
      "stringFilter": {
        "matchType": "EXACT",
        "value": "Alex@example.net"
      }
    }
  }
}

Analogamente, il campo metricFilter dell'oggetto RunAccessReportRequest può essere utilizzato per limitare la risposta del report a valori specifici di metriche che corrispondono al filtro.

L'esempio seguente genera un report contenente gli indirizzi email e il numero di accessi di tutti gli utenti che hanno eseguito l'accesso alla proprietà specificata più di 100 volte.

HTTP

{
  "dateRanges": [
    {
      "startDate": "7daysAgo",
      "endDate": "today"
    }
  ],
  "dimensions": [
    {
      "dimensionName": "userEmail"
    }
  ],
  "metricFilter": {
    "accessFilter": {
      "numericFilter": {
        "operation": "GREATER_THAN",
        "value": {
          "int64Value": 100
        }
      },
      "fieldName": "accessCount"
    }
  },
  "metrics": [
    {
      "metricName": "accessCount"
    }
  ]
}

Report di esempio

Ecco alcuni esempi di report che puoi provare.

Report Accesso per utente più recente

Il seguente report di accesso di esempio che può essere creato utilizzando runAccessReport:

Ora epoch di accesso più recente in micro Indirizzo email dell'utente Numero di accessi
1525220215025371 Bola@example.net 5
1525220215028361 Alex@example.net 36
1525220215027671 Charlie@example.net 1153
1525220215027341 Mahan@example.net 1

Questo report può essere generato eseguendo query sulle dimensioni mostRecentAccessEpochTimeMicros, userEmail e sulla metrica accessCount. Il report contiene una riga per ciascun utente: la dimensione mostRecentAccessEpochTimeMicros aggrega i record di accesso ai dati per ogni utente che accede alla proprietà e restituisce l'ora dell'ultimo accesso (in microsecondi Unix dall'epoca) per ogni riga.

Report Analisi degli accessi utente

Un altro esempio di report utile è l'analisi degli accessi degli utenti in base al meccanismo di accesso (ad es. interfaccia utente di Google Analytics, API e così via).

Ora epoch di accesso più recente in micro Indirizzo email dell'utente Meccanismo di accesso Numero di accessi
1525220215028367 Alex@example.net Firebase 31
1525220215555778 Alex@example.net Interfaccia utente di Google Analytics 1
1525220215022378 Bola@example.net Interfaccia utente di Google Analytics 65
1525220215026389 Bola@example.net API Google Analytics 894
1525220215025631 Charlie@example.net API Google Analytics 67
1525220215068325 Mahan@example.net Google Ads 3

Questo report può essere generato eseguendo query sulle dimensioni mostRecentAccessEpochTimeMicros, userEmail, accessMechanism e sulla metrica accessCount.

Il report contiene una riga per ogni combinazione utente/meccanismo di accesso. La dimensione mostRecentAccessEpochTimeMicros contiene l'ultima volta che un utente ha eseguito l'accesso alla proprietà utilizzando il meccanismo di accesso specificato.

Report Panoramica dell'accesso alla proprietà

È possibile generare un report per una proprietà senza suddividere i singoli utenti. Ad esempio, il seguente report indica la frequenza di accesso a una proprietà utilizzando diversi meccanismi di accesso:

ID proprietà a cui è stato eseguito l'accesso Nome proprietà a cui è stato eseguito l'accesso Meccanismo di accesso Numero di accessi
12345678 DemoApp Firebase 31
12345678 DemoApp Interfaccia utente di Google Analytics 624
12345678 DemoApp Google Ads 83
12345678 DemoApp API Google Analytics 1744

Questo report può essere generato eseguendo query sulle dimensioni accessedPropertyId, accessedPropertyName, accessMechanism e sulla metrica accessCount.

Il report contiene una riga per ogni combinazione di ID proprietà/meccanismo di accesso.

Report sugli accessi ai singoli dati

Per generare un report in cui ogni riga si basa su un singolo record di accesso ai dati, ometti la dimensione mostRecentAccessEpochTimeMicros da una query e utilizza invece la dimensione epochTimeMicros. Non è necessario eseguire una query sulla metrica accessCount, poiché ogni riga del report contiene informazioni su una singola occorrenza di accesso ai dati.

Il seguente report contiene informazioni dettagliate su ogni volta che un utente ha eseguito l'accesso alla proprietà specificata.

Micro tempo epoca Indirizzo email dell'utente ID proprietà a cui è stato eseguito l'accesso Nome proprietà a cui è stato eseguito l'accesso IP dell'utente Meccanismo di accesso Dati di costo restituiti Dati sulle entrate restituiti
1525220215025371 Bola@example.net 12345678 DemoApp 1.2.3.1 Interfaccia utente di Google Analytics true true
1525220645645645 Mahan@example.net 12345678 DemoApp 1.2.3.5 Interfaccia utente di Google Analytics false false
1525220211312322 Bola@example.net 12345678 DemoApp 11.22.33.11 Google Ads true false
1525220210234221 Alex@example.net 12345678 DemoApp 11.22.33.22 Firebase false false
1525220215028368 Alex@example.net 12345678 DemoApp 1.2.3.2 Google Ads false false
1525220214234231 Mahan@example.net 12345678 DemoApp 11.22.33.55 Google Ads true true
1525220423423452 Charlie@example.net 12345678 DemoApp 1.2.3.3 API Google Analytics true false
1525220132312333 Mahan@example.net 12345678 DemoApp 1.2.3.5 Google Ads true true

Questo report può essere generato eseguendo query su dimensioni epochTimeMicros, userEmail, accessedPropertyId, accessedPropertyName, userIP, accessMechanism, costDataReturned e revenueDataReturned.

Librerie client

Per una spiegazione su come installare e configurare le librerie client, consulta la guida rapida.

Ecco un esempio utilizzando la libreria client Python che esegue una query di accesso ai dati e stampa la risposta.

Python

google-analytics-admin/properties_run_access_report.py
Apri in Cloud Shell Visualizza su GitHub 
from datetime import datetime

from google.analytics.admin import AnalyticsAdminServiceClient
from google.analytics.admin_v1alpha.types import (
    AccessDateRange,
    AccessDimension,
    AccessMetric,
    RunAccessReportRequest,
)


def run_sample():
    """Runs the sample."""
    # TODO(developer): Replace this variable with your Google Analytics 4
    #  property ID (e.g. "123456") before running the sample.
    property_id = "YOUR-GA4-PROPERTY-ID"
    run_access_report(property_id)


def run_access_report(property_id: str, transport: str = None):
    """
    Runs an access report for a Google Analytics property. The report will
    aggregate over dimensions `userEmail`, `accessedPropertyId`,
    `reportType`, `revenueDataReturned`, `costDataReturned`,
    `userIP`, and return the access count, as well as the most recent access
    time for each combination.
    See https://developers.google.com/analytics/devguides/config/admin/v1/access-api-schema
    for the description of each field used in a data access report query.
    Args:
        property_id(str): The Google Analytics Property ID.
        transport(str): The transport to use. For example, "grpc"
            or "rest". If set to None, a transport is chosen automatically.
    """
    client = AnalyticsAdminServiceClient(transport=transport)
    request = RunAccessReportRequest(
        entity=f"properties/{property_id}",
        dimensions=[
            AccessDimension(dimension_name="userEmail"),
            AccessDimension(dimension_name="accessedPropertyId"),
            AccessDimension(dimension_name="reportType"),
            AccessDimension(dimension_name="revenueDataReturned"),
            AccessDimension(dimension_name="costDataReturned"),
            AccessDimension(dimension_name="userIP"),
            AccessDimension(dimension_name="mostRecentAccessEpochTimeMicros"),
        ],
        metrics=[AccessMetric(metric_name="accessCount")],
        date_ranges=[AccessDateRange(start_date="yesterday", end_date="today")],
    )

    access_report = client.run_access_report(request)

    print("Result:")
    print_access_report(access_report)


def print_access_report(response):
    """Prints the access report."""
    print(f"{response.row_count} rows received")
    for dimensionHeader in response.dimension_headers:
        print(f"Dimension header name: {dimensionHeader.dimension_name}")
    for metricHeader in response.metric_headers:
        print(f"Metric header name: {metricHeader.metric_name})")

    for rowIdx, row in enumerate(response.rows):
        print(f"\nRow {rowIdx}")
        for i, dimension_value in enumerate(row.dimension_values):
            dimension_name = response.dimension_headers[i].dimension_name
            if dimension_name.endswith("Micros"):
                # Convert microseconds since Unix Epoch to datetime object.
                dimension_value_formatted = datetime.utcfromtimestamp(
                    int(dimension_value.value) / 1000000
                )
            else:
                dimension_value_formatted = dimension_value.value
            print(f"{dimension_name}: {dimension_value_formatted}")

        for i, metric_value in enumerate(row.metric_values):
            metric_name = response.metric_headers[i].metric_name
            print(f"{metric_name}: {metric_value.value}")


properties_run_access_report.py