Überblick

Mit der Google Analytics Admin API Version 1 können Sie Berichte zum Datenzugriff mithilfe der Methode runAccessReport generieren. Im Bericht wird jedes Mal erfasst, wenn ein Nutzer Google Analytics-Berichtsdaten liest. Zugriffsdatensätze werden bis zu 2 Jahre aufbewahrt. Berichte zum Datenzugriff sind nur für Nutzer mit der Rolle Administrator verfügbar.

Bericht zum Datenzugriff erstellen

Datenzugriffsberichte werden über die Methode runAccessReport bereitgestellt.

Gemeinsame Funktionen mit Kernberichten

Anfragen für Datenzugriffe haben bei vielen gemeinsam genutzten Funktionen dieselbe Semantik wie Anfragen zu Kernberichten. Die Spezifikation Paginierung, Dimensionsfilter und Zeiträume verhalten sich in Berichten zum Datenzugriff beispielsweise genauso wie die grundlegenden Berichte.

Machen Sie sich mit der Übersicht über die grundlegenden Berichtsfunktionen der Data API (Version 1) vertraut. Im weiteren Verlauf dieses Dokuments geht es um die Funktionen für Datenzugriffsanfragen.

Eine meldende Entität auswählen

Ähnlich wie bei den zentralen Berichtsfunktionen der Data API Version 1 muss für die Methode runAccessReport der Google Analytics Admin API Version 1 die Google Analytics 4-Property-ID in einem URL-Anfragepfad im Format properties/GA4_PROPERTY_ID angegeben werden. Beispiel:

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

Der resultierende Bericht zum Datenzugriff wird auf Grundlage der Google Analytics-Datenzugriffseinträge für die angegebene Google Analytics 4-Property generiert.

Wenn Sie eine der Admin API-Clientbibliotheken verwenden, müssen Sie den URL-Pfad der Anfrage nicht manuell bearbeiten. Die meisten API-Clients bieten einen property-Parameter, der einen String in Form von properties/GA4_PROPERTY_ID erwartet. Im Code-Snippet am Ende dieser Anleitung finden Sie ein Beispiel für die Verwendung der Clientbibliotheken.

Dimensionen und Messwerte

Mit Dimensionen werden Zugriffsdaten für Ihre Property beschrieben und gruppiert. Die Dimension userEmail gibt beispielsweise die E-Mail-Adresse des Nutzers an, der auf Berichtsdaten zugegriffen hat. Dimensionswerte in Berichtsantworten sind Strings.

Messwerte stellen die quantitativen Messungen eines Berichts dar. Der Messwert accessCount gibt die Gesamtzahl der Datenzugriffseinträge zurück.

Eine vollständige Liste der Namen von Dimensionen und Messwerten, die in Datenzugriffsanfragen verfügbar sind, finden Sie unter Schema für den Datenzugriff.

Berichtsanfrage zum Datenzugriff

Wenn Sie Berichte zum Datenzugriff anfordern möchten, erstellen Sie ein RunAccessReportRequest-Objekt. Wir empfehlen, mit diesen Anfrageparametern zu beginnen:

  • Mindestens ein gültiger Eintrag im Feld Zeiträume
  • Mindestens ein gültiger Eintrag im Feld Dimensionen
  • Wenn Sie die Dimension epochTimeMicros nicht verwenden, ist mindestens ein gültiger Eintrag im Feld metrics erforderlich, um quantitative Daten für jede Kombination von Dimensionswerten in einem Bericht zu erhalten.

Hier ist eine Beispielanfrage mit den empfohlenen Feldern. Diese Abfrage generiert eine Liste mit Nutzer-E-Mail-Adressen, dem letzten Zugriff auf die angegebene Property im Zeitraum der letzten 7 Tage und die entsprechende Zugriffszahl.

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

Antwort melden

Die Antwortberichtsantwort für den Datenzugriff der Anfrage für den Zugriffsbericht besteht prinzipiell ähnlich wie die zentrale Berichterstellung der Data API Version 1 aus einer Kopfzeile und Zeilen. Der Header besteht aus AccessDimensionHeaders und AccessMetricHeaders, in denen die Spalten des Berichts aufgeführt sind.

Jede Zeile für den Zugriff auf den Bericht besteht aus AccessDimensionValues und AccessMetricValues für die Spalten im Bericht. Die Reihenfolge der Spalten in der Anfrage, im Header und in jeder Zeile ist einheitlich.

Hier ist eine Beispielantwort für die vorherige Beispielanfrage:

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

Nach Zugriffsdaten filtern

Mit dem Feld dimensionFilter des Objekts RunAccessReportRequest können Sie die Berichtsantwort auf bestimmte Dimensionswerte beschränken, die dem Filter entsprechen.

Im folgenden Beispiel wird ein Bericht erstellt, der auf einzelnen Datenzugriffsdatensätzen basiert und nach Zugriffsdatensätzen eines einzelnen Nutzers mit der E-Mail-Adresse Alex@example.net gefiltert wird. Der Bericht enthält die Uhrzeit jedes Zugriffseintrags sowie die E-Mail-Adresse und IP-Adresse des Nutzers.

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

In ähnlicher Weise kann das Feld metricFilter des Objekts RunAccessReportRequest verwendet werden, um die Berichtsantwort auf bestimmte Messwerte zu beschränken, die dem Filter entsprechen.

Im folgenden Beispiel wird ein Bericht erstellt, der E-Mails und die Anzahl der Zugriffe aller Nutzer enthält, die die angegebene Property mehr als 100-mal aufgerufen haben.

HTTP

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

Beispielberichte

Hier sind einige Sampler-Berichte, die Sie ausprobieren können.

Bericht "Letzter Zugriff pro Nutzer"

Hier sehen Sie ein Beispiel für einen Zugriffsbericht, der mit runAccessReport erstellt werden kann:

Epoche des letzten Zugriffs (in Mikrosekunden) E-Mail-Adresse des Nutzers Zugriffsanzahl
1525220215025371 Bola@example.net 5
1525220215028361 Alex@example.net 36
1525220215027671 Charlie@example.net 1153
1525220215027341 Mahan@example.net 1

Dieser Bericht kann durch Abfragen der Dimensionen mostRecentAccessEpochTimeMicros, userEmail und des Messwerts accessCount erstellt werden. Der Bericht enthält eine Zeile pro Nutzer: Die Dimension mostRecentAccessEpochTimeMicros fasst Datensätze der Datenzugriffe für jeden Nutzer zusammen, der auf die Property zugreift, und gibt für jede Zeile den Zeitpunkt des letzten Zugriffs (in Unix-Mikrosekunden seit der Epoche) zurück.

Aufschlüsselungsbericht zum Nutzerzugriff

Ein weiteres Beispiel für einen nützlichen Bericht ist die Aufschlüsselung der Nutzerzugriffe nach Zugriffsverfahren (z.B. Google Analytics-Benutzeroberfläche, API).

Epoche des letzten Zugriffs (in Mikrosekunden) E-Mail-Adresse des Nutzers Zugriffsmechanismus Zugriffsanzahl
1525220215028367 Alex@example.net Firebase 31
1525220215555778 Alex@example.net Google Analytics-Benutzeroberfläche 1
1525220215022378 Bola@example.net Google Analytics-Benutzeroberfläche 65
1525220215026389 Bola@example.net Google Analytics API 894
1525220215025631 Charlie@example.net Google Analytics API 67
1525220215068325 Mahan@example.net Google Ads 3

Dieser Bericht kann durch Abfragen der Dimensionen mostRecentAccessEpochTimeMicros, userEmail, accessMechanism und des Messwerts accessCount erstellt werden.

Der Bericht enthält eine Zeile pro Kombination aus Nutzer und Zugriffsmethode. Die Dimension mostRecentAccessEpochTimeMicros gibt an, wann ein Nutzer zuletzt mit dem angegebenen Zugriffsmechanismus auf die Property zugegriffen hat.

Bericht „Property-Zugriff – Übersicht“

Es ist möglich, einen Bericht für eine Property zu erstellen, ohne nach einzelnen Nutzern aufzuschlüsseln. Der folgende Bericht gibt beispielsweise an, wie oft mit verschiedenen Zugriffsmechanismen auf eine Property zugegriffen wird:

ID der Property, auf die zugegriffen wurde Name der aufgerufenen Property Zugriffsmechanismus Zugriffsanzahl
12345678 DemoApp Firebase 31
12345678 DemoApp Google Analytics-Benutzeroberfläche 624
12345678 DemoApp Google Ads 83
12345678 DemoApp Google Analytics API 1744

Dieser Bericht kann durch Abfragen der Dimensionen accessedPropertyId, accessedPropertyName, accessMechanism und des Messwerts accessCount erstellt werden.

Der Bericht enthält eine Zeile pro Kombination aus Property-ID und Zugriffsmechanismus.

Bericht zu einzelnen Datenzugriffen

Zum Erstellen eines Berichts, in dem jede Zeile auf einem einzelnen Datenzugriffseintrag basiert, können Sie die Dimension mostRecentAccessEpochTimeMicros in einer Abfrage weglassen und stattdessen die Dimension epochTimeMicros verwenden. Eine Abfrage des Messwerts accessCount ist nicht erforderlich, da jede Zeile des Berichts Informationen zu einem einzelnen Datenzugriffsvorkommen enthält.

Der folgende Bericht enthält detaillierte Informationen zu jedem Zugriff eines Nutzers auf die angegebene Property.

Epochenzeit (Micros) E-Mail-Adresse des Nutzers ID der Property, auf die zugegriffen wurde Name der aufgerufenen Property Nutzer-IP Zugriffsmechanismus Zurückgegebene Kostendaten Umsatzdaten zurückgegeben
1525220215025371 Bola@example.net 12345678 DemoApp 1.2.3.1 Google Analytics-Benutzeroberfläche true true
1525220645645645 Mahan@example.net 12345678 DemoApp 1.2.3.5 Google Analytics-Benutzeroberfläche 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 Google Analytics API true false
1525220132312333 Mahan@example.net 12345678 DemoApp 1.2.3.5 Google Ads true true

Dieser Bericht kann durch Abfragen der Dimensionen epochTimeMicros, userEmail, accessedPropertyId, accessedPropertyName, userIP, accessMechanism, costDataReturned und revenueDataReturned erstellt werden.

Clientbibliotheken

In der Kurzanleitung wird beschrieben, wie Sie Clientbibliotheken installieren und konfigurieren.

Im folgenden Beispiel wird die Python-Clientbibliothek verwendet, die eine Datenzugriffsabfrage ausführt und die Antwort ausgibt.

Python

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