Class: Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaKeyEvent

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

Overview

A key event in a Google Analytics property.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleAnalyticsAdminV1betaKeyEvent

Returns a new instance of GoogleAnalyticsAdminV1betaKeyEvent.



1504
1505
1506
 
# File 'lib/google/apis/analyticsadmin_v1beta/classes.rb', line 1504

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

Instance Attribute Details

#counting_method ⇒ String

Required. The method by which Key Events will be counted across multiple events within a session. Corresponds to the JSON property countingMethod

Returns:

  • (String) 


1464
1465
1466
 
# File 'lib/google/apis/analyticsadmin_v1beta/classes.rb', line 1464

def counting_method
  @counting_method
end

#create_time ⇒ String

Output only. Time when this key event was created in the property. Corresponds to the JSON property createTime

Returns:

  • (String) 


1469
1470
1471
 
# File 'lib/google/apis/analyticsadmin_v1beta/classes.rb', line 1469

def create_time
  @create_time
end

#custom ⇒ Boolean Also known as: custom?

Output only. If set to true, this key event refers to a custom event. If set to false, this key event refers to a default event in GA. Default events typically have special meaning in GA. Default events are usually created for you by the GA system, but in some cases can be created by property admins. Custom events count towards the maximum number of custom key events that may be created per property. Corresponds to the JSON property custom

Returns:

  • (Boolean) 


1479
1480
1481
 
# File 'lib/google/apis/analyticsadmin_v1beta/classes.rb', line 1479

def custom
  @custom
end

#default_value ⇒ Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaKeyEventDefaultValue

Defines a default value/currency for a key event. Corresponds to the JSON property defaultValue

Returns:



1485
1486
1487
 
# File 'lib/google/apis/analyticsadmin_v1beta/classes.rb', line 1485

def default_value
  @default_value
end

#deletable ⇒ Boolean Also known as: deletable?

Output only. If set to true, this event can be deleted. Corresponds to the JSON property deletable

Returns:

  • (Boolean) 


1490
1491
1492
 
# File 'lib/google/apis/analyticsadmin_v1beta/classes.rb', line 1490

def deletable
  @deletable
end

#event_name ⇒ String

Immutable. The event name for this key event. Examples: 'click', 'purchase' Corresponds to the JSON property eventName

Returns:

  • (String) 


1496
1497
1498
 
# File 'lib/google/apis/analyticsadmin_v1beta/classes.rb', line 1496

def event_name
  @event_name
end

#name ⇒ String

Output only. Resource name of this key event. Format: properties/property/ keyEvents/key_event Corresponds to the JSON property name

Returns:

  • (String) 


1502
1503
1504
 
# File 'lib/google/apis/analyticsadmin_v1beta/classes.rb', line 1502

def name
  @name
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1509
1510
1511
1512
1513
1514
1515
1516
1517
 
# File 'lib/google/apis/analyticsadmin_v1beta/classes.rb', line 1509

def update!(**args)
  @counting_method = args[:counting_method] if args.key?(:counting_method)
  @create_time = args[:create_time] if args.key?(:create_time)
  @custom = args[:custom] if args.key?(:custom)
  @default_value = args[:default_value] if args.key?(:default_value)
  @deletable = args[:deletable] if args.key?(:deletable)
  @event_name = args[:event_name] if args.key?(:event_name)
  @name = args[:name] if args.key?(:name)
end