Method: properties.getMetadata

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

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

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数
name

string

必需。要检索的元数据的资源名称。此名称字段在网址路径中指定，而不是在网址参数中指定。Property 是一个数字型 Google Analytics 媒体资源标识符。如需了解详情，请参阅在哪里查找媒体资源 ID。

示例：properties/1234/metadata

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

请求正文

请求正文必须为空。

响应正文

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

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

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

string

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

object (DimensionMetadata)

维度说明。
metrics[]

object (MetricMetadata)

指标说明。
comparisons[]

object (ComparisonMetadata)

比较说明。
conversions[]

object (ConversionMetadata)

转化说明。

授权范围

需要以下 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,
  "category": string,
  "sections": [
    enum (Section)
  ]
}
字段
apiName

string

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

string

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

string

对此维度的使用方式和计算方式的说明。
deprecatedApiNames[]

string

此维度仍可使用但已废弃的名称。如果填充了此字段，则在一段时间内，此维度可通过 apiName 或其中一个 deprecatedApiNames 来使用。在废弃期结束后，此维度将只能通过 apiName 来使用。
customDefinition

boolean

如果此维度是此媒体资源的自定义维度，则为 true。这包括用户级、事件级和商品级自定义维度；如需详细了解自定义维度，请参阅 https://support.google.com/analytics/answer/14240153。这还包括自定义渠道组；如需详细了解自定义渠道组，请参阅 https://support.google.com/analytics/answer/13051316。
category

string

此维度所属类别的显示名称。相似的维度和指标会归为一类。
sections[]

enum (Section)

指定此维度适用的 Google Analytics 部分。

MetricMetadata

说明指标。

JSON 表示法 
{
  "apiName": string,
  "uiName": string,
  "description": string,
  "deprecatedApiNames": [
    string
  ],
  "type": enum (MetricType),
  "expression": string,
  "customDefinition": boolean,
  "blockedReasons": [
    enum (BlockedReason)
  ],
  "category": string,
  "sections": [
    enum (Section)
  ]
}
字段
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。
blockedReasons[]

enum (BlockedReason)

如果指定了原因，则您无法访问此媒体资源的此指标。您向此媒体资源发出的此指标的 API 请求将会成功；不过，报告中此指标的值将仅包含零。对被屏蔽的指标使用指标过滤条件的 API 请求将会失败。如果原因为空，则您可以访问此指标。

如需了解详情，请参阅访问权限和数据限制管理。
category

string

此指标所属类别的显示名称。相似的维度和指标会归为一类。
sections[]

enum (Section)

指定此指标适用的 Google Analytics 部分。

BlockedReason

说明此指标被屏蔽的原因。

枚举
BLOCKED_REASON_UNSPECIFIED 永远不会在 API 响应中指定。
NO_REVENUE_METRICS 如果存在，则您无法访问此媒体资源的收入相关指标，并且此指标与收入相关。
NO_COST_METRICS 如果存在，则您无法访问此媒体资源的费用相关指标，并且此指标与费用相关。

ComparisonMetadata

单个比较的元数据。

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

string

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

string

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

string

此比较的说明。

ConversionMetadata

单个转化的元数据。

JSON 表示法 
{
  "conversionAction": string,
  "displayName": string
}
字段
conversionAction

string

转化操作的唯一标识符。此 ID 用于指定要在报告中纳入哪些转化，方法是在报告请求的 ConversionsSpec 中填充 conversionActions 字段。例如，“conversionActions/1234”。
displayName

string

此转化在 Google Analytics 界面中的名称。