Google Analytics Admin V1alpha API - Class Google::Analytics::Admin::V1alpha::CustomDimension (v0.11.0)

Reference documentation and code samples for the Google Analytics Admin V1alpha API class Google::Analytics::Admin::V1alpha::CustomDimension.

A definition for a CustomDimension.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#description

def description() -> ::String
Returns
  • (::String) — Optional. Description for this custom dimension. Max length of 150 characters.

#description=

def description=(value) -> ::String
Parameter
  • value (::String) — Optional. Description for this custom dimension. Max length of 150 characters.
Returns
  • (::String) — Optional. Description for this custom dimension. Max length of 150 characters.

#disallow_ads_personalization

def disallow_ads_personalization() -> ::Boolean
Returns
  • (::Boolean) — 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.

#disallow_ads_personalization=

def disallow_ads_personalization=(value) -> ::Boolean
Parameter
  • value (::Boolean) — 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.

Returns
  • (::Boolean) — 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.

#display_name

def display_name() -> ::String
Returns
  • (::String) — 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.

#display_name=

def display_name=(value) -> ::String
Parameter
  • value (::String) — 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.
Returns
  • (::String) — 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.

#name

def name() -> ::String
Returns
  • (::String) — Output only. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension}

#parameter_name

def parameter_name() -> ::String
Returns
  • (::String) — 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.

    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.

#parameter_name=

def parameter_name=(value) -> ::String
Parameter
  • value (::String) — 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.

    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.

Returns
  • (::String) — 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.

    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.

#scope

def scope() -> ::Google::Analytics::Admin::V1alpha::CustomDimension::DimensionScope
Returns

#scope=

def scope=(value) -> ::Google::Analytics::Admin::V1alpha::CustomDimension::DimensionScope
Parameter
Returns