Method: properties.getMetadata

Trả về siêu dữ liệu cho các phương diện và chỉ số có sẵn trong phương pháp báo cáo. Dùng để khám phá các phương diện và chỉ số. Trong phương pháp này, một Giá trị nhận dạng tài sản GA4 của Google Analytics được chỉ định trong yêu cầu và phản hồi của siêu dữ liệu bao gồm các phương diện và chỉ số tuỳ chỉnh cũng như siêu dữ liệu Universal.

Ví dụ: nếu một chỉ số tuỳ chỉnh có tên thông số là levels_unlocked được đăng ký cho một tài sản, thì phản hồi Siêu dữ liệu sẽ chứa customEvent:levels_unlocked. Siêu dữ liệu chung là các phương diện và chỉ số có thể áp dụng cho mọi tài sản, chẳng hạn như country và totalUsers.

Yêu cầu HTTP

GET https://analyticsdata.googleapis.com/v1alpha/{name=properties/*/metadata}

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

Tham số đường dẫn

Tham số
name

string

Bắt buộc. Tên tài nguyên của siêu dữ liệu cần truy xuất. Trường tên này được chỉ định trong đường dẫn URL chứ không phải trong tham số URL. Tài sản là một giá trị nhận dạng tài sản GA4 trên Google Analytics. Để tìm hiểu thêm, hãy xem nơi xem Mã tài sản.

Ví dụ: Properties/1234/metadata

Đặt Mã tài sản thành 0 cho những phương diện và chỉ số chung cho tất cả tài sản. Ở chế độ đặc biệt này, phương thức này sẽ không trả về phương diện và chỉ số tuỳ chỉnh.

Nội dung yêu cầu

Nội dung yêu cầu phải trống.

Nội dung phản hồi

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:

Các phương diện và chỉ số hiện được chấp nhận trong phương pháp báo cáo.

Biểu diễn dưới dạng JSON 
{
  "name": string,
  "dimensions": [
    {
      object (DimensionMetadata)
    }
  ],
  "metrics": [
    {
      object (MetricMetadata)
    }
  ]
}
Trường
name

string

Tên tài nguyên của siêu dữ liệu này.
dimensions[]

object (DimensionMetadata)

Nội dung mô tả phương diện.
metrics[]

object (MetricMetadata)

Nội dung mô tả chỉ số.

Phạm vi cấp phép

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

DimensionMetadata

Giải thích một phương diện.

Biểu diễn dưới dạng JSON 
{
  "apiName": string,
  "uiName": string,
  "description": string,
  "deprecatedApiNames": [
    string
  ],
  "customDefinition": boolean
}
Trường
apiName

string

Tên của phương diện này. Có thể dùng được trong name của Kích thước. Ví dụ: eventName.
uiName

string

Tên của phương diện này trong giao diện người dùng Google Analytics. Ví dụ: Event name.
description

string

Nội dung mô tả về cách sử dụng và tính toán phương diện này.
deprecatedApiNames[]

string

Vẫn là tên hữu dụng nhưng không dùng nữa cho phương diện này. Nếu được điền sẵn, phương diện này sẽ được cung cấp trước apiName hoặc một trong các phương diện deprecatedApiNames trong một khoảng thời gian. Sau giai đoạn ngừng sử dụng, phương diện này sẽ chỉ có sẵn muộn nhất vào apiName.
customDefinition

boolean

Đúng nếu phương diện đó là một phương diện tuỳ chỉnh cho tài sản này.

MetricMetadata

Giải thích một chỉ số.

Biểu diễn dưới dạng JSON 
{
  "apiName": string,
  "uiName": string,
  "description": string,
  "deprecatedApiNames": [
    string
  ],
  "type": enum (MetricType),
  "expression": string,
  "customDefinition": boolean
}
Trường
apiName

string

Tên chỉ số. Dùng được trong name của Chỉ số. Ví dụ: eventCount.
uiName

string

Tên của chỉ số này trong giao diện người dùng Google Analytics. Ví dụ: Event count.
description

string

Nội dung mô tả cách sử dụng và tính toán chỉ số này.
deprecatedApiNames[]

string

Tên vẫn hữu dụng nhưng không dùng nữa cho chỉ số này. Nếu được điền, chỉ số này sẽ xuất hiện trước apiName hoặc deprecatedApiNames trong một khoảng thời gian. Sau giai đoạn ngừng sử dụng, chỉ số này sẽ chỉ có sẵn muộn nhất vào apiName.
type

enum (MetricType)

Loại của chỉ số này.
expression

string

Biểu thức toán học cho chỉ số phát sinh này. Bạn có thể dùng thuộc tính này trong trường expression của Chỉ số cho các báo cáo tương đương. Hầu hết chỉ số không phải là biểu thức và đối với biểu thức không phải biểu thức, trường này sẽ trống.
customDefinition

boolean

Đúng nếu chỉ số là một chỉ số tuỳ chỉnh cho tài sản này.