Method: properties.checkCompatibility

Metode kompatibilitas ini mencantumkan dimensi dan metrik yang dapat ditambahkan ke permintaan laporan dan mempertahankan kompatibilitas. Metode ini gagal jika dimensi dan metrik permintaan tidak kompatibel.

Di Google Analytics, laporan akan gagal jika meminta dimensi dan/atau metrik yang tidak kompatibel. Dalam hal ini, Anda harus menghapus dimensi dan/atau metrik dari laporan yang tidak kompatibel hingga laporan tersebut kompatibel.

Laporan Realtime dan Inti memiliki aturan kompatibilitas yang berbeda. Metode ini memeriksa kompatibilitas untuk laporan Inti.

Permintaan HTTP

POST https://analyticsdata.googleapis.com/v1beta/{property=properties/*}:checkCompatibility

URL menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
property

string

ID properti GA4 Google Analytics yang peristiwanya dilacak. Untuk mempelajari lebih lanjut, lihat tempat menemukan ID Properti. property harus sama dengan nilai dalam permintaan runReport Anda.

Contoh: properti/1234

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON 
{
  "dimensions": [
    {
      object (Dimension)
    }
  ],
  "metrics": [
    {
      object (Metric)
    }
  ],
  "dimensionFilter": {
    object (FilterExpression)
  },
  "metricFilter": {
    object (FilterExpression)
  },
  "compatibilityFilter": enum (Compatibility)
}
Kolom
dimensions[]

object (Dimension)

Dimensi dalam laporan ini. dimensions harus sama dengan nilai dalam permintaan runReport Anda.
metrics[]

object (Metric)

Metrik dalam laporan ini. metrics harus sama dengan nilai dalam permintaan runReport Anda.
dimensionFilter

object (FilterExpression)

Klausa filter dimensi. dimensionFilter harus sama dengan nilai dalam permintaan runReport Anda.
metricFilter

object (FilterExpression)

Klausa filter metrik. metricFilter harus sama dengan nilai dalam permintaan runReport Anda
compatibilityFilter

enum (Compatibility)

Memfilter dimensi dan metrik dalam respons hanya terhadap kompatibilitas ini. Biasa digunakan sebagai ”compatibilityFilter”: “COMPATIBLE” untuk hanya menampilkan dimensi & metrik yang kompatibel.

Isi respons

Respons kompatibilitas dengan kompatibilitas setiap dimensi & metrik.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "dimensionCompatibilities": [
    {
      object (DimensionCompatibility)
    }
  ],
  "metricCompatibilities": [
    {
      object (MetricCompatibility)
    }
  ]
}
Kolom
dimensionCompatibilities[]

object (DimensionCompatibility)

Kompatibilitas setiap dimensi.
metricCompatibilities[]

object (MetricCompatibility)

Kompatibilitas setiap metrik.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

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

Kompatibilitas

Jenis kompatibilitas untuk satu dimensi atau metrik.

Enumerasi
COMPATIBILITY_UNSPECIFIED Kompatibilitas tidak ditentukan.
COMPATIBLE Dimensi atau metrik kompatibel. Dimensi atau metrik ini dapat berhasil ditambahkan ke laporan.
INCOMPATIBLE Dimensi atau metrik tidak kompatibel. Dimensi atau metrik ini tidak dapat ditambahkan ke laporan.

DimensionCompatibility (Kompatibilitas Dimensi)

Kompatibilitas untuk satu dimensi.

Representasi JSON 
{
  "dimensionMetadata": {
    object (DimensionMetadata)
  },
  "compatibility": enum (Compatibility)
}
Kolom
dimensionMetadata

object (DimensionMetadata)

Metadata dimensi berisi nama API untuk informasi kompatibilitas ini. Metadata dimensi juga berisi informasi bermanfaat lainnya seperti nama dan deskripsi UI.
compatibility

enum (Compatibility)

Kompatibilitas dimensi ini. Jika kompatibilitasnya kompatibel, dimensi ini dapat ditambahkan ke laporan.

MetricCompatibility (Kompatibilitas Metrik)

Kompatibilitas untuk satu metrik.

Representasi JSON 
{
  "metricMetadata": {
    object (MetricMetadata)
  },
  "compatibility": enum (Compatibility)
}
Kolom
metricMetadata

object (MetricMetadata)

Metadata metrik berisi nama API untuk informasi kompatibilitas ini. Metadata metrik juga berisi informasi bermanfaat lainnya seperti nama dan deskripsi UI.
compatibility

enum (Compatibility)

Kompatibilitas metrik ini. Jika kompatibilitasnya KOMPATIBEL, metrik ini dapat berhasil ditambahkan ke laporan.