Class MetricMetadata

Explains a metric.

Inheritance

object

MetricMetadata

Implements

IMessage<MetricMetadata>

IEquatable<MetricMetadata>

IDeepCloneable<MetricMetadata>

IBufferMessage

IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace: Google.Analytics.Data.V1Beta

Assembly: Google.Analytics.Data.V1Beta.dll

Syntax

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

Constructors

MetricMetadata()

Declaration

public MetricMetadata()

MetricMetadata(MetricMetadata)

Declaration

public MetricMetadata(MetricMetadata other)

Parameters

Type	Name	Description
MetricMetadata	other

Properties

ApiName

A metric name. Useable in Metric's name. For example, eventCount.

Declaration

public string ApiName { get; set; }

Property Value

Type	Description
string

BlockedReasons

If reasons are specified, your access is blocked to this metric for this property. API requests from you to this property for this metric will succeed; however, the report will contain only zeros for this metric. API requests with metric filters on blocked metrics will fail. If reasons are empty, you have access to this metric.

To learn more, see Access and data-restriction management.

Declaration

public RepeatedField<MetricMetadata.Types.BlockedReason> BlockedReasons { get; }

Property Value

Type	Description
RepeatedField<MetricMetadata.Types.BlockedReason>

Category

The display name of the category that this metrics belongs to. Similar dimensions and metrics are categorized together.

Declaration

public string Category { get; set; }

Property Value

Type	Description
string

CustomDefinition

True if the metric is a custom metric for this property.

Declaration

public bool CustomDefinition { get; set; }

Property Value

Type	Description
bool

DeprecatedApiNames

Still usable but deprecated names for this metric. If populated, this metric is available by either apiName or one of deprecatedApiNames for a period of time. After the deprecation period, the metric will be available only by apiName.

Declaration

public RepeatedField<string> DeprecatedApiNames { get; }

Property Value

Type	Description
RepeatedField<string>

Description

Description of how this metric is used and calculated.

Declaration

public string Description { get; set; }

Property Value

Type	Description
string

Expression

The mathematical expression for this derived metric. Can be used in Metric's expression field for equivalent reports. Most metrics are not expressions, and for non-expressions, this field is empty.

Declaration

public string Expression { get; set; }

Property Value

Type	Description
string

Type

The type of this metric.

Declaration

public MetricType Type { get; set; }

Property Value

Type	Description
MetricType

UiName

This metric's name within the Google Analytics user interface. For example, Event count.

Declaration

public string UiName { get; set; }

Property Value

Type	Description
string