Class: Google::Apis::AnalyticsdataV1alpha::DimensionMetadata

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/analyticsdata_v1alpha/classes.rb,
generated/google/apis/analyticsdata_v1alpha/representations.rb,
generated/google/apis/analyticsdata_v1alpha/representations.rb

Overview

Explains a dimension.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ DimensionMetadata

Returns a new instance of DimensionMetadata.



508
509
510
 
# File 'generated/google/apis/analyticsdata_v1alpha/classes.rb', line 508

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#api_name ⇒ String

This dimension's name. Useable in Dimension's name. For example, eventName. Corresponds to the JSON property apiName

Returns:

  • (String) 


481
482
483
 
# File 'generated/google/apis/analyticsdata_v1alpha/classes.rb', line 481

def api_name
  @api_name
end

#custom_definition ⇒ Boolean Also known as: custom_definition?

True if the dimension is a custom dimension for this property. Corresponds to the JSON property customDefinition

Returns:

  • (Boolean) 


486
487
488
 
# File 'generated/google/apis/analyticsdata_v1alpha/classes.rb', line 486

def custom_definition
  @custom_definition
end

#deprecated_api_names ⇒ Array<String>

Still usable but deprecated names for this dimension. If populated, this dimension is available by either apiName or one of deprecatedApiNames for a period of time. After the deprecation period, the dimension will be available only by apiName. Corresponds to the JSON property deprecatedApiNames

Returns:

  • (Array<String>) 


495
496
497
 
# File 'generated/google/apis/analyticsdata_v1alpha/classes.rb', line 495

def deprecated_api_names
  @deprecated_api_names
end

#description ⇒ String

Description of how this dimension is used and calculated. Corresponds to the JSON property description

Returns:

  • (String) 


500
501
502
 
# File 'generated/google/apis/analyticsdata_v1alpha/classes.rb', line 500

def description
  @description
end

#ui_name ⇒ String

This dimension's name within the Google Analytics user interface. For example, Event name. Corresponds to the JSON property uiName

Returns:

  • (String) 


506
507
508
 
# File 'generated/google/apis/analyticsdata_v1alpha/classes.rb', line 506

def ui_name
  @ui_name
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



513
514
515
516
517
518
519
 
# File 'generated/google/apis/analyticsdata_v1alpha/classes.rb', line 513

def update!(**args)
  @api_name = args[:api_name] if args.key?(:api_name)
  @custom_definition = args[:custom_definition] if args.key?(:custom_definition)
  @deprecated_api_names = args[:deprecated_api_names] if args.key?(:deprecated_api_names)
  @description = args[:description] if args.key?(:description)
  @ui_name = args[:ui_name] if args.key?(:ui_name)
end