Przegląd

Interfejs Google Analytics Admin API w wersji 1 umożliwia dostęp do danych w raportach za pomocą runAccessReport . Raport zawiera rejestr wszystkich przypadków odczytu przez użytkownika w Google Analytics do danych do raportu. Rekordy dostępu są przechowywane przez maksymalnie 2 lata. Dostęp do danych raporty są dostępne tylko dla użytkowników z rolą administratora.

Tworzenie raportu o dostępie do danych

Raportowanie dostępu do danych jest dostarczane przez runAccessReport.

Udostępniane funkcje z podstawowymi raportami

Żądania raportu o dostępie do danych mają taką samą semantykę jak w raporcie podstawowym w przypadku wielu udostępnianych funkcji. Przykład: Podział na strony, Filtry wymiarów i specyfikacja Zakresy dat działają tak samo w raportach dostępu do danych jako raporty podstawowe.

Zapoznaj się z omówieniem podstawowych funkcji raportowania interfejsu Data API w wersji 1, a pozostałe skoncentruje się na funkcjach właściwych dla raportów dotyczących dostępu do danych.

Wybieranie podmiotu zgłaszającego

Podobnie jak w przypadku podstawowych raportów funkcji Data API v1, runAccessReport interfejsu Google Analytics Admin API w wersji 1 wymaga dodatku Google Analytics identyfikatora usługi do określenia wewnątrz ścieżkę żądania adresu URL w formacie properties/GA_PROPERTY_ID, na przykład:

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

Wynikowy raport o dostępie do danych zostanie wygenerowany na podstawie danych z Google Analytics. rekordy dostępu do danych w określonej usłudze w Google Analytics.

Jeśli używasz jednej z bibliotek klienta interfejsu Admin API, nie trzeba ręcznie modyfikować ścieżki adresu URL żądania. Większość klientów API podaj parametr property, który oczekuje ciągu znaków w formacie properties/GA_PROPERTY_ID Zobacz fragment kodu na stronie na końcu tego przewodnika.

Wymiary i dane

Wymiary opisywać i grupować dane dostępu do Twojej usługi. Na przykład wymiar userEmail to adres e-mail użytkownika, który uzyskał dostęp do danych raportowania. Wartości wymiarów w odpowiedziach na raporty mają postać ciągów tekstowych.

Dane odzwierciedlają ilościowe wyniki pochodzące z raportu. Dane: accessCount zwraca łączną liczbę rekordów dostępu do danych.

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

Prośba o raport dostępu do danych

Aby poprosić o raporty o dostępie do danych, utwórz obiekt RunAccessReportRequest. Śr zalecamy rozpoczęcie od tych parametrów żądania:

  • Co najmniej jeden prawidłowy wpis w polu data zakresy .
  • Co najmniej 1 prawidłowy wpis w polu wymiarów .
  • 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 raport.

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

HTTP

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

Zgłoś odpowiedź

Zasadniczo podobne do podstawowych raportów funkcje interfejsu Data API w wersji 1, raportu Dostęp do danych Odpowiedź Żądanie raportu na temat dostępu to głównie nagłówek i wiersze. Nagłówek składa się z: AccessDimensionHeaders oraz AccessMetricHeaders która zawiera listę kolumn w raporcie.

Każdy raport dostępu wiersz zawiera: AccessDimensionValues. oraz AccessMetricValues. dla kolumn raportu. Kolejność kolumn jest taka sama żądania, nagłówka i każdego wiersza.

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 dimensionFilter argumentu RunAccessReportRequest ogranicza odpowiedź raportu do określonych wartości wymiarów, które pasują do filtr.

Ten przykład pozwala wygenerować raport na podstawie indywidualnego dostępu do danych rekordy, filtrowanie według rekordów dostępu pojedynczego użytkownika z adresem e-mail Alex@example.net Raport zawiera informacje o czasie każdego rekordu dostępu, adresu e-mail i adresu IP.

HTTP

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 metricFilter argumentu 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ę 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 dotyczący ostatniego dostępu na użytkownika

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

Czas ostatniego dostępu (mikro) 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 zapytanie wymiary mostRecentAccessEpochTimeMicros, userEmail i dane accessCount. raport zawiera po jednym wierszu na każdego użytkownika: mostRecentAccessEpochTimeMicros wymiar sumuje rekordy dostępu do danych każdego użytkownika, który uzyskuje dostęp do usługi i zwraca czas ostatniego dostępu (w mikrosekundach uniksowych od momentu wywołania epoka) dla każdego wiersza.

Raport z zestawieniem dostępu użytkowników

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

Czas ostatniego dostępu (mikro) Adres e-mail użytkownika Mechanizm dostępu 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 zapytanie wymiary mostRecentAccessEpochTimeMicros, userEmail, accessMechanism i accessCount dane.

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

Raport Przegląd dostępu do usługi

Raport można wygenerować dla usługi bez podziału na poszczególnych użytkowników. Na przykład ten raport wskazuje, jak często usługa dostęp 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 Mechanizm dostępu 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 zapytanie wymiary accessedPropertyId, accessedPropertyName, accessMechanism i accessCount dane.

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

Raport dotyczący dostępu do poszczególnych danych

Aby wygenerować raport, w którym każdy wiersz jest powiązany z osobnym dostępem do danych w rekordzie, pomiń wymiar mostRecentAccessEpochTimeMicros w zapytaniu i użyj wymiaru epochTimeMicros. Nie trzeba wysyłać zapytań accessCount, ponieważ każdy wiersz raportu zawiera informacje na temat w przypadku pojedynczego wystąpienia dostępu do danych.

Ten raport zawiera szczegółowe informacje o każdym przypadku użytkownik uzyska dostęp do wskazanej usługi.

Czas uniksowy (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 Mechanizm dostępu 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 fałsz fałsz
1525220211312322 Bola@example.net 12345678 DemoApp 11.22.33.11 Google Ads prawda fałsz
1525220210234221 Alex@example.net 12345678 DemoApp 11.22.33.22 Firebase fałsz fałsz
1525220215028368 Alex@example.net 12345678 DemoApp 1.2.3.2 Google Ads fałsz fałsz
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 fałsz
1525220132312333 Mahan@example.net 12345678 DemoApp 1.2.3.5 Google Ads prawda prawda

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

Biblioteki klienta

Więcej informacji znajdziesz w krótkim przewodniku. jak zainstalować i skonfigurować biblioteki klienta.

Oto przykład z wykorzystaniem biblioteki klienta w języku Python, która uruchamia zapytanie o dostęp do danych i wydrukuje 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