Method: properties.getMetadata

Trả về siêu dữ liệu cho các phương diện và chỉ số có trong các phương thức báo cáo. Dùng để khám phá các phương diện và chỉ số. Trong phương thức này, một mã nhận dạng tài sản Google Analytics được chỉ định trong yêu cầu và phản hồi siêu dữ liệu bao gồm 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 tham số 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 Universal là các 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 tham số URL. Tài sản là mã nhận dạng tài sản Google Analytics bằng số. Để tìm hiểu thêm, hãy xem bài viết Tìm mã tài sản.

Ví dụ: properties/1234/metadata

Đặ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. Ở chế độ đặc biệt này, phương thức 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

Các phương diện, chỉ số và phép so sánh hiện được chấp nhận trong các phương thức 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)
    }
  ],
  "comparisons": [
    {
      object (ComparisonMetadata)
    }
  ]
}
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ố.
comparisons[]

object (ComparisonMetadata)

Nội dung mô tả phép so sánh.

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

ComparisonMetadata

Siêu dữ liệu cho một phép so sánh.

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

string

Tên tài nguyên của phép so sánh này. Có thể dùng trong trường comparison của Phép so sánh. Ví dụ: "comparisons/1234".
uiName

string

Tên của phép so sánh này trong giao diện người dùng Google Analytics.
description

string

Nội dung mô tả của phép so sánh này.