Method: properties.runAccessReport

Menampilkan laporan data akses data yang disesuaikan. Laporan ini memberikan data setiap kali pengguna membaca data pelaporan Google Analytics. Data akses disimpan hingga 2 tahun.

Laporan Akses Data dapat diminta untuk properti. Properti tersebut harus berada di Google Analytics 360. Metode ini hanya tersedia bagi Administrator.

Catatan akses data ini mencakup Pelaporan UI GA4, Eksplorasi UI GA4, GA4 Data API, dan produk lainnya seperti Firebase & AdMob yang dapat mengambil data dari Google Analytics melalui penautan. Data ini tidak mencakup perubahan konfigurasi properti seperti menambahkan aliran data atau mengubah zona waktu properti. Untuk histori perubahan konfigurasi, lihat searchChangeHistoryEvents.

Permintaan HTTP

POST https://analyticsadmin.googleapis.com/v1alpha/{entity=properties/*}:runAccessReport

URL menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
entity

string

Laporan Akses Data mendukung permintaan di tingkat properti atau tingkat akun. Jika diminta di tingkat akun, Laporan Akses Data mencakup semua akses untuk semua properti di bagian akun tersebut.

Untuk meminta di tingkat properti, entitas harus berupa 'properties/123' jika "123" adalah ID properti GA4 Anda. Untuk meminta di tingkat akun, entitas harus misalnya 'accounts/1234' jika "1234" adalah ID Akun GA4 Anda.

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON 
{
  "dimensions": [
    {
      object (AccessDimension)
    }
  ],
  "metrics": [
    {
      object (AccessMetric)
    }
  ],
  "dateRanges": [
    {
      object (AccessDateRange)
    }
  ],
  "dimensionFilter": {
    object (AccessFilterExpression)
  },
  "metricFilter": {
    object (AccessFilterExpression)
  },
  "offset": string,
  "limit": string,
  "timeZone": string,
  "orderBys": [
    {
      object (AccessOrderBy)
    }
  ],
  "returnEntityQuota": boolean
}
Kolom
dimensions[]

object (AccessDimension)

Dimensi yang diminta dan ditampilkan dalam respons. Permintaan diizinkan hingga 9 dimensi.
metrics[]

object (AccessMetric)

Metrik yang diminta dan ditampilkan dalam respons. Permintaan diizinkan hingga 10 metrik.
dateRanges[]

object (AccessDateRange)

Rentang tanggal catatan akses untuk dibaca. Jika beberapa rentang tanggal diminta, setiap baris respons akan berisi indeks rentang tanggal berbasis nol. Jika dua rentang tanggal tumpang-tindih, data akses untuk hari yang tumpang-tindih disertakan dalam baris respons untuk kedua rentang tanggal tersebut. Permintaan diizinkan untuk 2 rentang tanggal.
dimensionFilter

object (AccessFilterExpression)

Filter dimensi memungkinkan Anda membatasi respons laporan terhadap nilai dimensi tertentu yang cocok dengan filter. Misalnya, memfilter data akses dari satu pengguna. Untuk mempelajari lebih lanjut, lihat Dasar-dasar Filter Dimensi untuk mengetahui contohnya. Metrik tidak dapat digunakan dalam filter ini.
metricFilter

object (AccessFilterExpression)

Filter metrik memungkinkan Anda membatasi respons laporan untuk nilai metrik tertentu yang cocok dengan filter. Filter metrik diterapkan setelah menggabungkan baris laporan, mirip dengan yang memiliki klausa SQL. Dimensi tidak dapat digunakan di filter ini.
offset

string (int64 format)

Jumlah baris untuk baris awal. Baris pertama dihitung sebagai baris 0. Jika offset tidak ditentukan, offset akan diperlakukan sebagai 0. Jika offset adalah nol, metode ini akan menampilkan halaman pertama hasil dengan entri limit.

Untuk mempelajari parameter penomoran halaman ini lebih lanjut, lihat Penomoran halaman.
limit

string (int64 format)

Jumlah baris yang perlu ditampilkan. Jika tidak ditentukan, baris akan ditampilkan 10.000. API tersebut menampilkan maksimum 100.000 baris per permintaan, berapa pun jumlah permintaan Anda. limit harus positif.

API dapat menampilkan baris yang lebih sedikit dari limit yang diminta, jika jumlah baris yang tersisa sebanyak limit lebih banyak. Misalnya, ada kurang dari 300 kemungkinan nilai untuk dimensi country, sehingga saat melaporkan hanya country, Anda tidak bisa mendapatkan lebih dari 300 baris, meskipun Anda menetapkan limit ke nilai yang lebih tinggi.

Untuk mempelajari parameter penomoran halaman ini lebih lanjut, lihat Penomoran halaman.
timeZone

string

Zona waktu permintaan ini jika ditentukan. Jika tidak ditentukan, zona waktu properti akan digunakan. Zona waktu permintaan digunakan untuk menafsirkan tanggal mulai & akhir laporan.

Diformat sebagai string dari database Zona Waktu IANA (https://www.iana.org/time-zones); misalnya "America/New_York" atau "Asia/Tokyo".
orderBys[]

object (AccessOrderBy)

Menentukan bagaimana baris diurutkan dalam respons.
returnEntityQuota

boolean

Beralih apakah akan menampilkan status kuota Properti Analytics saat ini. Kuota ditampilkan di AccessQuota. Untuk permintaan tingkat akun, kolom ini harus salah.

Isi respons

Jika berhasil, isi respons memuat instance RunAccessReportResponse.

Cakupan Otorisasi

Memerlukan salah satu cakupan OAuth berikut:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics.edit