Halaman ini diterjemahkan oleh Cloud Translation API.

Method: properties.runAccessReport

Permintaan HTTP
Parameter lokasi
Isi permintaan
- Representasi JSON
Isi respons
Cakupan otorisasi
Cobalah!

Menampilkan laporan kustom dari kumpulan data akses data. Laporan ini menyediakan catatan setiap kali pengguna membaca data pelaporan Google Analytics. Data akses dipertahankan hingga maksimal 2 tahun.

Laporan Akses Data dapat diminta untuk properti. Laporan dapat diminta untuk properti apa pun, tetapi dimensi yang tidak terkait dengan kuota hanya dapat diminta di properti Google Analytics 360. Metode ini hanya tersedia untuk Administrator.

Kumpulan data akses data ini mencakup Pelaporan UI GA4, Eksplorasi UI GA4, Data API GA4, 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

Parameter
`entity`	`string` Laporan Akses Data mendukung permintaan di tingkat properti atau tingkat akun. Jika diminta pada tingkat akun, Laporan Akses Data mencakup semua akses untuk semua properti di bawah akun tersebut. Untuk mengajukan permintaan di tingkat properti, entitas harus, misalnya, '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.

entity

string

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

Untuk mengajukan permintaan di tingkat properti, entitas harus, misalnya, '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

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, "includeAllUsers": boolean, "expandGroups": boolean }

{
  "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,
  "includeAllUsers": boolean,
  "expandGroups": 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 data 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 akan disertakan dalam baris respons untuk kedua rentang tanggal tersebut. Permintaan diizinkan hingga 2 rentang tanggal.
`dimensionFilter`	`object (AccessFilterExpression)` Filter dimensi memungkinkan Anda membatasi respons laporan ke nilai dimensi tertentu yang cocok dengan filter. Misalnya, memfilter catatan 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 ke nilai metrik tertentu yang cocok dengan filter. Filter metrik diterapkan setelah menggabungkan baris laporan, mirip dengan klausa penggunaan SQL. Dimensi tidak dapat digunakan dalam filter ini.
`offset`	`string (int64 format)` Jumlah baris untuk baris awal. Baris pertama dihitung sebagai baris 0. Jika offset tidak ditentukan, offset tersebut diperlakukan sebagai 0. Jika offset 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 akan ditampilkan. Jika tidak ditentukan, 10.000 baris akan ditampilkan. API menampilkan maksimum 100.000 baris per permintaan, berapa pun jumlah yang Anda minta. `limit` harus positif. API dapat menampilkan lebih sedikit baris daripada `limit` yang diminta, jika jumlah baris yang tersisa tidak sebanyak `limit`. Misalnya, terdapat kurang dari 300 kemungkinan nilai untuk dimensi `country`, jadi saat melaporkan hanya `country`, Anda tidak bisa mendapatkan lebih dari 300 baris, meskipun jika 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` Mengalihkan apakah akan menampilkan status saat ini dari kuota Properti Analytics ini. Kuota ditampilkan di AccessQuota. Untuk permintaan tingkat akun, kolom ini harus salah.
`includeAllUsers`	`boolean` Opsional. Menentukan apakah akan menyertakan pengguna yang belum pernah melakukan panggilan API dalam respons. Jika true (benar), semua pengguna yang memiliki akses ke properti atau akun yang ditentukan akan disertakan dalam respons, terlepas dari apakah mereka telah melakukan panggilan API atau belum. Jika nilainya adalah salah (false), hanya pengguna yang telah melakukan panggilan API yang akan disertakan.
`expandGroups`	`boolean` Opsional. Menentukan apakah akan menampilkan pengguna dalam grup pengguna. Kolom ini hanya berfungsi jika includeAllUsers ditetapkan ke true. Jika nilainya benar, tindakan ini akan menampilkan semua pengguna yang memiliki akses ke properti atau akun yang ditentukan. Jika nilainya adalah salah (false), hanya pengguna dengan akses langsung yang akan ditampilkan.

Isi respons

Jika berhasil, isi respons akan berisi instance RunAccessReportResponse.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

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