- Permintaan HTTP
- Parameter jalur
- Isi permintaan
- Isi respons
- Cakupan Otorisasi
- DimensionMetadata
- MetricMetadata
- Cobalah!
Menampilkan metadata untuk dimensi dan metrik yang tersedia dalam metode pelaporan. Digunakan untuk menjelajahi dimensi dan metrik. Dalam metode ini, ID Properti GA4 Google Analytics ditentukan dalam permintaan, dan respons metadata mencakup dimensi dan metrik Kustom serta metadata Universal.
Misalnya, jika metrik kustom dengan nama parameter levels_unlocked
didaftarkan ke properti, respons Metadata akan berisi customEvent:levels_unlocked
. Metadata universal adalah dimensi dan metrik yang berlaku untuk properti apa pun seperti country
dan totalUsers
.
Permintaan HTTP
GET https://analyticsdata.googleapis.com/v1alpha/{name=properties/*/metadata}
URL menggunakan sintaksis gRPC Transcoding.
Parameter jalur
Parameter | |
---|---|
name |
Wajib. Nama resource metadata yang akan diambil. Kolom nama ini ditentukan di jalur URL, bukan parameter URL. Properti adalah ID Properti GA4 Google Analytics numerik. Untuk mempelajari lebih lanjut, lihat tempat menemukan ID Properti. Contoh: properties/1234/metadata Tetapkan ID Properti ke 0 untuk dimensi dan metrik yang sama untuk semua properti. Dalam mode khusus ini, metode ini tidak akan menampilkan dimensi dan metrik kustom. |
Isi permintaan
Isi permintaan harus kosong.
Isi respons
Jika berhasil, isi respons memuat data dengan struktur berikut:
Dimensi dan metrik yang saat ini diterima dalam metode pelaporan.
Representasi JSON | |
---|---|
{ "name": string, "dimensions": [ { object ( |
Kolom | |
---|---|
name |
Nama resource metadata ini. |
dimensions[] |
Deskripsi dimensi. |
metrics[] |
Deskripsi metrik. |
Cakupan Otorisasi
Memerlukan salah satu cakupan OAuth berikut:
https://www.googleapis.com/auth/analytics.readonly
https://www.googleapis.com/auth/analytics
DimensionMetadata
Menjelaskan dimensi.
Representasi JSON | |
---|---|
{ "apiName": string, "uiName": string, "description": string, "deprecatedApiNames": [ string ], "customDefinition": boolean } |
Kolom | |
---|---|
apiName |
Nama dimensi ini. Dapat digunakan di |
uiName |
Nama dimensi ini dalam antarmuka pengguna Google Analytics. Misalnya, |
description |
Deskripsi tentang cara penggunaan dan penghitungan dimensi ini. |
deprecatedApiNames[] |
Nama masih dapat digunakan, tetapi tidak digunakan lagi untuk dimensi ini. Jika diisi, dimensi ini tersedia oleh |
customDefinition |
Benar jika dimensi adalah dimensi kustom untuk properti ini. |
MetricMetadata
Menjelaskan metrik.
Representasi JSON | |
---|---|
{
"apiName": string,
"uiName": string,
"description": string,
"deprecatedApiNames": [
string
],
"type": enum ( |
Kolom | |
---|---|
apiName |
Nama metrik. Dapat digunakan di |
uiName |
Nama metrik ini di antarmuka pengguna Google Analytics. Misalnya, |
description |
Deskripsi tentang cara metrik ini digunakan dan dihitung. |
deprecatedApiNames[] |
Nama masih dapat digunakan, tetapi tidak digunakan lagi untuk metrik ini. Jika diisi, metrik ini tersedia oleh |
type |
Jenis metrik ini. |
expression |
Ekspresi matematika untuk metrik turunan ini. Dapat digunakan di kolom |
customDefinition |
Benar jika metrik adalah metrik kustom untuk properti ini. |