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 存在する場合、このプロパティの費用関連の指標へのアクセスはブロックされます。この指標は費用に関連します。