Method: properties.getMetadata

Menampilkan metadata untuk dimensi dan metrik yang tersedia dalam metode pelaporan. Digunakan untuk mempelajari 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

string

Wajib. Nama resource metadata yang akan diambil. Kolom nama ini ditentukan di jalur URL, bukan di parameter URL. Properti adalah ID Properti GA4 Google Analytics numerik. Untuk mempelajari lebih lanjut, lihat tempat menemukan ID Properti Anda.

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 (DimensionMetadata)
    }
  ],
  "metrics": [
    {
      object (MetricMetadata)
    }
  ]
}
Kolom
name

string

Nama resource metadata ini.
dimensions[]

object (DimensionMetadata)

Deskripsi dimensi.
metrics[]

object (MetricMetadata)

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

string

Nama dimensi ini. Dapat digunakan di name Dimensi. Misalnya, eventName.
uiName

string

Nama dimensi ini dalam antarmuka pengguna Google Analytics. Misalnya, Event name.
description

string

Deskripsi tentang cara penggunaan dan penghitungan dimensi ini.
deprecatedApiNames[]

string

Nama untuk dimensi ini masih dapat digunakan, tetapi tidak digunakan lagi. Jika terisi, dimensi ini tersedia oleh apiName atau salah satu dari deprecatedApiNames selama jangka waktu tertentu. Setelah periode penghentian penggunaan, dimensi hanya akan tersedia paling lambat apiName.
customDefinition

boolean

Benar jika dimensi adalah dimensi kustom untuk properti ini.

MetricMetadata

Menjelaskan metrik.

Representasi JSON 
{
  "apiName": string,
  "uiName": string,
  "description": string,
  "deprecatedApiNames": [
    string
  ],
  "type": enum (MetricType),
  "expression": string,
  "customDefinition": boolean
}
Kolom
apiName

string

Nama metrik. Dapat digunakan di name Metric. Misalnya, eventCount.
uiName

string

Nama metrik ini dalam antarmuka pengguna Google Analytics. Misalnya, Event count.
description

string

Deskripsi tentang cara metrik ini digunakan dan dihitung.
deprecatedApiNames[]

string

Nama untuk metrik ini masih dapat digunakan, tetapi tidak digunakan lagi. Jika terisi, metrik ini tersedia melalui apiName atau salah satu dari deprecatedApiNames selama jangka waktu tertentu. Setelah periode penghentian penggunaan, metrik hanya akan tersedia paling lambat apiName.
type

enum (MetricType)

Jenis metrik ini.
expression

string

Ekspresi matematika untuk metrik turunan ini. Dapat digunakan di kolom expression Metrik untuk laporan yang setara. Sebagian besar metrik bukanlah ekspresi, dan untuk non-ekspresi, kolom ini kosong.
customDefinition

boolean

Benar jika metrik adalah metrik kustom untuk properti ini.