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

必須。アナリティクスの UI に表示されるこのカスタム指標の表示名。最大長は 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

 CustomMetric を作成します。

get

 1 つのカスタム指標を検索します。

list

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

patch

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