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
defdisplay_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=
defdisplay_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
defname()->::String
Returns
(::String) — Output only. Resource name for this CustomDimension resource.
Format: properties/{property}/customDimensions/{customDimension}
#parameter_name
defparameter_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=
defparameter_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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-09 UTC."],[],[],null,["# Google Analytics Admin V1alpha API - Class Google::Analytics::Admin::V1alpha::CustomDimension (v0.11.0)\n\nVersion latestkeyboard_arrow_down\n\n- [0.11.0 (latest)](/ruby/docs/reference/google-analytics-admin-v1alpha/latest/Google-Analytics-Admin-V1alpha-CustomDimension)\n- [0.10.0](/ruby/docs/reference/google-analytics-admin-v1alpha/0.10.0/Google-Analytics-Admin-V1alpha-CustomDimension)\n- [0.9.1](/ruby/docs/reference/google-analytics-admin-v1alpha/0.9.1/Google-Analytics-Admin-V1alpha-CustomDimension) \nReference documentation and code samples for the Google Analytics Admin V1alpha API class Google::Analytics::Admin::V1alpha::CustomDimension.\n\nA definition for a CustomDimension. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #description\n\n def description() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Optional. Description for this custom dimension. Max length of 150 characters.\n\n### #description=\n\n def description=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Optional. Description for this custom dimension. Max length of 150 characters. \n**Returns**\n\n- (::String) --- Optional. Description for this custom dimension. Max length of 150 characters.\n\n### #disallow_ads_personalization\n\n def disallow_ads_personalization() -\u003e ::Boolean\n\n**Returns**\n\n- (::Boolean) --- Optional. If set to true, sets this dimension as NPA and excludes it from ads personalization.\n\n This is currently only supported by user-scoped custom dimensions.\n\n### #disallow_ads_personalization=\n\n def disallow_ads_personalization=(value) -\u003e ::Boolean\n\n**Parameter**\n\n- **value** (::Boolean) --- Optional. If set to true, sets this dimension as NPA and excludes it from ads personalization.\n\n\nThis is currently only supported by user-scoped custom dimensions. \n**Returns**\n\n- (::Boolean) --- Optional. If set to true, sets this dimension as NPA and excludes it from ads personalization.\n\n This is currently only supported by user-scoped custom dimensions.\n\n### #display_name\n\n def display_name() -\u003e ::String\n\n**Returns**\n\n- (::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.\n\n### #display_name=\n\n def display_name=(value) -\u003e ::String\n\n**Parameter**\n\n- **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. \n**Returns**\n\n- (::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.\n\n### #name\n\n def name() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Output only. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension}\n\n### #parameter_name\n\n def parameter_name() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Required. Immutable. Tagging parameter name for this custom dimension.\n\n If this is a user-scoped dimension, then this is the user property name.\n If this is an event-scoped dimension, then this is the event parameter\n name.\n\n May only contain alphanumeric and underscore characters, starting with a\n letter. Max length of 24 characters for user-scoped dimensions, 40\n characters for event-scoped dimensions.\n\n### #parameter_name=\n\n def parameter_name=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Required. Immutable. Tagging parameter name for this custom dimension.\n\n\n If this is a user-scoped dimension, then this is the user property name.\n If this is an event-scoped dimension, then this is the event parameter\n name.\n\n May only contain alphanumeric and underscore characters, starting with a\n letter. Max length of 24 characters for user-scoped dimensions, 40\ncharacters for event-scoped dimensions. \n**Returns**\n\n- (::String) --- Required. Immutable. Tagging parameter name for this custom dimension.\n\n If this is a user-scoped dimension, then this is the user property name.\n If this is an event-scoped dimension, then this is the event parameter\n name.\n\n May only contain alphanumeric and underscore characters, starting with a\n letter. Max length of 24 characters for user-scoped dimensions, 40\n characters for event-scoped dimensions.\n\n### #scope\n\n def scope() -\u003e ::Google::Analytics::Admin::V1alpha::CustomDimension::DimensionScope\n\n**Returns**\n\n- ([::Google::Analytics::Admin::V1alpha::CustomDimension::DimensionScope](./Google-Analytics-Admin-V1alpha-CustomDimension-DimensionScope)) --- Required. Immutable. The scope of this dimension.\n\n### #scope=\n\n def scope=(value) -\u003e ::Google::Analytics::Admin::V1alpha::CustomDimension::DimensionScope\n\n**Parameter**\n\n- **value** ([::Google::Analytics::Admin::V1alpha::CustomDimension::DimensionScope](./Google-Analytics-Admin-V1alpha-CustomDimension-DimensionScope)) --- Required. Immutable. The scope of this dimension. \n**Returns**\n\n- ([::Google::Analytics::Admin::V1alpha::CustomDimension::DimensionScope](./Google-Analytics-Admin-V1alpha-CustomDimension-DimensionScope)) --- Required. Immutable. The scope of this dimension."]]
