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