Raporty dotyczące dostępu do danych

Raporty dostępu 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 dostępu do danych są dostępne tylko dla użytkowników z rolą Administrator.

Żądanie raportu dostępu do danych za pomocą biblioteki klienta

Najszybszym sposobem na rozpoczęcie korzystania z raportów dostępu do danych jest użycie bibliotek klienta.

Aby dowiedzieć się, jak zainstalować i skonfigurować biblioteki klienta Google Analytics, zapoznaj się z krótkim przewodnikiem.

Oto przykład użycia biblioteki klienta w Pythonie, która uruchamia zapytanie dotyczące dostępu 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 dostępu do danych mają w przypadku wielu typowych funkcji taką samą semantykę jak żądania raportów podstawowych. Na przykład stronicowanie, 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 następnie wróć na tę stronę, aby dowiedzieć się więcej o raportach dostępu do danych.

Tworzenie raportu dostępu do danych

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

Wybierz podmiot raportujący

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

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

Wygenerowany raport Dostęp do danych jest tworzony na podstawie rekordów dostępu do danych Google Analytics w przypadku określonej usługi w Google Analytics.

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

Wybieranie wymiarów i danych

Wymiary opisują i grupują dane dostępu dotyczące 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 raportu są ciągami znaków.

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

Poproś o raport

Aby poprosić o raporty dostępu 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 dimensions.
• Jeśli nie używasz wymiaru epochTimeMicros, musisz podać co najmniej 1 prawidłowy wpis w polu metrics, 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, ostatni czas dostępu do określonej usługi w ciągu ostatnich 7 dni oraz odpowiednią liczbę dostępów.

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

Przeczytaj odpowiedź

Odpowiedź raportu dostępu do danych składa się głównie z nagłówka i wierszy. Nagłówek składa się z AccessDimensionHeaders i AccessMetricHeaders, które zawierają listę kolumn w raporcie.

Każdy wiersz raportu dostępu składa się z AccessDimensionValues i AccessMetricValues w kolumnach raportu. 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.

W tym przykładzie generowany jest raport na podstawie poszczególnych rekordów dostępu do danych, filtrowany według rekordów dostępu pojedynczego użytkownika o adresie e-mail Alex@example.net. Raport zawiera czas każdego rekordu dostępu, adres e-mail użytkownika i adres IP.

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.

W tym przykładzie generowany jest raport zawierający adresy e-mail i liczbę wejść wszystkich użytkowników, którzy uzyskali dostęp do określonej usługi więcej niż 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

Poniższy przykładowy raport dostępu można utworzyć za pomocą runAccessReport:

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

Zestawienie dostępu użytkowników

Innym przykładem przydatnego raportu jest zestawienie dostępów 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 accessCount metric.

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

Omówienie dostępu do usługi

Można wygenerować raport dotyczący 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:

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

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

Dostęp do danych poszczególnych osób

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 wymiaru epochTimeMicros. Nie trzeba wysyłać zapytania o dane accessCount, ponieważ każdy wiersz raportu zawiera informacje o pojedynczym wystąpieniu dostępu do danych.

Ten raport zawiera szczegółowe informacje o każdym przypadku, gdy użytkownik uzyskał dostęp do określonej usługi.

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