MetricMetadata

指標について説明します。

JSON 表現 
{
  "apiName": string,
  "uiName": string,
  "description": string,
  "deprecatedApiNames": [
    string
  ],
  "type": enum (MetricType),
  "expression": string,
  "customDefinition": boolean,
  "blockedReasons": [
    enum (BlockedReason)
  ],
  "category": string
}
フィールド
apiName

string

指標名。指標の name で使用できます。例: eventCount
uiName

string

Google アナリティクスの管理画面でのこの指標の名前。例: 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

この指標が属するカテゴリの表示名。類似のディメンションと指標はまとめて分類されます。

BlockedReason

この指標がブロックされている理由。

列挙型
BLOCKED_REASON_UNSPECIFIED API レスポンスで指定されることはありません。
NO_REVENUE_METRICS 存在する場合、このプロパティの収益関連の指標へのアクセスはブロックされ、この指標は収益に関連しています。
NO_COST_METRICS 存在する場合、このプロパティの費用関連の指標へのアクセスはブロックされ、この指標は費用に関連しています。