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 の指標の場合は必須です。測定単位が 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 収益データをレポートする指標。

Methods

archive

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

create

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

get

 1 つの CustomMetric のルックアップ。

list

 プロパティのカスタム指標を一覧表示します。

patch

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