Raporty dotyczące dostępu do danych

Raporty o dostępie do danych możesz tworzyć za pomocą metody runAccessReport interfejsu Admin API w wersji 1. Ten raport pokazuje, kiedy użytkownik odczytuje dane Google Analytics. Rekordy dostępu do danych są przechowywane przez maksymalnie 2 lata. Raporty o dostępie do danych są dostępne tylko dla użytkowników z rolą Administrator.

Prośba o raport o dostępie do danych za pomocą biblioteki klienta

Najszybszym sposobem na rozpoczęcie pracy z raportami o dostępie do danych jest użycie bibliotek klienta.

Wyjaśnienie, jak zainstalować i skonfigurować biblioteki klienta Google Analytics, znajdziesz w przewodniku Szybki start na temat.

Oto przykład użycia biblioteki klienta Python, która uruchamia zapytanie o dostęp do danych i wyświetla odpowiedź.

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

Funkcje wspólne z raportami podstawowymi

Żądania raportów o dostępie do danych mają taką samą semantykę jak żądania raportów podstawowych w przypadku wielu typowych funkcji. Na przykład paginacja, filtry wymiarów i zakresy dat działają tak samo w obu typach raportów.

Zapoznaj się z omówieniem raportów podstawowych w interfejsie Data API w wersji 1, a potem wróć na tę stronę, aby dowiedzieć się więcej o raportach o dostępie do danych.

Tworzenie raportu o dostępie do danych

Aby poprosić o raport o dostępie do danych, użyj metody runAccessReport.

Wybieranie jednostki raportowania

Podobnie jak w przypadku podstawowej funkcji raportowania interfejsu Data API w wersji 1, metoda runAccessReport interfejsu Google Analytics Admin API w wersji 1 wymaga podania identyfikatora usługi Google Analytics w ścieżce żądania URL w postaci properties/GA_PROPERTY_ID, np.:

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

Wynikowy raport o dostępie do danych jest generowany na podstawie rekordów dostępu do danych Google Analytics dla określonej usługi w Google Analytics.

Jeśli używasz jednej z bibliotek klienta Admin API, nie musisz ręcznie modyfikować ścieżki adresu URL żądania. Większość klientów API udostępnia parametr property, który oczekuje ciągu znaków w postaci properties/GA_PROPERTY_ID. Przykład użycia bibliotek klienta znajdziesz we fragmencie koduna początku tej strony.

Wybieranie wymiarów i danych

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

Dane reprezentują pomiary ilościowe 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 w schemacie dostępu do danych.

Prośba o raport

Aby poproszyć o raporty o dostępie do danych, utwórz obiekt RunAccessReportRequest. Zalecamy rozpoczęcie od tych 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, co najmniej 1 prawidłowy wpis w polu dane , 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, czas ostatniego dostępu do określonej usługi w ciągu ostatnich 7 dni oraz odpowiednią liczbę przypadków uzyskania dostępu.

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

Odczytywanie odpowiedzi

Odpowiedź raportu o dostępie do danych to przede wszystkim nagłówek i wiersze. Nagłówek składa się z AccessDimensionHeaders i AccessMetricHeaders , które zawierają listę kolumn w raporcie.

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

Oto przykładowa odpowiedź na poprzednie przykładowe żądanie:

{
  "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 rekordów dostępu

Użyj pola dimensionFilter obiektu RunAccessReportRequest , aby ograniczyć odpowiedź raportu do określonych wartości wymiarów, które pasują do filtra.

Poniższy przykład generuje raport na podstawie poszczególnych rekordów dostępu do danych, filtrując rekordy dostępu pojedynczego użytkownika o adresie e-mail Alex@example.net. Raport zawiera czas każdego rekordu dostępu, adres e-mail i adres IP użytkownika.

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

Podobnie pole metricFilter obiektu RunAccessReportRequest może służyć do ograniczania odpowiedzi raportu do określonych wartości danych, które pasują do filtra.

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

{
  "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ć.

Ostatni dostęp

Ten przykładowy raport o dostępie można utworzyć za pomocą metody runAccessReport:

Ten raport można wygenerować, wysyłając zapytanie o wymiary mostRecentAccessEpochTimeMicros, userEmail i dane accessCount metryki. Raport zawiera 1 wiersz na użytkownika: mostRecentAccessEpochTimeMicros wymiar agreguje rekordy dostępu do danych dla każdego użytkownika uzyskującego dostęp do usługi i zwraca czas ostatniego dostępu (w mikrosekundach od początku epoki uniksowej) w każdym wierszu.

Zestawienie dostępu użytkowników

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

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

Raport zawiera 1 wiersz na każdą kombinację użytkownika i mechanizmu dostępu. Wymiar mostRecentAccessEpochTimeMicros zawiera czas ostatniego dostępu użytkownika do usługi za pomocą określonego mechanizmu dostępu.

Omówienie dostępu do usługi

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

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

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

Dostęp do poszczególnych danych

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

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

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