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/v1beta/{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

Những phương diện, chỉ số và thông tin so sánh hiện được chấp nhận trong các phương pháp báo cáo.

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 
{
  "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