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.



2358
2359
2360
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 2358

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

Instance Attribute Details

#counting_methodString

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)


2321
2322
2323
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 2321

def counting_method
  @counting_method
end

#create_timeString

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

Returns:

  • (String)


2326
2327
2328
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 2326

def create_time
  @create_time
end

#customBoolean 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)


2336
2337
2338
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 2336

def custom
  @custom
end

#deletableBoolean Also known as: deletable?

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

Returns:

  • (Boolean)


2343
2344
2345
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 2343

def deletable
  @deletable
end

#event_nameString

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

Returns:

  • (String)


2350
2351
2352
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 2350

def event_name
  @event_name
end

#nameString

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

Returns:

  • (String)


2356
2357
2358
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 2356

def name
  @name
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2363
2364
2365
2366
2367
2368
2369
2370
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 2363

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)
  @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