Method: properties.getMetadata

Trả về siêu dữ liệu cho các phương diện và chỉ số có 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 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 bạn đăng ký một chỉ số tuỳ chỉnh có tên tham số levels_unlocked cho một thuộc tính, thì phản hồi Siêu dữ liệu sẽ chứa customEvent:levels_unlocked. Siêu dữ liệu phổ quát là những phương diện và chỉ số á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à giá trị nhận dạng Tài sản GA4 dưới dạng số của Google Analytics. Để tìm hiểu thêm, hãy xem cách tìm mã tài sản của bạn.

Ví dụ: thuộc tính/1234/siêu dữ liệu

Đặt Mã tài sản thành 0 cho các phương diện và chỉ số chung cho tất cả tài sản. Trong chế độ đặc biệt này, phương pháp này sẽ không trả về các 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:

Những phương diện và chỉ số hiện được chấp nhận trong các 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ả về chỉ số.

Phạm vi uỷ quyền

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

  • 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ể sử dụng 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

Tên phương diện này vẫn có thể sử dụng được nhưng không được dùng nữa. Nếu được điền sẵn, phương diện này sẽ có sẵn vào apiName hoặc một trong số deprecatedApiNames trong một khoảng thời gian. Sau thời gian ngừng sử dụng này, chỉ apiName mới có thể sử dụng phương diện này.
customDefinition

boolean

Đúng nếu đó là 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ố. Có thể dùng 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ả về cách sử dụng và tính chỉ số này.
deprecatedApiNames[]

string

Vẫn có thể sử dụng được nhưng không dùng tên cho chỉ số này. Nếu được điền, chỉ số này sẽ có sẵn vào apiName hoặc một trong deprecatedApiNames trong một khoảng thời gian. Sau thời gian này, chỉ apiName mới có thể sử dụng chỉ số này.
type

enum (MetricType)

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

string

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

boolean

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