Method: properties.getMetadata

返回报告方法中可用的维度和指标的元数据。用于探索维度和指标。在此方法中，系统会在请求中指定 Google Analytics GA4 媒体资源标识符，元数据响应包含自定义维度和指标以及通用元数据。

例如，如果参数名称为 levels_unlocked 的自定义指标注册了某个媒体资源，则元数据响应将包含 customEvent:levels_unlocked。通用元数据是适用于任何媒体资源（如 country 和 totalUsers）的维度和指标。

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数
name

string

必需。要检索的元数据的资源名称。此名称字段在网址路径（而非网址参数）中指定。媒体资源是数字形式的 Google Analytics GA4 媒体资源标识符。如需了解详情，请参阅在哪里可以找到您的媒体资源 ID。

示例：property/1234/metadata

对于所有媒体资源通用的维度和指标，请将媒体资源 ID 设置为 0。在此特殊模式下，此方法不会返回自定义维度和指标。

请求正文

请求正文必须为空。

响应正文

如果成功，响应正文将包含结构如下的数据：

报告方法中目前接受的维度和指标。

JSON 表示法 
{
  "name": string,
  "dimensions": [
    {
      object (DimensionMetadata)
    }
  ],
  "metrics": [
    {
      object (MetricMetadata)
    }
  ]
}
字段
name

string

此元数据的资源名称。
dimensions[]

object (DimensionMetadata)

维度说明。
metrics[]

object (MetricMetadata)

指标说明。

授权范围

需要以下 OAuth 范围之一：

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics

DimensionMetadata

解释维度。

JSON 表示法 
{
  "apiName": string,
  "uiName": string,
  "description": string,
  "deprecatedApiNames": [
    string
  ],
  "customDefinition": boolean
}
字段
apiName

string

此维度的名称。可在 Dimension 的 name 中使用。例如 eventName。
uiName

string

此维度在 Google Analytics 界面中的名称。例如 Event name。
description

string

说明如何使用和计算此维度。
deprecatedApiNames[]

string

此维度仍然可用，但已弃用的名称。如果填充了此维度，则在一段时间内，apiName 或 deprecatedApiNames 中的任何一个都会提供此维度。弃用期结束后，此维度将只能在 apiName之前使用。
customDefinition

boolean

如果该维度是此媒体资源的自定义维度，则为 true。

MetricMetadata

解释指标。

JSON 表示法 
{
  "apiName": string,
  "uiName": string,
  "description": string,
  "deprecatedApiNames": [
    string
  ],
  "type": enum (MetricType),
  "expression": string,
  "customDefinition": boolean
}
字段
apiName

string

指标名称。可在指标的 name 中使用。例如 eventCount。
uiName

string

此指标在 Google Analytics 界面中的名称。例如 Event count。
description

string

有关此指标如何使用和计算的说明。
deprecatedApiNames[]

string

此指标的名称仍然可用，但已弃用。如果填充了此字段，则此指标将在一段时间内通过 apiName 或 deprecatedApiNames 之一保持可用。弃用期结束后，该指标将只在 apiName之前可用。
type

enum (MetricType)

此指标的类型。
expression

string

此派生指标的数学表达式。可用于等效报告的指标的 expression 字段。大多数指标不是表达式，对于非表达式，此字段为空。
customDefinition

boolean

如果指标是此媒体资源的自定义指标，则为 true。