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. Được dùng để khám phá các phương diện và chỉ số. Trong phương thức này, giá trị 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 Phương diện và chỉ số tuỳ chỉnh cũng như Siêu dữ liệu chung.

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 phổ biến 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 tham số URL. Property là giá trị 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 nơi tìm mã tài sản.

Ví dụ: properties/1234/metadata

Đặt mã nhận dạng 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ề 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 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)
    }
  ],
  "comparisons": [
    {
      object (ComparisonMetadata)
    }
  ],
  "conversions": [
    {
      object (ConversionMetadata)
    }
  ]
}
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ố.
comparisons[]

object (ComparisonMetadata)

Nội dung mô tả so sánh.
conversions[]

object (ConversionMetadata)

Nội dung mô tả về lượt chuyển đổi.

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

DimensionMetadata

Giải thích về 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,
  "category": string,
  "sections": [
    enum (Section)
  ]
}
Trường
apiName

string

Tên của phương diện này. Có thể dùng trong name của Dimension. 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 vẫn dùng được nhưng không được 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ó sẵn theo apiName hoặc một trong các deprecatedApiNames trong một khoảng thời gian. Sau thời gian ngừng cung cấp, bạn chỉ có thể sử dụng phương diện này bằng cách apiName.
customDefinition

boolean

Đúng nếu phương diện là phương diện tuỳ chỉnh đối với tài sản này. Trong đó có phương diện tuỳ chỉnh ở phạm vi người dùng, sự kiện và mặt hàng; để tìm hiểu thêm về phương diện tuỳ chỉnh, hãy xem bài viết https://support.google.com/analytics/answer/14240153. Điều này cũng bao gồm các nhóm kênh tuỳ chỉnh; để tìm hiểu thêm về các nhóm kênh tuỳ chỉnh, hãy xem https://support.google.com/analytics/answer/13051316.
category

string

Tên hiển thị của danh mục mà phương diện này thuộc về. Các phương diện và chỉ số tương tự được phân loại cùng nhau.
sections[]

enum (Section)

Chỉ định các mục Google Analytics mà phương diện này áp dụng.

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,
  "blockedReasons": [
    enum (BlockedReason)
  ],
  "category": string,
  "sections": [
    enum (Section)
  ]
}
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 toán chỉ số này.
deprecatedApiNames[]

string

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

enum (MetricType)

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

string

Biểu thức toán học cho chỉ số phái sinh này. Có thể 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à đối với các chỉ số không phải là biểu thức, trường này sẽ trống.
customDefinition

boolean

True nếu chỉ số là chỉ số tuỳ chỉnh cho tài sản này.
blockedReasons[]

enum (BlockedReason)

Nếu có lý do cụ thể, bạn sẽ bị chặn truy cập vào chỉ số này cho tài sản này. Các yêu cầu API của bạn đối với tài sản này cho chỉ số này sẽ thành công; tuy nhiên, báo cáo sẽ chỉ chứa các số 0 cho chỉ số này. Các yêu cầu API có bộ lọc chỉ số trên các chỉ số bị chặn sẽ không thành công. Nếu không có lý do, bạn có quyền truy cập vào chỉ số này.

Để tìm hiểu thêm, hãy xem bài viết Quản lý quyền truy cập và quy tắc hạn chế về dữ liệu.
category

string

Tên hiển thị của danh mục mà chỉ số này thuộc về. Các phương diện và chỉ số tương tự được phân loại cùng nhau.
sections[]

enum (Section)

Chỉ định các mục Google Analytics mà chỉ số này áp dụng.

BlockedReason

Lý do chỉ số này bị chặn.

Enum
BLOCKED_REASON_UNSPECIFIED Sẽ không bao giờ được chỉ định trong phản hồi API.
NO_REVENUE_METRICS Nếu có, quyền truy cập của bạn vào các chỉ số liên quan đến doanh thu cho tài sản này sẽ bị chặn và chỉ số này có liên quan đến doanh thu.
NO_COST_METRICS Nếu có, quyền truy cập của bạn sẽ bị chặn đối với các chỉ số liên quan đến chi phí cho tài sản này và chỉ số này có liên quan đến chi phí.

ComparisonMetadata

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

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ể sử dụng trong trường comparison của Thông tin 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 thông tin so sánh này.

ConversionMetadata

Siêu dữ liệu cho một lượt chuyển đổi duy nhất.

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

string

Giá trị nhận dạng riêng biệt của hành động chuyển đổi. Mã này được dùng để chỉ định những lượt chuyển đổi cần đưa vào báo cáo bằng cách điền sẵn trường conversionActions trong ConversionsSpec của một yêu cầu báo cáo. Ví dụ: "conversionActions/1234".
displayName

string

Tên của lượt chuyển đổi này trong giao diện người dùng Google Analytics.