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

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

string

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

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

使用できるのは英数字とアンダースコアのみで、先頭は英字にする必要があります。イベント スコープの指標の場合、最大文字数は 40 文字です。
displayName

string

必須。Analytics UI に表示されるこのカスタム指標の表示名。最大文字数は 82 文字で、英数字、スペース、アンダースコアを使用できます。先頭は英字にする必要があります。従来のシステム生成の表示名には角かっこが含まれる場合がありますが、このフィールドを更新しても角かっこは使用できません。
description

string

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

enum (MeasurementUnit)

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

enum (MetricScope)

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

enum (RestrictedMetricType)

省略可。この指標に含めることができる制限付きデータのタイプ。測定単位が CURRENCY の指標に必要です。測定単位が 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

 プロパティの CustomMetric をアーカイブします。

create

 CustomMetric を作成します。

get

 単一の CustomMetric を検索します。

list

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

patch

 プロパティの CustomMetric を更新します。