Przegląd

Interfejs Google Analytics Admin API w wersji 1 umożliwia generowanie raportów dostępu do danych za pomocą metody runAccessReport. Raport zawiera zapis każdego odczytu przez użytkownika danych raportowania Google Analytics. Rekordy dostępu są przechowywane przez maksymalnie 2 lata. Raporty o dostępie do danych są dostępne tylko dla użytkowników z rolą administratora.

Tworzenie raportu dostępu do danych

Raportowanie o dostępie do danych jest obsługiwane przez metodę runAccessReport.

Wspólne funkcje w podstawowych raportach

W przypadku wielu udostępnionych funkcji żądania raportów o dostępie do danych mają tę samą semantykę co żądania raportów podstawowych. Na przykład Podział na strony, Filtry wymiarów i specyfikacja zakresów dat w raportach o dostępie do danych działają tak samo jak w raportach podstawowych.

Zapoznaj się z omówieniem podstawowych funkcji raportowania interfejsu Data API w wersji 1, ponieważ w dalszej części tego dokumentu znajdziesz informacje o funkcjach związanych z żądaniami raportu o dostępie do danych.

Wybór podmiotu raportującego

Podobnie jak w przypadku głównych funkcji raportowania w interfejsie Data API w wersji 1 metoda runAccessReport w interfejsie Google Analytics Admin API w wersji 1 wymaga określenia identyfikatora usługi Google Analytics 4 w ścieżce żądania adresu URL w postaci properties/GA4_PROPERTY_ID, np.:

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

Otrzymany raport o dostępie do danych zostanie wygenerowany na podstawie rekordów dostępu do danych Google Analytics w przypadku określonej usługi Google Analytics 4.

Jeśli używasz jednej z bibliotek klienta interfejsu Admin API, nie musisz ręcznie modyfikować ścieżki adresu URL żądania. Większość klientów korzystających z interfejsu API udostępnia parametr property, który oczekuje ciągu znaków w postaci properties/GA4_PROPERTY_ID. Przykład korzystania z bibliotek klienta znajdziesz w fragmentie kodu na końcu tego przewodnika.

Wymiary i dane

Wymiary opisują i grupują dane o dostępie do Twojej usługi. Na przykład wymiar userEmail wskazuje adres e-mail użytkownika, który uzyskał dostęp do danych raportowania. Wartości wymiarów w odpowiedziach w raporcie są ciągami tekstowymi.

Dane reprezentują wyniki ilościowe przedstawione w raporcie. Dane accessCount zwracają łączną liczbę rekordów dostępu do danych.

Pełną listę nazw wymiarów i danych dostępnych w żądaniach raportów o dostępie do danych znajdziesz na stronie Schemat dostępu do danych.

Żądanie raportu na temat dostępu do danych

Aby poprosić o raporty o dostępie do danych, utwórz obiekt RunAccessReportRequest. Zalecamy zacząć od następujących parametrów żądania:

  • Co najmniej 1 prawidłowy wpis w polu zakresy dat.
  • Co najmniej 1 prawidłowy wpis w polu wymiary.
  • Jeśli nie używasz wymiaru epochTimeMicros, w polu metrics podaj co najmniej 1 prawidłowy wpis, aby otrzymywać dane ilościowe dla każdej kombinacji wartości wymiarów w raporcie.

Oto przykładowe żądanie z zalecanymi polami. To zapytanie wygeneruje listę adresów e-mail użytkowników, informacje o tym, kiedy ostatnio korzystali z określonej usługi w ciągu ostatnich 7 dni, oraz odpowiednią liczbę dostępu.

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

Zgłoś odpowiedź

W kontekście podobnym do podstawowej funkcji raportowania interfejsu Data API w wersji 1 odpowiedź na raport o dostępie do danych na żądanie raportu o dostępie to głównie nagłówek i wiersze. Nagłówek składa się z kolumn AccessDimensionHeaders i AccessMetricHeaders, które wymieniają kolumny w raporcie.

Każdy wiersz raportu o dostępie składa się z kolumn AccessDimensionValues i AccessMetricValues dotyczących kolumn w raporcie. Kolejność kolumn jest spójna w żądaniu, nagłówku i każdym wierszu.

Oto przykładowa odpowiedź dla poprzedniego przykładowego żądania:

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

Filtrowanie według rekordów dostępu

Pole dimensionFilter obiektu RunAccessReportRequest pozwala ograniczyć odpowiedzi raportu do określonych wartości wymiarów pasujących do filtra.

Poniższy przykład pokazuje generowanie raportu na podstawie poszczególnych rekordów dostępu do danych i filtrowania według zapisów dostępu pojedynczego użytkownika z adresem e-mail Alex@example.net. Raport zawiera godzinę uzyskania każdego rekordu dostępu, adres e-mail i adres IP użytkownika.

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

Analogicznie pole metricFilter obiektu RunAccessReportRequest może służyć do ograniczania odpowiedzi w raporcie do określonych wartości danych pasujących do filtra.

Poniższy przykład pokazuje wygenerowany raport zawierający adresy e-mail i liczbę dostępu wszystkich użytkowników, którzy uzyskali dostęp do określonej usługi więcej niż 100 razy.

HTTP

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

Przykładowe raporty

Oto kilka przykładowych raportów, które możesz wypróbować.

Raport o ostatnim dostępie na użytkownika

Ten przykładowy raport dostępu, który można utworzyć za pomocą pola runAccessReport:

Ostatni dostęp (mikro czasu epoki) Adres e-mail użytkownika Liczba dostępu
1525220215025371 Bola@example.net 5
1525220215028361 Alex@example.net 36
1525220215027671 Charlie@example.net 1153
1525220215027341 Mahan@example.net 1

Ten raport można wygenerować, wysyłając zapytania o wymiary mostRecentAccessEpochTimeMicros, userEmail i dane accessCount. Raport zawiera po 1 wierszu na każdego użytkownika: mostRecentAccessEpochTimeMicros wymiar ten łączy rekordy dostępu do danych każdego użytkownika, który korzysta z usługi, i zwraca czas ostatniego dostępu (w mikrosekundach uniksowych od początku epoki) dla każdego wiersza.

Raport z zestawieniem dostępu użytkowników

Innym przykładem przydatnego raportu jest podział dostępu użytkowników według mechanizmu dostępu (np.interfejs użytkownika Google Analytics, interfejs API itp.).

Ostatni dostęp (mikro czasu epoki) Adres e-mail użytkownika Dostęp do mechanizmu Liczba dostępu
1525220215028367 Alex@example.net Firebase 31
1525220215555778 Alex@example.net Interfejs Google Analytics 1
1525220215022378 Bola@example.net Interfejs Google Analytics 65
1525220215026389 Bola@example.net Interfejs API Google Analytics 894
1525220215025631 Charlie@example.net Interfejs API Google Analytics 67
1525220215068325 Mahan@example.net Google Ads, 3

Ten raport można wygenerować, wysyłając zapytania o wymiary mostRecentAccessEpochTimeMicros, userEmail, accessMechanism i dane accessCount.

Raport zawiera po jednym wierszu na każdą kombinację użytkownika i mechanizmu dostępu. Wymiar mostRecentAccessEpochTimeMicros zawiera informacje, kiedy ostatni raz użytkownik uzyskał dostęp do usługi za pomocą określonego mechanizmu dostępu.

Raport Przegląd dostępu do usługi

Można wygenerować raport dla usługi bez podziału na poszczególnych użytkowników. Na przykład ten raport podaje, jak często dostęp do usługi jest uzyskiwany za pomocą różnych mechanizmów dostępu:

Identyfikator usługi, do której uzyskano dostęp Nazwa usługi, do której uzyskano dostęp Dostęp do mechanizmu Liczba dostępu
12345678 DemoApp Firebase 31
12345678 DemoApp Interfejs Google Analytics 624
12345678 DemoApp Google Ads, 83
12345678 DemoApp Interfejs API Google Analytics 1744

Ten raport można wygenerować, wysyłając zapytania o wymiary accessedPropertyId, accessedPropertyName, accessMechanism i dane accessCount.

Raport zawiera po 1 wierszu na każdą kombinację identyfikatora usługi i mechanizmu dostępu.

Raport dotyczący indywidualnego dostępu do danych

Aby wygenerować raport, w którym każdy wiersz jest oparty na indywidualnym rekordzie dostępu do danych, pomiń wymiar mostRecentAccessEpochTimeMicros w zapytaniu i zamiast niego użyj wymiaru epochTimeMicros. Nie musisz wysyłać zapytań o dane accessCount, ponieważ każdy wiersz raportu zawiera informacje o jednym wystąpieniu dostępu do danych.

Poniższy raport zawiera szczegółowe informacje o każdym uzyskaniu przez użytkownika dostępu do określonej usługi.

Czas epoki (mikro) Adres e-mail użytkownika Identyfikator usługi, do której uzyskano dostęp Nazwa usługi, do której uzyskano dostęp Adres IP użytkownika Dostęp do mechanizmu Zwrócone dane o kosztach Zwrócone dane o przychodach
1525220215025371 Bola@example.net 12345678 DemoApp 1.2.3.1 Interfejs Google Analytics prawda prawda
1525220645645645 Mahan@example.net 12345678 DemoApp 1.2.3.5 Interfejs Google Analytics false false
1525220211312322 Bola@example.net 12345678 DemoApp 11.22.33.11 Google Ads, prawda 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, prawda prawda
1525220423423452 Charlie@example.net 12345678 DemoApp 1.2.3.3 Interfejs API Google Analytics prawda false
1525220132312333 Mahan@example.net 12345678 DemoApp 1.2.3.5 Google Ads, prawda prawda

Ten raport można wygenerować, wysyłając zapytanie o wymiary epochTimeMicros, userEmail, accessedPropertyId, accessedPropertyName, userIP, accessMechanism, costDataReturned, revenueDataReturned.

Biblioteki klienta

Wyjaśnienie sposobu instalowania i konfigurowania bibliotek klienta znajdziesz w krótkim przewodniku dla początkujących.

Oto przykład użycia biblioteki klienta w języku Python, która uruchamia zapytanie dotyczące dostępu do danych i wyświetla odpowiedź.

Python

google-analytics-admin/properties_run_access_report.py
Otwórz w Cloud Shell Wyświetl w GitHubie 
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