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.



1054
1055
1056
 
# File 'lib/google/apis/analyticsdata_v1beta/classes.rb', line 1054

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) 


999
1000
1001
 
# File 'lib/google/apis/analyticsdata_v1beta/classes.rb', line 999

def api_name
  @api_name
end

#blocked_reasons ⇒ Array<String>

If reasons are specified, your access is blocked to this metric for this property. API requests from you to this property for this metric will succeed; however, the report will contain only zeros for this metric. API requests with metric filters on blocked metrics will fail. If reasons are empty, you have access to this metric. To learn more, see Access and data-restriction management. Corresponds to the JSON property blockedReasons

Returns:

  • (Array<String>) 


1009
1010
1011
 
# File 'lib/google/apis/analyticsdata_v1beta/classes.rb', line 1009

def blocked_reasons
  @blocked_reasons
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) 


1015
1016
1017
 
# File 'lib/google/apis/analyticsdata_v1beta/classes.rb', line 1015

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) 


1020
1021
1022
 
# File 'lib/google/apis/analyticsdata_v1beta/classes.rb', line 1020

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


1029
1030
1031
 
# File 'lib/google/apis/analyticsdata_v1beta/classes.rb', line 1029

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) 


1034
1035
1036
 
# File 'lib/google/apis/analyticsdata_v1beta/classes.rb', line 1034

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) 


1041
1042
1043
 
# File 'lib/google/apis/analyticsdata_v1beta/classes.rb', line 1041

def expression
  @expression
end

#type ⇒ String

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

Returns:

  • (String) 


1046
1047
1048
 
# File 'lib/google/apis/analyticsdata_v1beta/classes.rb', line 1046

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) 


1052
1053
1054
 
# File 'lib/google/apis/analyticsdata_v1beta/classes.rb', line 1052

def ui_name
  @ui_name
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
 
# File 'lib/google/apis/analyticsdata_v1beta/classes.rb', line 1059

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