Class: Google::Apis::AnalyticsV3::CustomMetric

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

Overview

JSON template for Analytics Custom Metric.

Defined Under Namespace

Classes: ParentLink

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ CustomMetric

Returns a new instance of CustomMetric.



1122
1123
1124
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 1122

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

Instance Attribute Details

#account_id ⇒ String

Account ID. Corresponds to the JSON property accountId

Returns:

  • (String) 


1047
1048
1049
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 1047

def 
  @account_id
end

#active ⇒ Boolean Also known as: active?

Boolean indicating whether the custom metric is active. Corresponds to the JSON property active

Returns:

  • (Boolean) 


1052
1053
1054
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 1052

def active
  @active
end

#created ⇒ DateTime

Time the custom metric was created. Corresponds to the JSON property created

Returns:

  • (DateTime) 


1058
1059
1060
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 1058

def created
  @created
end

#id ⇒ String

Custom metric ID. Corresponds to the JSON property id

Returns:

  • (String) 


1063
1064
1065
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 1063

def id
  @id
end

#index ⇒ Fixnum

Index of the custom metric. Corresponds to the JSON property index

Returns:

  • (Fixnum) 


1068
1069
1070
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 1068

def index
  @index
end

#kind ⇒ String

Kind value for a custom metric. Set to "analytics#customMetric". It is a read- only field. Corresponds to the JSON property kind

Returns:

  • (String) 


1074
1075
1076
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 1074

def kind
  @kind
end

#max_value ⇒ String

Max value of custom metric. Corresponds to the JSON property max_value

Returns:

  • (String) 


1079
1080
1081
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 1079

def max_value
  @max_value
end

#min_value ⇒ String

Min value of custom metric. Corresponds to the JSON property min_value

Returns:

  • (String) 


1084
1085
1086
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 1084

def min_value
  @min_value
end

#name ⇒ String

Name of the custom metric. Corresponds to the JSON property name

Returns:

  • (String) 


1089
1090
1091
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 1089

def name
  @name
end

#parent_link ⇒ Google::Apis::AnalyticsV3::CustomMetric::ParentLink

Parent link for the custom metric. Points to the property to which the custom metric belongs. Corresponds to the JSON property parentLink

Returns:



1095
1096
1097
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 1095

def parent_link
  @parent_link
end

#scope ⇒ String

Scope of the custom metric: HIT or PRODUCT. Corresponds to the JSON property scope

Returns:

  • (String) 


1100
1101
1102
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 1100

def scope
  @scope
end

#self_link ⇒ String

Link for the custom metric Corresponds to the JSON property selfLink

Returns:

  • (String) 


1105
1106
1107
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 1105

def self_link
  @self_link
end

#type ⇒ String

Data type of custom metric. Corresponds to the JSON property type

Returns:

  • (String) 


1110
1111
1112
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 1110

def type
  @type
end

#updated ⇒ DateTime

Time the custom metric was last modified. Corresponds to the JSON property updated

Returns:

  • (DateTime) 


1115
1116
1117
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 1115

def updated
  @updated
end

#web_property_id ⇒ String

Property ID. Corresponds to the JSON property webPropertyId

Returns:

  • (String) 


1120
1121
1122
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 1120

def web_property_id
  @web_property_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 1127

def update!(**args)
  @account_id = args[:account_id] if args.key?(:account_id)
  @active = args[:active] if args.key?(:active)
  @created = args[:created] if args.key?(:created)
  @id = args[:id] if args.key?(:id)
  @index = args[:index] if args.key?(:index)
  @kind = args[:kind] if args.key?(:kind)
  @max_value = args[:max_value] if args.key?(:max_value)
  @min_value = args[:min_value] if args.key?(:min_value)
  @name = args[:name] if args.key?(:name)
  @parent_link = args[:parent_link] if args.key?(:parent_link)
  @scope = args[:scope] if args.key?(:scope)
  @self_link = args[:self_link] if args.key?(:self_link)
  @type = args[:type] if args.key?(:type)
  @updated = args[:updated] if args.key?(:updated)
  @web_property_id = args[:web_property_id] if args.key?(:web_property_id)
end