Class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaConversionEvent

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleAnalyticsAdminV1alphaConversionEvent

Returns a new instance of GoogleAnalyticsAdminV1alphaConversionEvent.



2269
2270
2271
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 2269

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) 


2226
2227
2228
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 2226

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) 


2231
2232
2233
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 2231

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) 


2241
2242
2243
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 2241

def custom
  @custom
end

#default_conversion_value ⇒ Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaConversionEventDefaultConversionValue

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

Returns:



2248
2249
2250
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 2248

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) 


2254
2255
2256
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 2254

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) 


2261
2262
2263
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 2261

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) 


2267
2268
2269
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 2267

def name
  @name
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2274
2275
2276
2277
2278
2279
2280
2281
2282
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 2274

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