v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-13286594.5 KB
properties

Creates a CustomMetric.

post/v1beta/{+parent}/customMetrics

Path parameters

parentstring required

Required. Example format: properties/1234

Request body

descriptionstring

Optional. Description for this custom dimension. Max length of 150 characters.

scope'METRIC_SCOPE_UNSPECIFIED' | 'EVENT'

Required. Immutable. The scope of this custom metric.

parameterNamestring

Required. Immutable. Tagging name for this custom metric. If this is an event-scoped metric, then this is the event parameter name. May only contain alphanumeric and underscore charactes, starting with a letter. Max length of 40 characters for event-scoped metrics.

displayNamestring

Required. Display name for this custom metric as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets.

restrictedMetricTypestring[]

Optional. Types of restricted data that this metric may contain. Required for metrics with CURRENCY measurement unit. Must be empty for metrics with a non-CURRENCY measurement unit.

namestring

Identifier. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric}

measurementUnit'MEASUREMENT_UNIT_UNSPECIFIED' | 'STANDARD' | 'CURRENCY' | 'FEET' | 'METERS' | 'KILOMETERS' | 'MILES' | 'MILLISECONDS' | 'SECONDS' | 'MINUTES' | 'HOURS'

Required. The type for the custom metric's value.

Response

Successful response