Google Analytics Admin V1beta Client - Class CustomMetric (0.8.2)

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

Methods

__construct

Constructor.

Parameters
NameDescription
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}

Returns
TypeDescription
string

setName

Output only. Resource name for this CustomMetric resource.

Format: properties/{property}/customMetrics/{customMetric}

Parameter
NameDescription
var string
Returns
TypeDescription
$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.

Returns
TypeDescription
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.

Parameter
NameDescription
var string
Returns
TypeDescription
$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.

Returns
TypeDescription
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.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDescription

Optional. Description for this custom dimension.

Max length of 150 characters.

Returns
TypeDescription
string

setDescription

Optional. Description for this custom dimension.

Max length of 150 characters.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getMeasurementUnit

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

Returns
TypeDescription
int

setMeasurementUnit

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

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getScope

Required. Immutable. The scope of this custom metric.

Returns
TypeDescription
int

setScope

Required. Immutable. The scope of this custom metric.

Parameter
NameDescription
var int
Returns
TypeDescription
$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.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

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.

Parameter
NameDescription
var int[]
Returns
TypeDescription
$this