返回报告方法中提供的维度和指标的元数据。用于探索维度和指标。在此方法中,在请求中指定 Google Analytics(分析)GA4 媒体资源标识符,并且元数据响应包括自定义维度和指标以及 Universal 元数据。
例如,如果参数名称为 levels_unlocked
的自定义指标注册了某个媒体资源,则元数据响应将包含 customEvent:levels_unlocked
。通用元数据是适用于任何媒体资源(例如 country
和 totalUsers
)的维度和指标。
HTTP 请求
GET https://analyticsdata.googleapis.com/v1alpha/{name=properties/*/metadata}
网址采用 gRPC 转码语法。
路径参数
参数 | |
---|---|
name |
必需。要检索的元数据的资源名称。此名称字段是在网址路径(而不是网址参数)中指定的。媒体资源是数字形式的 Google Analytics(分析)GA4 媒体资源标识符。如需了解详情,请参阅在哪里查找媒体资源 ID。 示例:properties/1234/metadata 对于所有媒体资源共有的维度和指标,请将媒体资源 ID 设置为 0。在这种特殊模式下,此方法不会返回自定义维度和指标。 |
请求正文
请求正文必须为空。
响应正文
如果成功,响应正文将包含结构如下的数据:
报告方法中目前接受的维度和指标。
JSON 表示法 | |
---|---|
{ "name": string, "dimensions": [ { object ( |
字段 | |
---|---|
name |
此元数据的资源名称。 |
dimensions[] |
维度说明。 |
metrics[] |
指标说明。 |
授权范围
需要以下 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 |
此维度的名称。可在 Dimension 的 |
uiName |
此维度在 Google Analytics(分析)界面中的名称。例如 |
description |
有关如何使用此维度和计算此维度的说明。 |
deprecatedApiNames[] |
此维度的名称仍然可用,但已被废弃。如果填充了此维度,则 |
customDefinition |
如果维度是此属性的自定义维度,则为 true。 |
MetricMetadata
解释指标。
JSON 表示法 | |
---|---|
{
"apiName": string,
"uiName": string,
"description": string,
"deprecatedApiNames": [
string
],
"type": enum ( |
字段 | |
---|---|
apiName |
指标名称。可在 Metric 的 |
uiName |
此指标在 Google Analytics(分析)界面中的名称。例如 |
description |
此指标的使用和计算方式的说明。 |
deprecatedApiNames[] |
此指标的名称仍然可用,但已被废弃。如果填充了此指标,则 |
type |
此指标的类型。 |
expression |
此派生指标的数学表达式。可用于指标的 |
customDefinition |
如果指标是此属性的自定义指标,则为 true。 |