Class MetricMetadata

Explains a metric.

Inheritance
object
MetricMetadata
Implements
Inherited Members
Namespace: Google.Apis.AnalyticsData.v1beta.Data
Assembly: Google.Apis.AnalyticsData.v1beta.dll
Syntax
public class MetricMetadata : IDirectResponseSchema

Properties

ApiName

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

Declaration
[JsonProperty("apiName")]
public virtual 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
[JsonProperty("blockedReasons")]
public virtual IList<string> BlockedReasons { get; set; }
Property Value
Type Description
IList<string>

Category

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

Declaration
[JsonProperty("category")]
public virtual string Category { get; set; }
Property Value
Type Description
string

CustomDefinition

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

Declaration
[JsonProperty("customDefinition")]
public virtual 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
[JsonProperty("deprecatedApiNames")]
public virtual IList<string> DeprecatedApiNames { get; set; }
Property Value
Type Description
IList<string>

Description

Description of how this metric is used and calculated.

Declaration
[JsonProperty("description")]
public virtual string Description { get; set; }
Property Value
Type Description
string

ETag

The ETag of the item.

Declaration
public virtual string ETag { 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
[JsonProperty("expression")]
public virtual string Expression { get; set; }
Property Value
Type Description
string

Type

The type of this metric.

Declaration
[JsonProperty("type")]
public virtual string Type { get; set; }
Property Value
Type Description
string

UiName

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

Declaration
[JsonProperty("uiName")]
public virtual string UiName { get; set; }
Property Value
Type Description
string

Implements