Class CustomDimension

A definition for a CustomDimension.

Inheritance

object

CustomDimension

Implements

IMessage<CustomDimension>

IEquatable<CustomDimension>

IDeepCloneable<CustomDimension>

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 CustomDimension : IMessage<CustomDimension>, IEquatable<CustomDimension>, IDeepCloneable<CustomDimension>, IBufferMessage, IMessage

Constructors

CustomDimension()

Declaration

public CustomDimension()

CustomDimension(CustomDimension)

Declaration

public CustomDimension(CustomDimension other)

Parameters

Type	Name	Description
CustomDimension	other

Properties

CustomDimensionName

CustomDimensionName-typed view over the Name resource name property.

Declaration

public CustomDimensionName CustomDimensionName { get; set; }

Property Value

Type	Description
CustomDimensionName

Description

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

Declaration

public string Description { get; set; }

Property Value

Type	Description
string

DisallowAdsPersonalization

Optional. If set to true, sets this dimension as NPA and excludes it from ads personalization.

This is currently only supported by user-scoped custom dimensions.

Declaration

public bool DisallowAdsPersonalization { get; set; }

Property Value

Type	Description
bool

DisplayName

Required. Display name for this custom dimension 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

Name

Output only. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension}

Declaration

public string Name { get; set; }

Property Value

Type	Description
string

ParameterName

Required. Immutable. Tagging parameter name for this custom dimension.

If this is a user-scoped dimension, then this is the user property name. If this is an event-scoped dimension, then this is the event parameter name.

If this is an item-scoped dimension, then this is the parameter name found in the eCommerce items array.

May only contain alphanumeric and underscore characters, starting with a letter. Max length of 24 characters for user-scoped dimensions, 40 characters for event-scoped dimensions.

Declaration

public string ParameterName { get; set; }

Property Value

Type	Description
string

Scope

Required. Immutable. The scope of this dimension.

Declaration

public CustomDimension.Types.DimensionScope Scope { get; set; }

Property Value

Type	Description
CustomDimension.Types.DimensionScope