Google Analytics Admin V1alpha Client - Class EventCreateRule (0.23.0)

Reference documentation and code samples for the Google Analytics Admin V1alpha Client class EventCreateRule.

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.

Generated from protobuf message google.analytics.admin.v1alpha.EventCreateRule

Namespace

Google \ Analytics \ Admin \ V1alpha

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

Output only. Resource name for this EventCreateRule resource. Format: properties/{property}/dataStreams/{data_stream}/eventCreateRules/{event_create_rule}

↳ 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

↳ event_conditions array<Google\Analytics\Admin\V1alpha\MatchingCondition>

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.

↳ source_copy_parameters bool

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.

↳ parameter_mutations array<Google\Analytics\Admin\V1alpha\ParameterMutation>

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

getName

Output only. Resource name for this EventCreateRule resource.

Format: properties/{property}/dataStreams/{data_stream}/eventCreateRules/{event_create_rule}

Returns
Type Description
string

setName

Output only. Resource name for this EventCreateRule resource.

Format: properties/{property}/dataStreams/{data_stream}/eventCreateRules/{event_create_rule}

Parameter
Name Description
var string
Returns
Type Description
$this

getDestinationEvent

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
Returns
Type Description
string

setDestinationEvent

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
Parameter
Name Description
var string
Returns
Type Description
$this

getEventConditions

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.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setEventConditions

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.

Parameter
Name Description
var array<Google\Analytics\Admin\V1alpha\MatchingCondition>
Returns
Type Description
$this

getSourceCopyParameters

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.

Returns
Type Description
bool

setSourceCopyParameters

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.

Parameter
Name Description
var bool
Returns
Type Description
$this

getParameterMutations

Parameter mutations define parameter behavior on the new event, and are applied in order.

A maximum of 20 mutations can be applied.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setParameterMutations

Parameter mutations define parameter behavior on the new event, and are applied in order.

A maximum of 20 mutations can be applied.

Parameter
Name Description
var array<Google\Analytics\Admin\V1alpha\ParameterMutation>
Returns
Type Description
$this