Show / Hide Table of Contents

Class DimensionMetadata

Explains a dimension.

Inheritance
object
DimensionMetadata
Implements
IMessage<DimensionMetadata>
IEquatable<DimensionMetadata>
IDeepCloneable<DimensionMetadata>
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 DimensionMetadata : IMessage<DimensionMetadata>, IEquatable<DimensionMetadata>, IDeepCloneable<DimensionMetadata>, IBufferMessage, IMessage

Constructors

DimensionMetadata()

Declaration
public DimensionMetadata()

DimensionMetadata(DimensionMetadata)

Declaration
public DimensionMetadata(DimensionMetadata other)
Parameters
Type Name Description
DimensionMetadata other

Properties

ApiName

This dimension's name. Useable in Dimension's name. For example, eventName.

Declaration
public string ApiName { get; set; }
Property Value
Type Description
string

Category

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

Declaration
public string Category { get; set; }
Property Value
Type Description
string

CustomDefinition

True if the dimension is custom to this property. This includes user, event, & item scoped custom dimensions; to learn more about custom dimensions, see https://support.google.com/analytics/answer/14240153. This also include custom channel groups; to learn more about custom channel groups, see https://support.google.com/analytics/answer/13051316.

Declaration
public bool CustomDefinition { get; set; }
Property Value
Type Description
bool

DeprecatedApiNames

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

Declaration
public RepeatedField<string> DeprecatedApiNames { get; }
Property Value
Type Description
RepeatedField<string>

Description

Description of how this dimension is used and calculated.

Declaration
public string Description { get; set; }
Property Value
Type Description
string

UiName

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

Declaration
public string UiName { get; set; }
Property Value
Type Description
string
In this article
Back to top Generated by DocFX