Übersicht

Mit der Google Analytics Admin API Version 1 können Sie mithilfe von runAccessReport . Der Bericht zeichnet jedes Mal auf, wenn ein Nutzer Google Analytics liest. Berichtsdaten. Zugriffsdatensätze werden bis zu 2 Jahre lang aufbewahrt. Datenzugriff Berichte sind nur für Nutzer mit der Rolle Administrator verfügbar.

Datenzugriffsbericht erstellen

Die Berichte zum Datenzugriff werden vom runAccessReport abrufen.

Gemeinsam genutzte Funktionen für grundlegende Berichte

Anfragen für Datenzugriffsberichte weisen dieselbe Semantik in Hauptberichten auf -Anfragen für viele gemeinsam genutzte Funktionen. Beispiel: Die Spezifikationen für Paginierung, Dimensionsfilter und Zeiträume sind identisch. in Datenzugriffsberichten als grundlegende Berichte.

Machen Sie sich mit dem Überblick über die zentralen Berichtsfunktionen von der Data API Version 1. In diesem Dokument geht es um die speziellen Funktionen für Datenzugriffsberichte.

Berichtseinheit auswählen

Ähnlich wie die zentrale Berichterstellung Funktionalität der Data API Version 1, runAccessReport Methode der Google Analytics Admin API v1 erfordert die Google Analytics- Property-ID, die innerhalb angegeben werden muss einen URL-Anfragepfad im Format properties/GA_PROPERTY_ID, z. B.:

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

Der resultierende Bericht zum Datenzugriff wird basierend auf den Datenzugriffseinträge für die angegebene Google Analytics-Property.

Wenn Sie eine der Admin API-Clientbibliotheken verwenden: muss der Anforderungs-URL-Pfad nicht manuell bearbeitet werden. Die meisten API-Clients Einen property-Parameter angeben, der einen String in der Form von properties/GA_PROPERTY_ID. Das Code-Snippet befindet sich auf der Ende dieses Leitfadens finden Sie ein Beispiel für die Verwendung der Clientbibliotheken.

Dimensionen und Messwerte

Abmessungen beschreiben und gruppieren Sie die Zugriffsdaten für Ihre Property. Beispielsweise kann die Dimension userEmail gibt die E-Mail-Adresse des Nutzers an, der auf Berichtsdaten zugegriffen hat. Dimensionswerte in Berichtsantworten sind Strings.

Messwerte quantitative Messungen eines Berichts darstellen. Der Messwert accessCount gibt die Gesamtzahl der Datenzugriffsdatensätze zurück.

Unter Datenzugriffsschema finden Sie eine vollständige Liste der Dimensionen und Messwertnamen, die in Anfragen für Datenzugriffsberichte verfügbar sind.

Anfrage zum Datenzugriffsbericht

Erstellen Sie ein RunAccessReportRequest-Objekt, um Datenzugriffsberichte anzufordern. Mi. empfehlen wir, mit den folgenden Anfrageparametern zu beginnen:

• Mindestens ein gültiger Eintrag im Datum Bereiche ein.
• Mindestens ein gültiger Eintrag im Feld Dimensionen ein.
• Wenn Sie die Dimension epochTimeMicros nicht verwenden, muss mindestens ein gültiger Eintrag in die Messwerte enthalten, um quantitative Daten für jede Kombination von Dimensionswerten in einen Bericht.

Hier ist eine Beispielanfrage mit den empfohlenen Feldern. Durch diese Abfrage wird ein Liste der E-Mail-Adressen von Nutzern; der letzte Zugriff auf die angegebene Property innerhalb der letzten 7 Tage und die entsprechende Anzahl der Zugriffe.

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 melden

Ähnlich wie die zentrale Berichterstellung Funktionalität der Data API v1 haben, Datenzugriffsbericht Antwort der Zugriffsberichtsanforderung besteht in erster Linie aus einer Kopfzeile und Zeilen. Der Header besteht aus AccessDimensionHeaders und AccessMetricHeaders die die Spalten im Bericht aufführen.

Jeder Zugriffsbericht Zeile besteht aus AccessDimensionValues und AccessMetricValues für die Spalten im Bericht. Die Reihenfolge der Spalten ist in der -Anforderung, den Header und jede Zeile.

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
}

Zugriffsdatensätze filtern

Verwenden Sie die Methode dimensionFilter im Bereich RunAccessReportRequest , um die Berichtsantwort auf bestimmte Dimensionswerte zu beschränken, die den Werten aus.

Im folgenden Beispiel wird ein Bericht basierend auf dem individuellen Datenzugriff generiert Datensätze, Filterung nach Zugriffsdatensätzen eines einzelnen Nutzers mit E-Mail-Adresse Alex@example.net Der Bericht enthält die Uhrzeit jedes Zugriffseintrags, E-Mail-Adresse und IP-Adresse.

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

In ähnlicher Weise metricFilter im Bereich RunAccessReportRequest kann verwendet werden, um die Antwort in Berichten auf bestimmte Messwerte zu beschränken, entsprechen dem Filter.

Im folgenden Beispiel wird ein Bericht erstellt, der E-Mails und Zugriffszahlen von Alle Nutzer, 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.

Bericht zum letzten Zugriff pro Nutzer

Im Folgenden finden Sie ein Beispiel für einen Zugriffsbericht, der mit runAccessReport erstellt werden kann:

Dieser Bericht kann durch folgende Abfrage erstellt werden: dimensions mostRecentAccessEpochTimeMicros userEmail und den Messwert accessCount. Die Der Bericht enthält eine Zeile pro Nutzer: mostRecentAccessEpochTimeMicros fasst die Datenzugriffsdatensätze für jeden Nutzer zusammen, der auf die Property zugreift. und gibt den Zeitpunkt des letzten Zugriffs (in Unix-Mikrosekunden seit dem Epoche) für jede Zeile.

Aufschlüsselungsbericht zum Nutzerzugriff

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

Dieser Bericht kann durch folgende Abfrage erstellt werden: dimensions mostRecentAccessEpochTimeMicros userEmail, accessMechanism und accessCount Messwert.

Der Bericht enthält für jede Kombination aus Nutzer/Zugriffsmechanismus eine Zeile. Die Die Dimension „mostRecentAccessEpochTimeMicros“ gibt an, wann ein Nutzer zuletzt über den angegebenen Zugriffsmechanismus auf die Property zugegriffen hat.

Bericht „Property-Zugriff – Übersicht“

Sie können einen Bericht für eine Property erstellen, ohne für einzelne Nutzer. Im folgenden Bericht sehen Sie z. B., wie oft eine Property Der Zugriff erfolgt über verschiedene Zugriffsmechanismen:

Dieser Bericht kann durch folgende Abfrage erstellt werden: dimensions accessedPropertyId accessedPropertyName, accessMechanism und accessCount Messwert.

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

Bericht zu einzelnen Datenzugriffen

Um einen Bericht zu erstellen, in dem jede Zeile auf einem individuellen Datenzugriff basiert mostRecentAccessEpochTimeMicros-Dimension in einer Abfrage weglassen und verwenden Sie stattdessen die Dimension epochTimeMicros. Es ist nicht notwendig, accessCount, da jede Zeile des Berichts Informationen zu einem für einen einzelnen Datenzugriff.

Der folgende Bericht enthält detaillierte Informationen dazu, auf die angegebene Property zugegriffen hat.

Dieser Bericht kann durch folgende Abfrage erstellt werden: Dimensionen epochTimeMicros, userEmail accessedPropertyId, accessedPropertyName, userIP, accessMechanism, costDataReturned, revenueDataReturned.

Clientbibliotheken

In der Kurzanleitung finden Sie eine Erläuterung der Clientbibliotheken installieren und konfigurieren

Hier ist ein Beispiel, in dem die Python-Clientbibliothek verwendet wird, die eine Datenzugriffsabfrage ausführt und gibt die Antwort aus.

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