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

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ CustomMetric

Returns a new instance of CustomMetric



1216
1217
1218
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 1216

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

Instance Attribute Details

#account_id ⇒ String

Account ID. Corresponds to the JSON property accountId

Returns:

  • (String) 


1141
1142
1143
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 1141

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) 


1146
1147
1148
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 1146

def active
  @active
end

#created ⇒ DateTime

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

Returns:

  • (DateTime) 


1152
1153
1154
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 1152

def created
  @created
end

#id ⇒ String

Custom metric ID. Corresponds to the JSON property id

Returns:

  • (String) 


1157
1158
1159
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 1157

def id
  @id
end

#index ⇒ Fixnum

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

Returns:

  • (Fixnum) 


1162
1163
1164
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 1162

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) 


1168
1169
1170
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 1168

def kind
  @kind
end

#max_value ⇒ String

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

Returns:

  • (String) 


1173
1174
1175
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 1173

def max_value
  @max_value
end

#min_value ⇒ String

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

Returns:

  • (String) 


1178
1179
1180
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 1178

def min_value
  @min_value
end

#name ⇒ String

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

Returns:

  • (String) 


1183
1184
1185
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 1183

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:



1189
1190
1191
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 1189

def parent_link
  @parent_link
end

#scope ⇒ String

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

Returns:

  • (String) 


1194
1195
1196
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 1194

def scope
  @scope
end

#self_link ⇒ String

Link for the custom metric Corresponds to the JSON property selfLink

Returns:

  • (String) 


1199
1200
1201
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 1199

def self_link
  @self_link
end

#type ⇒ String

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

Returns:

  • (String) 


1204
1205
1206
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 1204

def type
  @type
end

#updated ⇒ DateTime

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

Returns:

  • (DateTime) 


1209
1210
1211
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 1209

def updated
  @updated
end

#web_property_id ⇒ String

Property ID. Corresponds to the JSON property webPropertyId

Returns:

  • (String) 


1214
1215
1216
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 1214

def web_property_id
  @web_property_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
 
# File 'generated/google/apis/analytics_v3/classes.rb', line 1221

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