class Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomDimension

A definition for a CustomDimension.

Attributes

description[RW]

Optional. Description for this custom dimension. Max length of 150 characters. Corresponds to the JSON property `description` @return [String]

disallow_ads_personalization[RW]

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. Corresponds to the JSON property `disallowAdsPersonalization` @return [Boolean]

disallow_ads_personalization?[RW]

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. Corresponds to the JSON property `disallowAdsPersonalization` @return [Boolean]

display_name[RW]

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. Corresponds to the JSON property `displayName` @return [String]

name[RW]

Output only. Resource name for this CustomDimension resource. Format: properties/`property`/customDimensions/`customDimension` Corresponds to the JSON property `name` @return [String]

parameter_name[RW]

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. Corresponds to the JSON property `parameterName` @return [String]

scope[RW]

Required. Immutable. The scope of this dimension. Corresponds to the JSON property `scope` @return [String]

Public Class Methods

new(**args) click to toggle source
# File lib/google/apis/analyticsadmin_v1alpha/classes.rb, line 806
def initialize(**args)
   update!(**args)
end

Public Instance Methods

update!(**args) click to toggle source

Update properties of this object

# File lib/google/apis/analyticsadmin_v1alpha/classes.rb, line 811
def update!(**args)
  @description = args[:description] if args.key?(:description)
  @disallow_ads_personalization = args[:disallow_ads_personalization] if args.key?(:disallow_ads_personalization)
  @display_name = args[:display_name] if args.key?(:display_name)
  @name = args[:name] if args.key?(:name)
  @parameter_name = args[:parameter_name] if args.key?(:parameter_name)
  @scope = args[:scope] if args.key?(:scope)
end