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.



3141
3142
3143
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 3141

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) 


3112
3113
3114
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 3112

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:



3118
3119
3120
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 3118

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) 


3125
3126
3127
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 3125

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:



3131
3132
3133
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 3131

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) 


3138
3139
3140
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 3138

def source_copy_parameters
  @source_copy_parameters
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3146
3147
3148
3149
3150
3151
3152
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 3146

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