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

ID。この CalculatedMetric のリソース名。形式: 'properties/{property_id}/calculatedMetrics/{calculatedMetricId}'
description

string

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

string

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

 単一の CalculatedMetric を検索します。

list

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

patch

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