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.



3857
3858
3859
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 3857

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) 


3817
3818
3819
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 3817

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) 


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

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) 


3832
3833
3834
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 3832

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:



3838
3839
3840
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 3838

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) 


3843
3844
3845
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 3843

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) 


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

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) 


3855
3856
3857
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 3855

def name
  @name
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3862
3863
3864
3865
3866
3867
3868
3869
3870
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 3862

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