Class: Google::Analytics::Admin::V1alpha::CustomDimension

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/analytics/admin/v1alpha/resources.rb

Overview

A definition for a CustomDimension.

Defined Under Namespace

Modules: DimensionScope

Instance Attribute Summary collapse

Instance Attribute Details

#description ⇒ ::String

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

Returns:

  • (::String) —

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



1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
 
# File 'proto_docs/google/analytics/admin/v1alpha/resources.rb', line 1093

class CustomDimension
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Valid values for the scope of this dimension.
  module DimensionScope
    # Scope unknown or not specified.
    DIMENSION_SCOPE_UNSPECIFIED = 0

    # Dimension scoped to an event.
    EVENT = 1

    # Dimension scoped to a user.
    USER = 2

    # Dimension scoped to eCommerce items
    ITEM = 3
  end
end

#disallow_ads_personalization ⇒ ::Boolean

Returns 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.



1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
 
# File 'proto_docs/google/analytics/admin/v1alpha/resources.rb', line 1093

class CustomDimension
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Valid values for the scope of this dimension.
  module DimensionScope
    # Scope unknown or not specified.
    DIMENSION_SCOPE_UNSPECIFIED = 0

    # Dimension scoped to an event.
    EVENT = 1

    # Dimension scoped to a user.
    USER = 2

    # Dimension scoped to eCommerce items
    ITEM = 3
  end
end

#display_name ⇒ ::String

Returns 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.



1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
 
# File 'proto_docs/google/analytics/admin/v1alpha/resources.rb', line 1093

class CustomDimension
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Valid values for the scope of this dimension.
  module DimensionScope
    # Scope unknown or not specified.
    DIMENSION_SCOPE_UNSPECIFIED = 0

    # Dimension scoped to an event.
    EVENT = 1

    # Dimension scoped to a user.
    USER = 2

    # Dimension scoped to eCommerce items
    ITEM = 3
  end
end

#name ⇒ ::String (readonly)

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

Returns:

  • (::String) —

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



1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
 
# File 'proto_docs/google/analytics/admin/v1alpha/resources.rb', line 1093

class CustomDimension
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Valid values for the scope of this dimension.
  module DimensionScope
    # Scope unknown or not specified.
    DIMENSION_SCOPE_UNSPECIFIED = 0

    # Dimension scoped to an event.
    EVENT = 1

    # Dimension scoped to a user.
    USER = 2

    # Dimension scoped to eCommerce items
    ITEM = 3
  end
end

#parameter_name ⇒ ::String

Returns 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.

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.

    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.



1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
 
# File 'proto_docs/google/analytics/admin/v1alpha/resources.rb', line 1093

class CustomDimension
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Valid values for the scope of this dimension.
  module DimensionScope
    # Scope unknown or not specified.
    DIMENSION_SCOPE_UNSPECIFIED = 0

    # Dimension scoped to an event.
    EVENT = 1

    # Dimension scoped to a user.
    USER = 2

    # Dimension scoped to eCommerce items
    ITEM = 3
  end
end

#scope ⇒ ::Google::Analytics::Admin::V1alpha::CustomDimension::DimensionScope

Returns Required. Immutable. The scope of this dimension.

Returns:



1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
 
# File 'proto_docs/google/analytics/admin/v1alpha/resources.rb', line 1093

class CustomDimension
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Valid values for the scope of this dimension.
  module DimensionScope
    # Scope unknown or not specified.
    DIMENSION_SCOPE_UNSPECIFIED = 0

    # Dimension scoped to an event.
    EVENT = 1

    # Dimension scoped to a user.
    USER = 2

    # Dimension scoped to eCommerce items
    ITEM = 3
  end
end