REST Resource: properties.calculatedMetrics

リソース: CalculatedMetric

計算指標の定義。

JSON 表現 
{
  "name": string,
  "description": string,
  "displayName": string,
  "calculatedMetricId": string,
  "metricUnit": enum (MetricUnit),
  "restrictedMetricType": [
    enum (RestrictedMetricType)
  ],
  "formula": string,
  "invalidMetricReference": boolean
}
フィールド
name

string

出力専用。この CalculatedMetric のリソース名。Format: 'properties/{property_id}/calculatedMetrics/{calculatedMetricId}'
description

string

省略可。この計算指標の説明。最大長は 4,096 文字です。
displayName

string

必須。Google アナリティクスの管理画面に表示される、この計算指標の表示名。最大長は 82 文字です。
calculatedMetricId

string

出力専用。計算指標に使用する ID。UI では、これは「API 名」と呼ばれます。

calculatedMetricId は、外部 API からこの計算指標を参照するときに使用されます。例: calcMetric:{calculatedMetricId}
metricUnit

enum (MetricUnit)

必須。計算された指標の値の型。
restrictedMetricType[]

enum (RestrictedMetricType)

出力専用。この指標に含まれる制限付きデータの種類。
formula

string

必須。計算指標の定義。参照される一意のカスタム指標の最大数は 5 です。数式では、+（加算）、-（減算）、-（負）、*（乗算）、/（除算）、（）（かっこ）の演算がサポートされています。Long（64 ビット整数）または Double（64 ビット浮動小数点数）に収まる有効な実数であれば、どのような数値でも使用できます。数式の例: "( customEvent:parameterName + cartPurchaseQuantity ) / 2.0"
invalidMetricReference

boolean

出力専用。true の場合、この計算指標には無効な指標参照があります。invalidMetricReference が true に設定された計算指標を使用すると、失敗、警告、予期しない結果が発生する可能性があります。

MetricUnit

計算された指標の値を表すことができるタイプ。

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

RestrictedMetricType

費用や収益の指標へのアクセスを制限するユーザーロールと組み合わせて使用される、計算指標内のデータにマークを付けるラベル。

列挙型
RESTRICTED_METRIC_TYPE_UNSPECIFIED タイプが不明または未指定。
COST_DATA 指標は費用データを報告します。
REVENUE_DATA 指標は収益データを報告します。

メソッド

create

 CalculatedMetric を作成します。

delete

 プロパティの CalculatedMetric を削除します。

get

 単一の計算指標を検索します。

list

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

patch

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