Reference documentation and code samples for the Google Analytics Admin V1beta Client class CustomMetric.
A definition for a custom metric.
Generated from protobuf message google.analytics.admin.v1beta.CustomMetric
Namespace
Google \ Analytics \ Admin \ V1betaMethods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
Output only. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric}
↳ parameter_name
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.
↳ display_name
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.
↳ description
string
Optional. Description for this custom dimension. Max length of 150 characters.
↳ measurement_unit
int
Required. The type for the custom metric's value.
↳ scope
int
Required. Immutable. The scope of this custom metric.
↳ restricted_metric_type
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.
getName
Output only. Resource name for this CustomMetric resource.
Format: properties/{property}/customMetrics/{customMetric}
string
setName
Output only. Resource name for this CustomMetric resource.
Format: properties/{property}/customMetrics/{customMetric}
var
string
$this
getParameterName
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.
string
setParameterName
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.
var
string
$this
getDisplayName
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.
string
setDisplayName
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.
var
string
$this
getDescription
Optional. Description for this custom dimension.
Max length of 150 characters.
string
setDescription
Optional. Description for this custom dimension.
Max length of 150 characters.
var
string
$this
getMeasurementUnit
Required. The type for the custom metric's value.
int
setMeasurementUnit
Required. The type for the custom metric's value.
var
int
$this
getScope
Required. Immutable. The scope of this custom metric.
int
setScope
Required. Immutable. The scope of this custom metric.
var
int
$this
getRestrictedMetricType
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.
setRestrictedMetricType
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.
var
int[]
$this
