Ringkasan

Google Analytics Admin API v1 memungkinkan Anda mengakses laporan data menggunakan runAccessReport . Laporan ini memberikan catatan setiap kali pengguna membaca Google Analytics data pelaporan. Data akses disimpan maksimal hingga 2 tahun. Akses Data laporan hanya tersedia bagi pengguna dengan peran Administrator.

Membuat Laporan Akses Data

Pelaporan Akses Data disediakan oleh runAccessReport.

Fitur Bersama dengan Laporan Inti

Permintaan laporan Akses Data memiliki semantik yang sama dengan Laporan inti permintaan, untuk banyak fitur bersama. Misalnya Spesifikasi Penomoran halaman, Filter Dimensi, Rentang Tanggal berperilaku sama di Laporan Akses Data sebagai Laporan Inti.

Pelajari ringkasan fungsi Pelaporan Inti dari Data API v1, sebagai bagian selanjutnya dari dokumen ini akan berfokus pada fitur khusus untuk permintaan laporan Akses Data.

Memilih Entitas Pelaporan

Serupa dengan Pelaporan inti fungsionalitas Data API v1, runAccessReport Google Analytics Admin API v1 memerlukan metode Google Analytics ID properti untuk ditentukan di dalam jalur permintaan URL dalam bentuk properties/GA_PROPERTY_ID, seperti:

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

Hasil laporan akses data akan dibuat berdasarkan laporan Google Analytics data akses data untuk properti Google Analytics yang ditentukan.

Jika Anda menggunakan salah satu library klien Admin API, tidak perlu memanipulasi jalur URL permintaan secara manual. Sebagian besar klien API menyediakan parameter property yang mengharapkan string dalam bentuk properties/GA_PROPERTY_ID. Lihat cuplikan kode di akhir dari panduan ini sebagai contoh penggunaan library klien.

Dimensi dan Metrik

Dimensi mendeskripsikan dan mengelompokkan data akses untuk properti Anda. Misalnya, dimensi userEmail menunjukkan email pengguna yang mengakses data pelaporan. Nilai dimensi dalam respons laporan adalah string.

Metrik merepresentasikan pengukuran kuantitatif laporan. Metrik accessCount mengembalikan jumlah total catatan akses data.

Lihat Skema Akses Data untuk mengetahui daftar lengkap dimensi dan nama metrik yang tersedia dalam permintaan laporan akses data.

Permintaan Laporan Akses Data

Untuk meminta laporan akses data, buat objek RunAccessReportRequest. Rab sarankan untuk memulai dengan parameter permintaan berikut:

• Minimal satu entri yang valid dalam tanggal rentang kolom tersebut.
• Minimal satu entri yang valid di dimensi kolom tersebut.
• Jika tidak menggunakan dimensi epochTimeMicros, setidaknya ada satu entri yang valid di tindakan metrik guna menerima data kuantitatif untuk setiap kombinasi nilai dimensi dalam laporan.

Berikut contoh permintaan dengan kolom yang direkomendasikan. Kueri ini akan menghasilkan daftar email pengguna, waktu terakhir mereka mengakses properti tertentu selama rentang 7 hari terakhir, dan jumlah akses yang terkait.

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

Respons Laporan

Secara konsep mirip dengan Pelaporan inti fungsionalitas Data API v1, Laporan Akses Data Respons permintaan akses laporan pada dasarnya adalah header dan baris. {i>Header<i} terdiri dari AccessDimensionHeaders dan AccessMetricHeaders yang mencantumkan kolom dalam Laporan.

Setiap laporan akses baris terdiri dari AccessDimensionValues dan AccessMetricValues untuk kolom dalam laporan. Urutan kolom konsisten dalam {i>request<i}, {i>header<i}, dan setiap baris.

Berikut contoh respons untuk contoh permintaan sebelumnya:

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

Memfilter Catatan Akses

Gunakan dimensionFilter bidang RunAccessReportRequest untuk membatasi respons laporan terhadap nilai dimensi tertentu yang cocok dengan filter.

Contoh berikut menghasilkan laporan berdasarkan akses data individual data, pemfilteran pada catatan akses satu pengguna dengan alamat email Alex@example.net. Laporan ini berisi waktu dari setiap catatan akses, email dan alamat IP Anda.

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

Demikian pula, metricFilter bidang RunAccessReportRequest dapat digunakan untuk membatasi respons laporan ke nilai metrik tertentu yang cocok dengan filter.

Contoh berikut menghasilkan laporan yang berisi email dan jumlah akses semua pengguna, yang mengakses properti yang ditentukan lebih dari 100 kali.

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

Contoh laporan

Berikut beberapa contoh laporan yang dapat Anda coba.

Laporan Akses Terbaru Per Pengguna

Contoh laporan akses berikut yang dapat dibuat menggunakan runAccessReport:

Laporan ini dapat dibuat dengan membuat kueri dimensi mostRecentAccessEpochTimeMicros, userEmail dan metrik accessCount. Tujuan laporan berisi satu baris per pengguna: mostRecentAccessEpochTimeMicros dimensi menggabungkan catatan akses data untuk setiap pengguna yang mengakses properti dan menampilkan waktu akses terakhir (dalam mikrodetik Unix sejak epoch) untuk setiap baris.

Laporan Perincian Akses Pengguna

Contoh lain dari laporan yang berguna adalah pengelompokan akses pengguna menurut Akses Mekanisme (mis.Antarmuka Pengguna Google Analytics, API, dll.).

Laporan ini dapat dibuat dengan membuat kueri dimensi mostRecentAccessEpochTimeMicros, userEmail, accessMechanism, dan accessCount metrik.

Laporan berisi satu baris per setiap kombinasi mekanisme akses/pengguna. Tujuan mostRecentAccessEpochTimeMicros dimensi berisi waktu terakhir kali pengguna mengakses properti menggunakan Mekanisme Akses yang ditentukan.

Laporan Ringkasan Akses Properti

Anda dapat membuat laporan untuk properti tanpa menguraikan setiap pengguna. Misalnya, laporan berikut menyatakan seberapa sering properti diakses menggunakan Mekanisme Akses yang berbeda:

Laporan ini dapat dibuat dengan membuat kueri dimensi accessedPropertyId, accessedPropertyName, accessMechanism, dan accessCount metrik.

Laporan berisi satu baris per setiap kombinasi mekanisme akses/ID properti.

Laporan Akses Data Individual

Untuk membuat laporan yang setiap barisnya didasarkan pada setiap akses data Hapus dimensi mostRecentAccessEpochTimeMicros dari kueri dan menggunakan dimensi epochTimeMicros sebagai gantinya. Anda tidak perlu membuat kueri accessCount, karena setiap baris laporan berisi informasi tentang terjadinya akses data tunggal.

Laporan berikut berisi informasi terperinci tentang setiap kali pengguna mengakses properti yang ditentukan.

Laporan ini dapat dibuat dengan membuat kueri dimensi epochTimeMicros, userEmail, accessedPropertyId, accessedPropertyName, userIP, accessMechanism, costDataReturned, revenueDataReturned.

Library klien

Lihat Panduan memulai cepat untuk penjelasan tentang cara menginstal dan mengonfigurasi library klien.

Berikut adalah contoh penggunaan library klien Python yang menjalankan kueri akses data dan mencetak respons.

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