REST Resource: properties.customMetrics

リソース: CustomMetric

カスタム指標の定義。

JSON 表現 
{
  "name": string,
  "parameterName": string,
  "displayName": string,
  "description": string,
  "measurementUnit": enum (MeasurementUnit),
  "scope": enum (MetricScope),
  "restrictedMetricType": [
    enum (RestrictedMetricType)
  ]
}
フィールド
name

string

出力専用。この CustomMetric リソースのリソース名。形式: properties/{property}/customMetrics/{customMetric}
parameterName

string

必須。変更不可。このカスタム指標のタグ付け名。

イベント スコープの指標の場合は、イベント パラメータ名です。

使用できるのは英数字とアンダースコアのみで、先頭は英字です。イベント スコープの指標の最大文字数は 40 文字です。
displayName

string

必須。アナリティクスの管理画面に表示される、このカスタム指標の表示名。最大長は 82 文字で、英数字、スペース、アンダースコアは英字で始まる必要があります。システムが生成した従来の表示名には角かっこを含めることができますが、このフィールドを更新しても角かっこは使用できません。
description

string

省略可。このカスタム ディメンションの説明。最大長は 150 文字です。
measurementUnit

enum (MeasurementUnit)

必須。カスタム指標の値のタイプ。
scope

enum (MetricScope)

必須。変更不可。このカスタム指標のスコープ。
restrictedMetricType[]

enum (RestrictedMetricType)

省略可。この指標に含まれる可能性がある制限付きデータの種類。測定単位が CURRENCY の指標では必須。測定単位が通貨ではない指標の場合は空にする必要があります。

MeasurementUnit

カスタム指標の値を表すタイプ。

将来、通貨の表現が変更される可能性があり、互換性を破る API の変更が必要になります。

列挙型
MEASUREMENT_UNIT_UNSPECIFIED MeasurementUnit が指定されていないか、存在しません。
STANDARD この指標ではデフォルトの単位が使用されます。
CURRENCY この指標は通貨を測定します。
FEET この指標はフィートを測定します。
METERS この指標はメートルを測定します。
KILOMETERS この指標はキロメートルを測定します。
MILES この指標はマイルを測定します。
MILLISECONDS この指標はミリ秒単位で測定されます。
SECONDS この指標は秒数を測定します。
MINUTES この指標は分を測定します。
HOURS この指標は時間を測定します。

MetricScope

この指標のスコープ。

列挙型
METRIC_SCOPE_UNSPECIFIED スコープが不明であるか、指定されていません。
EVENT イベントをスコープとする指標。

RestrictedMetricType

このカスタム指標のデータを、特定のユーザーに限定するデータとしてマークするラベル。

列挙型
RESTRICTED_METRIC_TYPE_UNSPECIFIED タイプが不明または未指定です。
COST_DATA 指標レポートの費用データ。
REVENUE_DATA 指標レポートの収益データ

メソッド

archive

 プロパティにカスタム指標をアーカイブします。

create

 カスタム指標を作成します。

get

 単一のカスタム指標のルックアップ。

list

 プロパティの CustomMetrics を一覧表示します。

patch

 プロパティのカスタム指標を更新します。