Google Analytics Admin V1alpha API - Class Google::Analytics::Admin::V1alpha::CustomMetric (v0.11.0)

Reference documentation and code samples for the Google Analytics Admin V1alpha API class Google::Analytics::Admin::V1alpha::CustomMetric.

A definition for a custom metric.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#description

def description() -> ::String
Returns
  • (::String) — Optional. Description for this custom dimension. Max length of 150 characters.

#description=

def description=(value) -> ::String
Parameter
  • value (::String) — Optional. Description for this custom dimension. Max length of 150 characters.
Returns
  • (::String) — Optional. Description for this custom dimension. Max length of 150 characters.

#display_name

def display_name() -> ::String
Returns
  • (::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.

#display_name=

def display_name=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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.

#measurement_unit

def measurement_unit() -> ::Google::Analytics::Admin::V1alpha::CustomMetric::MeasurementUnit
Returns

#measurement_unit=

def measurement_unit=(value) -> ::Google::Analytics::Admin::V1alpha::CustomMetric::MeasurementUnit
Parameter
Returns

#name

def name() -> ::String
Returns
  • (::String) — Output only. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric}

#parameter_name

def parameter_name() -> ::String
Returns
  • (::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.

#parameter_name=

def parameter_name=(value) -> ::String
Parameter
  • value (::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.

Returns
  • (::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.

#restricted_metric_type

def restricted_metric_type() -> ::Array<::Google::Analytics::Admin::V1alpha::CustomMetric::RestrictedMetricType>
Returns

#restricted_metric_type=

def restricted_metric_type=(value) -> ::Array<::Google::Analytics::Admin::V1alpha::CustomMetric::RestrictedMetricType>
Parameter
Returns

#scope

def scope() -> ::Google::Analytics::Admin::V1alpha::CustomMetric::MetricScope
Returns

#scope=

def scope=(value) -> ::Google::Analytics::Admin::V1alpha::CustomMetric::MetricScope
Parameter
Returns