Method: properties.checkCompatibility

Phương thức tương thích này liệt kê những phương diện và chỉ số có thể được thêm vào yêu cầu báo cáo và duy trì khả năng tương thích. Phương thức này sẽ không thực hiện được nếu phương diện và chỉ số của yêu cầu không tương thích.

Trong Google Analytics, báo cáo sẽ không thành công nếu yêu cầu phương diện và/hoặc chỉ số không tương thích; trong trường hợp đó, bạn sẽ phải xoá các phương diện và/hoặc chỉ số khỏi báo cáo không tương thích cho đến khi báo cáo đó tương thích.

Báo cáo Theo thời gian thực và Báo cáo chính có các quy tắc tương thích khác nhau. Phương thức này kiểm tra khả năng tương thích cho các báo cáo Chính.

Yêu cầu HTTP

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

URL sử dụng cú pháp Chuyển mã gRPC.

Tham số đường dẫn

Tham số
property

string

Giá trị nhận dạng tài sản GA4 của Google Analytics có các sự kiện được theo dõi. Để tìm hiểu thêm, hãy xem nơi xem Mã tài sản. property phải có cùng giá trị như trong yêu cầu runReport của bạn.

Ví dụ: thuộc tính/1234

Nội dung yêu cầu

Nội dung yêu cầu chứa dữ liệu có cấu trúc sau:

Biểu diễn dưới dạng JSON 
{
  "dimensions": [
    {
      object (Dimension)
    }
  ],
  "metrics": [
    {
      object (Metric)
    }
  ],
  "dimensionFilter": {
    object (FilterExpression)
  },
  "metricFilter": {
    object (FilterExpression)
  },
  "compatibilityFilter": enum (Compatibility)
}
Trường
dimensions[]

object (Dimension)

Các phương diện trong báo cáo này. dimensions phải có cùng giá trị như trong yêu cầu runReport của bạn.
metrics[]

object (Metric)

Các chỉ số trong báo cáo này. metrics phải có cùng giá trị như trong yêu cầu runReport của bạn.
dimensionFilter

object (FilterExpression)

Mệnh đề bộ lọc của phương diện. dimensionFilter phải có cùng giá trị như trong yêu cầu runReport của bạn.
metricFilter

object (FilterExpression)

Mệnh đề bộ lọc của chỉ số. metricFilter phải có cùng giá trị như trong yêu cầu runReport của bạn
compatibilityFilter

enum (Compatibility)

Lọc các phương diện và chỉ số để chỉ đáp ứng khả năng tương thích này. Thường được dùng dưới dạng ”compatibilityFilter”: “COMPATIBLE” để chỉ trả về các phương diện và phương diện tương thích chỉ số.

Nội dung phản hồi

Phản hồi về khả năng tương thích với khả năng tương thích của từng phương diện và chỉ số.

Nếu thành công, phần nội dung phản hồi sẽ chứa dữ liệu có cấu trúc sau:

Biểu diễn dưới dạng JSON 
{
  "dimensionCompatibilities": [
    {
      object (DimensionCompatibility)
    }
  ],
  "metricCompatibilities": [
    {
      object (MetricCompatibility)
    }
  ]
}
Trường
dimensionCompatibilities[]

object (DimensionCompatibility)

Khả năng tương thích của từng phương diện.
metricCompatibilities[]

object (MetricCompatibility)

Khả năng tương thích của từng chỉ số.

Phạm vi uỷ quyền

Yêu cầu một trong các phạm vi OAuth sau:

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

Khả năng tương thích

Các loại khả năng tương thích cho một phương diện hoặc chỉ số.

Enum
COMPATIBILITY_UNSPECIFIED Khả năng tương thích không xác định.
COMPATIBLE Phương diện hoặc chỉ số này tương thích. Bạn có thể thêm thành công phương diện hoặc chỉ số này vào báo cáo.
INCOMPATIBLE Phương diện hoặc chỉ số không tương thích. Không thể thêm thành công phương diện hoặc chỉ số này vào báo cáo.

DimensionCompatibility

Khả năng tương thích cho một phương diện.

Biểu diễn dưới dạng JSON 
{
  "dimensionMetadata": {
    object (DimensionMetadata)
  },
  "compatibility": enum (Compatibility)
}
Trường
dimensionMetadata

object (DimensionMetadata)

Siêu dữ liệu về phương diện chứa tên API cho thông tin về khả năng tương thích này. Siêu dữ liệu của phương diện cũng chứa các thông tin hữu ích khác như tên và nội dung mô tả về giao diện người dùng.
compatibility

enum (Compatibility)

Khả năng tương thích của phương diện này. Nếu khả năng tương thích là TƯƠNG THÍCH, thì bạn có thể thêm thành công phương diện này vào báo cáo.

MetricCompatibility

Khả năng tương thích của một chỉ số.

Biểu diễn dưới dạng JSON 
{
  "metricMetadata": {
    object (MetricMetadata)
  },
  "compatibility": enum (Compatibility)
}
Trường
metricMetadata

object (MetricMetadata)

Siêu dữ liệu về chỉ số chứa tên API cho thông tin về khả năng tương thích này. Siêu dữ liệu về chỉ số cũng chứa các thông tin hữu ích khác như tên và nội dung mô tả về giao diện người dùng.
compatibility

enum (Compatibility)

Khả năng tương thích của chỉ số này. Nếu khả năng tương thích là TƯƠNG THÍCH, thì bạn có thể thêm thành công chỉ số này vào báo cáo.