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/v1beta/{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

Dimensi, metrik, dan perbandingan yang saat ini diterima dalam metode pelaporan.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "name": string,
  "dimensions": [
    {
      object (DimensionMetadata)
    }
  ],
  "metrics": [
    {
      object (MetricMetadata)
    }
  ],
  "comparisons": [
    {
      object (ComparisonMetadata)
    }
  ]
}
Kolom
name

string

Nama resource metadata ini.
dimensions[]

object (DimensionMetadata)

Deskripsi dimensi.
metrics[]

object (MetricMetadata)

Deskripsi metrik.
comparisons[]

object (ComparisonMetadata)

Deskripsi perbandingan.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

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

ComparisonMetadata

Metadata untuk satu perbandingan.

Representasi JSON 
{
  "apiName": string,
  "uiName": string,
  "description": string
}
Kolom
apiName

string

Nama resource perbandingan ini. Dapat digunakan di kolom comparison Comparison. Misalnya, 'perbandingan/1234'.
uiName

string

Nama perbandingan ini dalam antarmuka pengguna Google Analytics.
description

string

Deskripsi perbandingan ini.