Class: Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaConversionEvent

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleAnalyticsAdminV1betaConversionEvent

Returns a new instance of GoogleAnalyticsAdminV1betaConversionEvent.



936
937
938
 
# File 'lib/google/apis/analyticsadmin_v1beta/classes.rb', line 936

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

Instance Attribute Details

#counting_method ⇒ String

Optional. The method by which conversions will be counted across multiple events within a session. If this value is not provided, it will be set to ONCE_PER_EVENT. Corresponds to the JSON property countingMethod

Returns:

  • (String) 


893
894
895
 
# File 'lib/google/apis/analyticsadmin_v1beta/classes.rb', line 893

def counting_method
  @counting_method
end

#create_time ⇒ String

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

Returns:

  • (String) 


898
899
900
 
# File 'lib/google/apis/analyticsadmin_v1beta/classes.rb', line 898

def create_time
  @create_time
end

#custom ⇒ Boolean Also known as: custom?

Output only. If set to true, this conversion event refers to a custom event. If set to false, this conversion 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 conversion events that may be created per property. Corresponds to the JSON property custom

Returns:

  • (Boolean) 


908
909
910
 
# File 'lib/google/apis/analyticsadmin_v1beta/classes.rb', line 908

def custom
  @custom
end

#default_conversion_value ⇒ Google::Apis::AnalyticsadminV1beta::GoogleAnalyticsAdminV1betaConversionEventDefaultConversionValue

Defines a default value/currency for a conversion event. Both value and currency must be provided. Corresponds to the JSON property defaultConversionValue

Returns:



915
916
917
 
# File 'lib/google/apis/analyticsadmin_v1beta/classes.rb', line 915

def default_conversion_value
  @default_conversion_value
end

#deletable ⇒ Boolean Also known as: deletable?

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

Returns:

  • (Boolean) 


921
922
923
 
# File 'lib/google/apis/analyticsadmin_v1beta/classes.rb', line 921

def deletable
  @deletable
end

#event_name ⇒ String

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

Returns:

  • (String) 


928
929
930
 
# File 'lib/google/apis/analyticsadmin_v1beta/classes.rb', line 928

def event_name
  @event_name
end

#name ⇒ String

Output only. Resource name of this conversion event. Format: properties/ property/conversionEvents/conversion_event Corresponds to the JSON property name

Returns:

  • (String) 


934
935
936
 
# File 'lib/google/apis/analyticsadmin_v1beta/classes.rb', line 934

def name
  @name
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



941
942
943
944
945
946
947
948
949
 
# File 'lib/google/apis/analyticsadmin_v1beta/classes.rb', line 941

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_conversion_value = args[:default_conversion_value] if args.key?(:default_conversion_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