Class: Google::Apis::AnalyticsdataV1beta::MetricMetadata

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 metric.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ MetricMetadata

Returns a new instance of MetricMetadata.



991
992
993
 
# File 'lib/google/apis/analyticsdata_v1beta/classes.rb', line 991

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

Instance Attribute Details

#api_name ⇒ String

A metric name. Useable in Metric's name. For example, eventCount . Corresponds to the JSON property apiName

Returns:

  • (String) 


946
947
948
 
# File 'lib/google/apis/analyticsdata_v1beta/classes.rb', line 946

def api_name
  @api_name
end

#category ⇒ String

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

Returns:

  • (String) 


952
953
954
 
# File 'lib/google/apis/analyticsdata_v1beta/classes.rb', line 952

def category
  @category
end

#custom_definition ⇒ Boolean Also known as: custom_definition?

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

Returns:

  • (Boolean) 


957
958
959
 
# File 'lib/google/apis/analyticsdata_v1beta/classes.rb', line 957

def custom_definition
  @custom_definition
end

#deprecated_api_names ⇒ Array<String>

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

Returns:

  • (Array<String>) 


966
967
968
 
# File 'lib/google/apis/analyticsdata_v1beta/classes.rb', line 966

def deprecated_api_names
  @deprecated_api_names
end

#description ⇒ String

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

Returns:

  • (String) 


971
972
973
 
# File 'lib/google/apis/analyticsdata_v1beta/classes.rb', line 971

def description
  @description
end

#expression ⇒ String

The mathematical expression for this derived metric. Can be used in Metric's expression field for equivalent reports. Most metrics are not expressions, and for non-expressions, this field is empty. Corresponds to the JSON property expression

Returns:

  • (String) 


978
979
980
 
# File 'lib/google/apis/analyticsdata_v1beta/classes.rb', line 978

def expression
  @expression
end

#type ⇒ String

The type of this metric. Corresponds to the JSON property type

Returns:

  • (String) 


983
984
985
 
# File 'lib/google/apis/analyticsdata_v1beta/classes.rb', line 983

def type
  @type
end

#ui_name ⇒ String

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

Returns:

  • (String) 


989
990
991
 
# File 'lib/google/apis/analyticsdata_v1beta/classes.rb', line 989

def ui_name
  @ui_name
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



996
997
998
999
1000
1001
1002
1003
1004
1005
 
# File 'lib/google/apis/analyticsdata_v1beta/classes.rb', line 996

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)
  @expression = args[:expression] if args.key?(:expression)
  @type = args[:type] if args.key?(:type)
  @ui_name = args[:ui_name] if args.key?(:ui_name)
end