custom_metrics

Overview

Name	`custom_metrics`
Type	Resource
Id	`googleanalytics.analyticsadmin.custom_metrics`

Name	Datatype	Description
`name`	`string`	Output only. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric}
`description`	`string`	Optional. Description for this custom dimension. Max length of 150 characters.
`parameterName`	`string`	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.
`restrictedMetricType`	`array`	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.
`scope`	`string`	Required. Immutable. The scope of this custom metric.
`displayName`	`string`	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.
`measurementUnit`	`string`	Required. The type for the custom metric's value.

Name	Accessible by	Required Params	Description
`properties_customMetrics_get`	`SELECT`	`customMetricsId, propertiesId`	Lookup for a single CustomMetric.
`properties_customMetrics_list`	`SELECT`	`propertiesId`	Lists CustomMetrics on a property.
`properties_customMetrics_create`	`INSERT`	`propertiesId`	Creates a CustomMetric.
`properties_customMetrics_archive`	`EXEC`	`customMetricsId, propertiesId`	Archives a CustomMetric on a property.
`properties_customMetrics_patch`	`EXEC`	`customMetricsId, propertiesId`	Updates a CustomMetric on a property.