Class: Google::Analytics::Admin::V1alpha::CustomDimension
- Inherits:
-
Object
- Object
- Google::Analytics::Admin::V1alpha::CustomDimension
- 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
-
#description ⇒ ::String
Optional.
-
#disallow_ads_personalization ⇒ ::Boolean
Optional.
-
#display_name ⇒ ::String
Required.
-
#name ⇒ ::String
readonly
Output only.
-
#parameter_name ⇒ ::String
Required.
-
#scope ⇒ ::Google::Analytics::Admin::V1alpha::CustomDimension::DimensionScope
Required.
Instance Attribute Details
#description ⇒ ::String
Returns Optional. Description for this custom dimension. Max length of 150 characters.
924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 |
# File 'proto_docs/google/analytics/admin/v1alpha/resources.rb', line 924 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.
924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 |
# File 'proto_docs/google/analytics/admin/v1alpha/resources.rb', line 924 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.
924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 |
# File 'proto_docs/google/analytics/admin/v1alpha/resources.rb', line 924 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}.
924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 |
# File 'proto_docs/google/analytics/admin/v1alpha/resources.rb', line 924 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.
924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 |
# File 'proto_docs/google/analytics/admin/v1alpha/resources.rb', line 924 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.
924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 |
# File 'proto_docs/google/analytics/admin/v1alpha/resources.rb', line 924 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 |