Class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaKeyEvent

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 key event in a Google Analytics property.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleAnalyticsAdminV1alphaKeyEvent

Returns a new instance of GoogleAnalyticsAdminV1alphaKeyEvent.



3848
3849
3850
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 3848

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) 


3808
3809
3810
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 3808

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) 


3813
3814
3815
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 3813

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) 


3823
3824
3825
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 3823

def custom
  @custom
end

#default_value ⇒ Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaKeyEventDefaultValue

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

Returns:



3829
3830
3831
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 3829

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) 


3834
3835
3836
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 3834

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) 


3840
3841
3842
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 3840

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) 


3846
3847
3848
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 3846

def name
  @name
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3853
3854
3855
3856
3857
3858
3859
3860
3861
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 3853

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