Class: Google::Apis::AnalyticsdataV1beta::DimensionMetadata

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/analyticsdata_v1beta/classes.rb,
lib/google/apis/analyticsdata_v1beta/representations.rb,
lib/google/apis/analyticsdata_v1beta/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.



826
827
828
 
# File 'lib/google/apis/analyticsdata_v1beta/classes.rb', line 826

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) 


789
790
791
 
# File 'lib/google/apis/analyticsdata_v1beta/classes.rb', line 789

def api_name
  @api_name
end

#category ⇒ String

The display name of the category that this dimension belongs to. Similar dimensions and metrics are categorized together. Corresponds to the JSON property category

Returns:

  • (String) 


795
796
797
 
# File 'lib/google/apis/analyticsdata_v1beta/classes.rb', line 795

def category
  @category
end

#custom_definition ⇒ Boolean Also known as: custom_definition?

True if the dimension is custom to this property. This includes user, event, & item scoped custom dimensions; to learn more about custom dimensions, see https://support.google.com/analytics/answer/14240153. This also include custom channel groups; to learn more about custom channel groups, see https://support. google.com/analytics/answer/13051316. Corresponds to the JSON property customDefinition

Returns:

  • (Boolean) 


804
805
806
 
# File 'lib/google/apis/analyticsdata_v1beta/classes.rb', line 804

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>) 


813
814
815
 
# File 'lib/google/apis/analyticsdata_v1beta/classes.rb', line 813

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) 


818
819
820
 
# File 'lib/google/apis/analyticsdata_v1beta/classes.rb', line 818

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) 


824
825
826
 
# File 'lib/google/apis/analyticsdata_v1beta/classes.rb', line 824

def ui_name
  @ui_name
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



831
832
833
834
835
836
837
838
 
# File 'lib/google/apis/analyticsdata_v1beta/classes.rb', line 831

def update!(**args)
  @api_name = args[:api_name] if args.key?(:api_name)
  @category = args[:category] if args.key?(:category)
  @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