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

속성의 CustomMetric을 보관처리합니다.

create

CustomMetric을 만듭니다.

get

단일 CustomMetric을 조회합니다.

list

속성의 CustomMetrics를 나열합니다.

patch

속성의 CustomMetric을 업데이트합니다.