Class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaEventCreateRule

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

An Event Create Rule defines conditions that will trigger the creation of an entirely new event based upon matched criteria of a source event. Additional mutations of the parameters from the source event can be defined. Unlike Event Edit rules, Event Creation Rules have no defined order. They will all be run independently. Event Edit and Event Create rules can't be used to modify an event created from an Event Create rule.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleAnalyticsAdminV1alphaEventCreateRule

Returns a new instance of GoogleAnalyticsAdminV1alphaEventCreateRule.



3286
3287
3288
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 3286

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

Instance Attribute Details

#destination_event ⇒ String

Required. The name of the new event to be created. This value must: * be less than 40 characters * consist only of letters, digits or _ (underscores) * start with a letter Corresponds to the JSON property destinationEvent

Returns:

  • (String) 


3257
3258
3259
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 3257

def destination_event
  @destination_event
end

#event_conditions ⇒ Array<Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaMatchingCondition>

Required. Must have at least one condition, and can have up to 10 max. Conditions on the source event must match for this rule to be applied. Corresponds to the JSON property eventConditions

Returns:



3263
3264
3265
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 3263

def event_conditions
  @event_conditions
end

#name ⇒ String

Output only. Resource name for this EventCreateRule resource. Format: properties/property/dataStreams/data_stream/eventCreateRules/ event_create_rule Corresponds to the JSON property name

Returns:

  • (String) 


3270
3271
3272
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 3270

def name
  @name
end

#parameter_mutations ⇒ Array<Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaParameterMutation>

Parameter mutations define parameter behavior on the new event, and are applied in order. A maximum of 20 mutations can be applied. Corresponds to the JSON property parameterMutations

Returns:



3276
3277
3278
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 3276

def parameter_mutations
  @parameter_mutations
end

#source_copy_parameters ⇒ Boolean Also known as: source_copy_parameters?

If true, the source parameters are copied to the new event. If false, or unset, all non-internal parameters are not copied from the source event. Parameter mutations are applied after the parameters have been copied. Corresponds to the JSON property sourceCopyParameters

Returns:

  • (Boolean) 


3283
3284
3285
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 3283

def source_copy_parameters
  @source_copy_parameters
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3291
3292
3293
3294
3295
3296
3297
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 3291

def update!(**args)
  @destination_event = args[:destination_event] if args.key?(:destination_event)
  @event_conditions = args[:event_conditions] if args.key?(:event_conditions)
  @name = args[:name] if args.key?(:name)
  @parameter_mutations = args[:parameter_mutations] if args.key?(:parameter_mutations)
  @source_copy_parameters = args[:source_copy_parameters] if args.key?(:source_copy_parameters)
end