Method: properties.getMetadata

返回报告方法中提供的维度和指标的元数据。用于探索维度和指标。在此方法中,Google Analytics(分析)GA4 媒体资源标识符在请求中指定,元数据响应包括自定义维度和指标以及通用元数据。

例如,如果将名为参数 levels_unlocked 的自定义指标注册到媒体资源,则元数据响应将包含 customEvent:levels_unlocked。通用元数据是适用于任何媒体资源(如 countrytotalUsers)的维度和指标。

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数
name

string

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

示例:properties/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