Method: properties.getMetadata

Menampilkan metadata untuk dimensi dan metrik yang tersedia dalam metode pelaporan. Digunakan untuk menjelajahi dimensi dan metrik. Dalam metode ini, ID properti 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 ini menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
name

string

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

Contoh: properties/1234/metadata

Setel ID Properti ke 0 untuk dimensi dan metrik yang umum 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)
    }
  ],
  "conversions": [
    {
      object (ConversionMetadata)
    }
  ]
}
Kolom
name

string

Nama resource metadata ini.
dimensions[]

object (DimensionMetadata)

Deskripsi dimensi.
metrics[]

object (MetricMetadata)

Deskripsi metrik.
comparisons[]

object (ComparisonMetadata)

Deskripsi perbandingan.
conversions[]

object (ConversionMetadata)

Deskripsi konversi.

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,
  "category": string,
  "sections": [
    enum (Section)
  ]
}
Kolom
apiName

string

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

string

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

string

Deskripsi cara penggunaan dan penghitungan dimensi ini.
deprecatedApiNames[]

string

Nama yang masih dapat digunakan tetapi tidak digunakan lagi untuk dimensi ini. Jika diisi, dimensi ini tersedia menurut apiName atau salah satu deprecatedApiNames selama jangka waktu tertentu. Setelah periode penghentian penggunaan, dimensi hanya akan tersedia berdasarkan apiName.
customDefinition

boolean

Benar (True) jika dimensi bersifat kustom untuk properti ini. Hal ini mencakup dimensi kustom cakupan pengguna, peristiwa, & item; untuk mempelajari lebih lanjut dimensi kustom, lihat https://support.google.com/analytics/answer/14240153. Hal ini juga mencakup grup saluran kustom; untuk mempelajari grup saluran kustom lebih lanjut, lihat https://support.google.com/analytics/answer/13051316.
category

string

Nama tampilan kategori tempat dimensi ini berada. Dimensi dan metrik serupa dikategorikan bersama.
sections[]

enum (Section)

Menentukan bagian Google Analytics yang menerapkan dimensi ini.

MetricMetadata

Menjelaskan metrik.

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

string

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

string

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

string

Deskripsi cara penggunaan dan penghitungan metrik ini.
deprecatedApiNames[]

string

Nama yang masih dapat digunakan tetapi tidak digunakan lagi untuk metrik ini. Jika diisi, metrik ini tersedia menurut apiName atau salah satu deprecatedApiNames selama jangka waktu tertentu. Setelah periode penghentian penggunaan, metrik hanya akan tersedia melalui 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 bukan ekspresi, dan untuk non-ekspresi, kolom ini kosong.
customDefinition

boolean

Benar (True) jika metrik adalah metrik kustom untuk properti ini.
blockedReasons[]

enum (BlockedReason)

Jika alasan ditentukan, akses Anda ke metrik ini akan diblokir untuk properti ini. Permintaan API dari Anda ke properti ini untuk metrik ini akan berhasil; namun, laporan hanya akan berisi nol untuk metrik ini. Permintaan API dengan filter metrik pada metrik yang diblokir akan gagal. Jika alasan kosong, Anda memiliki akses ke metrik ini.

Untuk mempelajari lebih lanjut, lihat Pengelolaan akses dan batasan data.
category

string

Nama tampilan kategori tempat metrik ini berada. Dimensi dan metrik serupa dikategorikan bersama.
sections[]

enum (Section)

Menentukan bagian Google Analytics yang menerapkan metrik ini.

BlockedReason

Justifikasi mengapa metrik ini diblokir.

Enum
BLOCKED_REASON_UNSPECIFIED Tidak akan pernah ditentukan dalam respons API.
NO_REVENUE_METRICS Jika ada, akses Anda ke metrik terkait pendapatan untuk properti ini diblokir, dan metrik ini terkait dengan pendapatan.
NO_COST_METRICS Jika ada, akses Anda ke metrik terkait biaya untuk properti ini diblokir, dan metrik ini terkait biaya.

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 Perbandingan. Misalnya, 'comparisons/1234'.
uiName

string

Nama perbandingan ini dalam antarmuka pengguna Google Analytics.
description

string

Deskripsi perbandingan ini.

ConversionMetadata

Metadata untuk satu konversi.

Representasi JSON 
{
  "conversionAction": string,
  "displayName": string
}
Kolom
conversionAction

string

ID unik tindakan konversi. ID ini digunakan untuk menentukan konversi mana yang akan disertakan dalam laporan dengan mengisi kolom conversionActions di ConversionsSpec permintaan laporan. Misalnya, 'conversionActions/1234'.
displayName

string

Nama konversi ini dalam antarmuka pengguna Google Analytics.