Berichte zum Datenzugriff

Sie können Berichte zum Datenzugriff mit der Methode „Admin API v1“ runAccessReport erstellen. In diesem Bericht sehen Sie, wann ein Nutzer Google Analytics-Daten liest. Datensatzprotokolle werden bis zu zwei Jahre lang aufbewahrt. Berichte zum Datenzugriff sind nur für Nutzer mit der Rolle Administrator verfügbar.

Bericht zum Datenzugriff über die Clientbibliothek anfordern

Die schnellste Möglichkeit, mit Data Access-Berichten zu beginnen, ist die Verwendung der Clientbibliotheken.

Eine Anleitung zur Installation und Konfiguration der Google Analytics-Clientbibliotheken finden Sie in der Kurzanleitung.

Hier ist ein Beispiel für die Verwendung der Python-Clientbibliothek, mit der eine Datenzugriffsanfrage ausgeführt und die Antwort ausgegeben wird.

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

Gemeinsame Funktionen mit Standardberichten

Anfragen für Berichte zum Datenzugriff haben für viele gängige Funktionen dieselbe Semantik wie Core-Berichtsanfragen. Beispielsweise verhalten sich Paginierung, Dimensionsfilter und Zeiträume in beiden Berichtstypen gleich.

Machen Sie sich mit der Übersicht über Core-Berichte in der Data API v1 vertraut und kehren Sie dann zu dieser Seite zurück, um mehr über Berichte zum Datenzugriff zu erfahren.

Bericht zum Datenzugriff erstellen

Verwenden Sie die Methode runAccessReport, um einen Bericht zum Datenzugriff anzufordern.

Berichtsentität auswählen

Ähnlich wie bei der Hauptberichtsfunktion der Data API v1 muss bei der Methode runAccessReport der Google Analytics Admin API v1 die Google Analytics-Property-ID in einem URL-Anforderungspfad im Format properties/GA_PROPERTY_ID angegeben werden, z. B.:

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

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

Wenn Sie eine der Admin API-Clientbibliotheken verwenden, müssen Sie den Anfrage-URL-Pfad nicht manuell bearbeiten. Die meisten API-Clients bieten einen property-Parameter, der einen String im Format properties/GA_PROPERTY_ID erwartet. Ein Beispiel für die Verwendung der Clientbibliotheken finden Sie im Code-Snippet am Anfang dieser Seite.

Dimensionen und Messwerte auswählen

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 sind die quantitativen Messungen eines Berichts. Mit dem Messwert accessCount wird die Gesamtzahl der Datensätze für den Datenzugriff zurückgegeben.

Eine vollständige Liste der Dimensions- und Messwertnamen, die in Anfragen für Datenzugriffsberichte verfügbar sind, finden Sie im Schema für den Datenzugriff.

Bericht anfordern

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 dateRanges.
• Mindestens ein gültiger Eintrag im Feld dimensions.
• Wenn Sie die Dimension epochTimeMicros nicht verwenden, muss mindestens ein gültiger Eintrag im Feld metrics vorhanden sein, damit quantitative Daten für jede Kombination von Dimensionswerten in einem Bericht abgerufen werden können.

Hier ist eine Beispielanfrage mit den empfohlenen Feldern. Mit dieser Abfrage wird eine Liste mit Nutzer-E-Mail-Adressen, dem letzten Zugriffszeitpunkt auf die angegebene Property in den letzten 7 Tagen und der entsprechenden Anzahl der Zugriffe generiert.

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

Antwort lesen

Die Antwort auf den Datenzugriffsbericht besteht hauptsächlich aus einem Header und Zeilen. Der Header besteht aus AccessDimensionHeaders und AccessMetricHeaders, in denen die Spalten im Bericht aufgeführt sind.

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

Hier ist eine Beispielantwort auf 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
}

Zugriffsdatensätze filtern

Verwenden Sie das Feld dimensionFilter des Objekts RunAccessReportRequest, um die Berichtsantwort auf bestimmte Dimensionswerte zu beschränken, die dem Filter entsprechen.

Im folgenden Beispiel wird ein Bericht auf Grundlage einzelner Datensatzzugriffsdatensätze generiert, wobei nach Zugriffsdatensätzen eines einzelnen Nutzers mit der E‑Mail-Adresse Alex@example.net gefiltert wird. Der Bericht enthält die Uhrzeit jedes Zugriffsdatensatzes sowie die E-Mail- und IP-Adresse des Nutzers.

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

Entsprechend kann das Feld metricFilter des Objekts RunAccessReportRequest verwendet werden, um die Antwort des Berichts auf bestimmte Messwertwerte zu beschränken, die dem Filter entsprechen.

Im folgenden Beispiel wird ein Bericht mit E-Mail-Adressen und Zugriffszahlen aller Nutzer generiert, die mehr als 100-mal auf die angegebene Property zugegriffen haben.

{
  "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 Beispielberichte, die Sie ausprobieren können.

Letzter Zugriff

Das folgende Beispiel für einen Zugriffsbericht kann mit runAccessReport erstellt werden:

Dieser Bericht kann durch Abfragen der Dimensionen mostRecentAccessEpochTimeMicros, userEmail und des accessCount-Messwerts generiert werden. Der Bericht enthält eine Zeile für jeden Nutzer: Die Dimension mostRecentAccessEpochTimeMicros aggregiert Datenzugriffsdatensätze für jeden Nutzer, der auf die Property zugreift, und gibt für jede Zeile die letzte Zugriffszeit (in Unix-Mikrosekunden seit dem Epochenbeginn) zurück.

Aufschlüsselung des Nutzerzugriffs

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

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

Der Bericht enthält eine Zeile für jede Kombination aus Nutzer und Zugriffsmechanismus. Die Dimension mostRecentAccessEpochTimeMicros enthält den Zeitpunkt des letzten Zugriffs eines Nutzers auf die Property über den angegebenen Zugriffsmechanismus.

Übersicht über den Property-Zugriff

Es ist möglich, einen Bericht für eine Property zu erstellen, ohne ihn nach einzelnen Nutzern aufzuschlüsseln. Im folgenden Beispiel sehen Sie, wie oft auf eine Property über verschiedene Zugriffsmechanismen zugegriffen wird:

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

Der Bericht enthält eine Zeile für jede Kombination aus Property-ID und Zugriffsmechanismus.

Individueller Datenzugriff

Wenn Sie einen Bericht erstellen möchten, in dem jede Zeile auf einem einzelnen Datensatz für den Datenzugriff basiert, lassen Sie die Dimension mostRecentAccessEpochTimeMicros in einer Abfrage weg und verwenden Sie stattdessen die Dimension epochTimeMicros. Es ist nicht erforderlich, den Messwert accessCount abzufragen, da jede Zeile des Berichts Informationen zu einem einzelnen Datenzugriff enthält.

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

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