Class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaEventEditRule

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 Edit 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 Create rules, Event Edit Rules are applied in their defined order. Event Edit 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) ⇒ GoogleAnalyticsAdminV1alphaEventEditRule

Returns a new instance of GoogleAnalyticsAdminV1alphaEventEditRule.



3246
3247
3248
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 3246

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

Instance Attribute Details

#display_name ⇒ String

Required. The display name of this event edit rule. Maximum of 255 characters. Corresponds to the JSON property displayName

Returns:

  • (String) 


3217
3218
3219
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 3217

def display_name
  @display_name
end

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

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

Returns:



3223
3224
3225
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 3223

def event_conditions
  @event_conditions
end

#name ⇒ String

Identifier. Resource name for this EventEditRule resource. Format: properties/ property/dataStreams/data_stream/eventEditRules/event_edit_rule Corresponds to the JSON property name

Returns:

  • (String) 


3229
3230
3231
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 3229

def name
  @name
end

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

Required. 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:



3235
3236
3237
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 3235

def parameter_mutations
  @parameter_mutations
end

#processing_order ⇒ Fixnum

Output only. The order for which this rule will be processed. Rules with an order value lower than this will be processed before this rule, rules with an order value higher than this will be processed after this rule. New event edit rules will be assigned an order value at the end of the order. This value does not apply to event create rules. Corresponds to the JSON property processingOrder

Returns:

  • (Fixnum) 


3244
3245
3246
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 3244

def processing_order
  @processing_order
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3251
3252
3253
3254
3255
3256
3257
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 3251

def update!(**args)
  @display_name = args[:display_name] if args.key?(:display_name)
  @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)
  @processing_order = args[:processing_order] if args.key?(:processing_order)
end