Class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaCustomMetric

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

Overview

A definition for a custom metric.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleAnalyticsAdminV1alphaCustomMetric

Returns a new instance of GoogleAnalyticsAdminV1alphaCustomMetric.



2331
2332
2333
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 2331

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

Instance Attribute Details

#description ⇒ String

Optional. Description for this custom dimension. Max length of 150 characters. Corresponds to the JSON property description

Returns:

  • (String) 


2290
2291
2292
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 2290

def description
  @description
end

#display_name ⇒ String

Required. Display name for this custom metric as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets. Corresponds to the JSON property displayName

Returns:

  • (String) 


2298
2299
2300
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 2298

def display_name
  @display_name
end

#measurement_unit ⇒ String

Required. The type for the custom metric's value. Corresponds to the JSON property measurementUnit

Returns:

  • (String) 


2303
2304
2305
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 2303

def measurement_unit
  @measurement_unit
end

#name ⇒ String

Output only. Resource name for this CustomMetric resource. Format: properties/ property/customMetrics/customMetric Corresponds to the JSON property name

Returns:

  • (String) 


2309
2310
2311
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 2309

def name
  @name
end

#parameter_name ⇒ String

Required. Immutable. Tagging name for this custom metric. If this is an event- scoped metric, then this is the event parameter name. May only contain alphanumeric and underscore charactes, starting with a letter. Max length of 40 characters for event-scoped metrics. Corresponds to the JSON property parameterName

Returns:

  • (String) 


2317
2318
2319
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 2317

def parameter_name
  @parameter_name
end

#restricted_metric_type ⇒ Array<String>

Optional. Types of restricted data that this metric may contain. Required for metrics with CURRENCY measurement unit. Must be empty for metrics with a non- CURRENCY measurement unit. Corresponds to the JSON property restrictedMetricType

Returns:

  • (Array<String>) 


2324
2325
2326
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 2324

def restricted_metric_type
  @restricted_metric_type
end

#scope ⇒ String

Required. Immutable. The scope of this custom metric. Corresponds to the JSON property scope

Returns:

  • (String) 


2329
2330
2331
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 2329

def scope
  @scope
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2336
2337
2338
2339
2340
2341
2342
2343
2344
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 2336

def update!(**args)
  @description = args[:description] if args.key?(:description)
  @display_name = args[:display_name] if args.key?(:display_name)
  @measurement_unit = args[:measurement_unit] if args.key?(:measurement_unit)
  @name = args[:name] if args.key?(:name)
  @parameter_name = args[:parameter_name] if args.key?(:parameter_name)
  @restricted_metric_type = args[:restricted_metric_type] if args.key?(:restricted_metric_type)
  @scope = args[:scope] if args.key?(:scope)
end