Method: properties.getMetadata

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

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

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数
name

string

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

示例：property/1234/metadata

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

请求正文

请求正文必须为空。

响应正文

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

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

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

string

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

object (DimensionMetadata)

维度说明。
metrics[]

object (MetricMetadata)

指标说明。
comparisons[]

object (ComparisonMetadata)

比较说明。

授权范围

需要以下 OAuth 范围之一：

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

ComparisonMetadata

单个比较项的元数据。

JSON 表示法 
{
  "apiName": string,
  "uiName": string,
  "description": string
}
字段
apiName

string

此比较的资源名称。可在比较工具的 comparison 字段中使用。例如，'comparisons/1234'。
uiName

string

此对比项在 Google Analytics 界面中的名称。
description

string

此比较的说明。