Class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomDimension
- Inherits:
-
Object
- Object
- Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomDimension
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- lib/google/apis/analyticsadmin_v1alpha/classes.rb,
lib/google/apis/analyticsadmin_v1alpha/representations.rb,
lib/google/apis/analyticsadmin_v1alpha/representations.rb
Overview
A definition for a CustomDimension.
Instance Attribute Summary collapse
-
#description ⇒ String
Optional.
-
#disallow_ads_personalization ⇒ Boolean
(also: #disallow_ads_personalization?)
Optional.
-
#display_name ⇒ String
Required.
-
#name ⇒ String
Output only.
-
#parameter_name ⇒ String
Required.
-
#scope ⇒ String
Required.
Instance Method Summary collapse
-
#initialize(**args) ⇒ GoogleAnalyticsAdminV1alphaCustomDimension
constructor
A new instance of GoogleAnalyticsAdminV1alphaCustomDimension.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ GoogleAnalyticsAdminV1alphaCustomDimension
Returns a new instance of GoogleAnalyticsAdminV1alphaCustomDimension.
829 830 831 |
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 829 def initialize(**args) update!(**args) end |
Instance Attribute Details
#description ⇒ String
Optional. Description for this custom dimension. Max length of 150 characters.
Corresponds to the JSON property description
790 791 792 |
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 790 def description @description end |
#disallow_ads_personalization ⇒ Boolean Also known as: disallow_ads_personalization?
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
797 798 799 |
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 797 def disallow_ads_personalization @disallow_ads_personalization end |
#display_name ⇒ 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.
Corresponds to the JSON property displayName
806 807 808 |
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 806 def display_name @display_name end |
#name ⇒ String
Output only. Resource name for this CustomDimension resource. Format:
properties/property
/customDimensions/customDimension
Corresponds to the JSON property name
812 813 814 |
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 812 def name @name end |
#parameter_name ⇒ 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.
Corresponds to the JSON property parameterName
822 823 824 |
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 822 def parameter_name @parameter_name end |
#scope ⇒ String
Required. Immutable. The scope of this dimension.
Corresponds to the JSON property scope
827 828 829 |
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 827 def scope @scope end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
834 835 836 837 838 839 840 841 |
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 834 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 |