Genel bakış

Google Analytics Admin API v1, runAccessReport yöntemini kullanarak veri erişimi raporları oluşturmanıza olanak tanır. Bu rapor, bir kullanıcının Google Analytics raporlama verilerini her okuduğunda kayıtlar sağlar. Erişim kayıtları 2 yıla kadar saklanır. Veri Erişimi raporları yalnızca Yönetici rolüne sahip kullanıcılar tarafından kullanılabilir.

Veri Erişim Raporu Oluşturma

Veri Erişimi raporlaması, runAccessReport yöntemi tarafından sağlanır.

Temel Raporlarla Paylaşılan Özellikler

Veri Erişimi raporu istekleri, birçok paylaşılan özellik için Temel rapor istekleri ile aynı anlamlara sahiptir. Örneğin, Sayfalara Ayırma, Boyut Filtreleri, Tarih Aralıkları spesifikasyonu, Veri Erişim Raporlarında Temel Raporlar ile aynı şekilde davranır.

Bu belgenin geri kalanı Veri Erişimi raporu isteklerine özel özelliklere odaklanacağından Data API v1'in Temel Raporlama işlevine genel bakış hakkında bilgi edinin.

Rapor Eden Varlık Seçme

Data API v1'in temel raporlama işlevine benzer şekilde, Google Analytics Admin API v1'in runAccessReport yöntemi de Google Analytics 4 mülk tanımlayıcısının URL istek yolunda properties/GA4_PROPERTY_ID biçiminde belirtilmesini gerektirir. Örneğin:

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

Ortaya çıkan veri erişimi raporu, belirtilen Google Analytics 4 mülkünün Google Analytics veri erişimi kayıtları temel alınarak oluşturulur.

Admin API istemci kitaplıklarından birini kullanıyorsanız istek URL yolunu manuel olarak değiştirmenize gerek yoktur. Çoğu API istemcisi, properties/GA4_PROPERTY_ID biçiminde bir dize bekleyen property parametresi sağlar. İstemci kitaplıklarının kullanımına ilişkin bir örnek için bu kılavuzun sonundaki kod snippet'i bölümüne bakın.

Boyutlar ve Metrikler

Boyutlar, mülkünüzün erişim verilerini tanımlar ve gruplandırır. Örneğin userEmail boyutu, raporlama verilerine erişen kullanıcının e-posta adresini belirtir. Rapor yanıtlarındaki boyut değerleri dizedir.

Metrikler, bir raporun nicel ölçümlerini temsil eder. accessCount metriği, veri erişimi kayıtlarının toplam sayısını döndürür.

Veri erişimi raporu isteklerinde kullanılabilen boyut ve metrik adlarının tam listesi için Veri Erişim Şeması bölümüne bakın.

Veri Erişim Raporu İsteği

Veri erişim raporları istemek için bir RunAccessReportRequest nesnesi oluşturun. Şu istek parametreleriyle başlamanızı öneririz:

  • Tarih aralıkları alanında en az bir geçerli giriş olmalıdır.
  • Boyutlar alanında en az bir geçerli giriş.
  • epochTimeMicros boyutu kullanmıyorsanız rapordaki her boyut değeri kombinasyonu için nicel verileri almak üzere metrics alanında en az bir geçerli giriş olmalıdır.

Aşağıda, önerilen alanları içeren örnek bir istek verilmiştir. Bu sorgu, kullanıcı e-postalarının listesini, kullanıcıların son 7 gün aralığında belirtilen mülke en son eriştiği zamanı ve buna karşılık gelen erişim sayısını oluşturur.

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

Yanıtı bildir

Data API v1'in Temel raporlama işlevine kavramsal olarak benzeyen erişim raporu isteğinin Veri Erişim Raporu Yanıtı, temel olarak bir başlık ve satırlardır. Başlık, Rapor'daki sütunları listeleyen AccessDimensionHeaders ve AccessMetricHeaders bölümlerinden oluşur.

Her erişim raporu satırı, rapordaki sütunlar için AccessDimensionValues ve AccessMetricValues değerlerinden oluşur. İstekte, başlıkta ve her satırda sütunların sıralaması tutarlıdır.

Aşağıda, önceki örnek istek için örnek yanıt verilmiştir:

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

Erişim Kayıtlarını Filtreleme

Rapor yanıtını filtreyle eşleşen belirli boyut değerleriyle kısıtlamak için RunAccessReportRequest nesnesinin dimensionFilter alanını kullanın.

Aşağıdaki örnekte, bağımsız veri erişimi kayıtlarına dayalı bir rapor oluşturulur ve Alex@example.net e-posta adresine sahip tek bir kullanıcının erişim kayıtları filtrelenir. Raporda her erişim kaydının saati, kullanıcının e-posta ve IP adresi bulunur.

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

Benzer şekilde, RunAccessReportRequest nesnesinin metricFilter alanı, rapor yanıtını filtreyle eşleşen belirli metrik değerleriyle kısıtlamak için kullanılabilir.

Aşağıdaki örnekte, belirtilen mülke 100'den fazla kez erişen tüm kullanıcıların e-posta adreslerini ve erişim sayılarını içeren bir rapor oluşturulur.

HTTP

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

Örnek raporlar

Aşağıda, deneyebileceğiniz bazı örnekleyici raporları bulabilirsiniz.

Kullanıcı Başına En Son Erişim Raporu

runAccessReport kullanılarak oluşturulabilen aşağıdaki örnek erişim raporu:

En Son Erişim Dönemi Zaman Mikroları Kullanıcı E-postası Erişim Sayısı
1525220215025371 Bola@example.net 5
1525220215028361 Alex@example.net 36
1525220215027671 Charlie@example.net 1153
1525220215027341 Mahan@example.net 1

Bu rapor, mostRecentAccessEpochTimeMicros, userEmail ve accessCount metriği boyutları sorgulanarak oluşturulabilir. Rapor her kullanıcı başına bir satır içerir: mostRecentAccessEpochTimeMicros boyutu, mülke erişen her kullanıcının veri erişimi kayıtlarını toplar ve her satır için son erişim zamanını (dönemden bu yana Unix mikrosaniye cinsinden) döndürür.

Kullanıcı Erişimi Döküm Raporu

Yararlı bir rapor olan diğer bir örnek de, kullanıcı erişimlerinin Erişim Sistemine (ör.Google Analytics Kullanıcı Arayüzü, API vb.) göre dökümüdür.

En Son Erişim Dönemi Zaman Mikroları Kullanıcı E-postası Erişim Sistemi Erişim Sayısı
1525220215028367 Alex@example.net Firebase 31
1525220215555778 Alex@example.net Google Analytics Kullanıcı Arayüzü 1
1525220215022378 Bola@example.net Google Analytics Kullanıcı Arayüzü 65
1525220215026389 Bola@example.net Google Analytics API'sı 894
1525220215025631 Charlie@example.net Google Analytics API'sı 67
1525220215068325 Mahan@example.net Google Ads 3

Bu rapor mostRecentAccessEpochTimeMicros, userEmail, accessMechanism boyutları ve accessCount metriği sorgulanarak oluşturulabilir.

Rapor, her kullanıcı/erişim mekanizması kombinasyonu başına bir satır içerir. mostRecentAccessEpochTimeMicros boyutu, bir kullanıcının belirtilen Erişim Sistemini kullanarak mülke en son ne zaman eriştiğini içerir.

Mülk Erişimine Genel Bakış Raporu

Kullanıcıları tek tek ayırmadan bir mülk için rapor oluşturmak mümkündür. Örneğin, aşağıdaki raporda bir mülke farklı Erişim Mekanizmaları kullanılarak ne sıklıkta erişildiği belirtilmektedir:

Erişilen Mülk Kimliği Erişilen Mülk Adı Erişim Sistemi Erişim Sayısı
12345678 DemoApp Firebase 31
12345678 DemoApp Google Analytics Kullanıcı Arayüzü 624
12345678 DemoApp Google Ads 83
12345678 DemoApp Google Analytics API'sı 1744

Bu rapor accessedPropertyId, accessedPropertyName, accessMechanism boyutları ve accessCount metriği sorgulanarak oluşturulabilir.

Rapor, her mülk kimliği/erişim mekanizması kombinasyonu başına bir satır içerir.

Bireysel Veri Erişimleri Raporu

Her satırın bağımsız bir veri erişimi kaydını temel aldığı bir rapor oluşturmak için sorgudan mostRecentAccessEpochTimeMicros boyutunu çıkarın ve bunun yerine epochTimeMicros boyutunu kullanın. Raporun her satırı tek bir veri erişim olayıyla ilgili bilgi içerdiğinden accessCount metriğini sorgulamak gerekli değildir.

Aşağıdaki rapor, bir kullanıcının belirtilen mülke her erişmesiyle ilgili ayrıntılı bilgiler içerir.

Dönem Zaman Mikroları Kullanıcı E-postası Erişilen Mülk Kimliği Erişilen Mülk Adı Kullanıcı IP'si Erişim Sistemi Döndürülen Maliyet Verileri Döndürülen Gelir Verileri
1525220215025371 Bola@example.net 12345678 DemoApp 1.2.3.1 Google Analytics Kullanıcı Arayüzü true true
1525220645645645 Mahan@example.net 12345678 DemoApp 1.2.3.5 Google Analytics Kullanıcı Arayüzü false false
1525220211312322 Bola@example.net 12345678 DemoApp 11.22.33.11 Google Ads true 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 true true
1525220423423452 Charlie@example.net 12345678 DemoApp 1.2.3.3 Google Analytics API'sı true false
1525220132312333 Mahan@example.net 12345678 DemoApp 1.2.3.5 Google Ads true true

Bu rapor epochTimeMicros, userEmail, accessedPropertyId, accessedPropertyName, userIP, accessMechanism, costDataReturned, revenueDataReturned boyutlarını sorgulayarak oluşturulabilir.

İstemci kitaplıkları

İstemci kitaplıklarının nasıl yükleneceği ve yapılandırılacağıyla ilgili bir açıklama için Hızlı başlangıç kılavuzuna bakın.

Veri erişim sorgusu çalıştıran ve yanıtı yazdıran Python istemci kitaplığını kullanan bir örneği burada bulabilirsiniz.

Python

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