Report di accesso ai dati

Puoi creare report sull'accesso ai dati utilizzando il metodo dell'API Admin v1 runAccessReport. Questo report mostra ogni volta che un utente legge i dati di Google Analytics. I record di accesso ai dati vengono conservati per un massimo di 2 anni. I report di accesso ai dati sono disponibili solo per gli utenti con il ruolo Amministratore.

Richiedere un report sull'accesso ai dati utilizzando la libreria client

Il modo più rapido per iniziare a utilizzare i report sull'accesso ai dati è utilizzare le librerie client.

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

Ecco un esempio che utilizza la libreria client Python per eseguire una query di accesso ai dati e stampare la risposta.

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

Funzionalità condivise con i report principali

Le richieste di report sull'accesso ai dati hanno la stessa semantica delle richieste di report principali requests per molte funzionalità comuni. Ad esempio la paginazione, i filtri delle dimensioni e gli intervalli di date si comportano allo stesso modo in entrambi i tipi di report.

Acquisisci familiarità con la panoramica dei report principali nell'API Data v1, quindi torna a questa pagina per saperne di più sui report sull'accesso ai dati.

Creare un report sull'accesso ai dati

Utilizza il runAccessReport per richiedere un report sull'accesso ai dati.

Selezionare un'entità di reporting

Analogamente alla funzionalità di reporting principale dell'API di dati v1, il metodo runAccessReport dell'API Google Analytics Admin v1 richiede che l'identificatore della proprietà Google Analytics sia specificato all'interno di un percorso della richiesta URL nel formato properties/GA_PROPERTY_ID, ad esempio:

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

Il report sull'accesso ai dati risultante viene generato in base ai record di accesso ai dati di Google Analytics per la proprietà Google Analytics specificata.

Se utilizzi una delle librerie client dell'API Admin, non è necessario manipolare manualmente il percorso dell'URL della richiesta. La maggior parte dei client API fornisce un parametro property che prevede una stringa nel formato properties/GA_PROPERTY_ID. Per un esempio di utilizzo delle librerie client, consulta lo snippet di codice all' inizio di questa pagina.

Scegliere 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 avuto accesso ai dati dei report. I valori delle dimensioni nelle risposte dei 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.

Per un elenco completo dei nomi delle dimensioni e delle metriche disponibili nelle richieste di report sull'accesso ai dati, consulta lo schema di accesso ai dati.

Richiedere il report

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

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

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

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

Leggere la risposta

La risposta del report sull'accesso ai dati è costituita principalmente da un'intestazione e da righe. L'intestazione è composta da AccessDimensionHeaders e AccessMetricHeaders , che elencano le colonne del report.

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

Di seguito è riportata una risposta di esempio alla richiesta di esempio precedente:

{
  "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
}

Filtrare i record di accesso

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

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

POST https://analyticsadmin.googleapis.com/v1beta/properties/GA_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"
      }
    }
  }
}

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

L'esempio seguente genera un report contenente gli indirizzi email e i conteggi degli accessi di tutti gli utenti che hanno avuto accesso alla proprietà specificata più di 100 volte.

{
  "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 report di esempio che puoi provare.

Accesso più recente

Di seguito è riportato un report di accesso di esempio che può essere creato utilizzando runAccessReport:

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

Suddivisione dell'accesso utente

Un altro esempio di report utile è una suddivisione degli accessi utente per meccanismo di accesso (ad es. interfaccia utente di Google Analytics, API e così via).

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

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

Panoramica dell'accesso alla proprietà

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

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

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

Accesso 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 report seguente contiene informazioni dettagliate su ogni volta che un utente ha avuto accesso alla proprietà specificata.

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