Class CustomMetric

A definition for a custom metric.

Inheritance

object

CustomMetric

Implements

IMessage<CustomMetric>

IEquatable<CustomMetric>

IDeepCloneable<CustomMetric>

IBufferMessage

IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace: Google.Analytics.Admin.V1Alpha

Assembly: Google.Analytics.Admin.V1Alpha.dll

Syntax

public sealed class CustomMetric : IMessage<CustomMetric>, IEquatable<CustomMetric>, IDeepCloneable<CustomMetric>, IBufferMessage, IMessage

Constructors

CustomMetric()

Declaration

public CustomMetric()

CustomMetric(CustomMetric)

Declaration

public CustomMetric(CustomMetric other)

Parameters

Type	Name	Description
CustomMetric	other

Properties

CustomMetricName

CustomMetricName-typed view over the Name resource name property.

Declaration

public CustomMetricName CustomMetricName { get; set; }

Property Value

Type	Description
CustomMetricName

Description

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

Declaration

public string Description { get; set; }

Property Value

Type	Description
string

DisplayName

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.

Declaration

public string DisplayName { get; set; }

Property Value

Type	Description
string

MeasurementUnit

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

Declaration

public CustomMetric.Types.MeasurementUnit MeasurementUnit { get; set; }

Property Value

Type	Description
CustomMetric.Types.MeasurementUnit

Name

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

Declaration

public string Name { get; set; }

Property Value

Type	Description
string

ParameterName

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.

Declaration

public string ParameterName { get; set; }

Property Value

Type	Description
string

RestrictedMetricType

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.

Declaration

public RepeatedField<CustomMetric.Types.RestrictedMetricType> RestrictedMetricType { get; }

Property Value

Type	Description
RepeatedField<CustomMetric.Types.RestrictedMetricType>

Scope

Required. Immutable. The scope of this custom metric.

Declaration

public CustomMetric.Types.MetricScope Scope { get; set; }

Property Value

Type	Description
CustomMetric.Types.MetricScope