Reference documentation and code samples for the Google Analytics Admin V1alpha Client class EventEditRule.
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.
Generated from protobuf message google.analytics.admin.v1alpha.EventEditRule
Namespace
Google \ Analytics \ Admin \ V1alphaMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Identifier. Resource name for this EventEditRule resource. Format: properties/{property}/dataStreams/{data_stream}/eventEditRules/{event_edit_rule} |
↳ display_name |
string
Required. The display name of this event edit rule. Maximum of 255 characters. |
↳ event_conditions |
array<MatchingCondition>
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. |
↳ parameter_mutations |
array<ParameterMutation>
Required. Parameter mutations define parameter behavior on the new event, and are applied in order. A maximum of 20 mutations can be applied. |
↳ processing_order |
int|string
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. |
getName
Identifier. Resource name for this EventEditRule resource.
Format: properties/{property}/dataStreams/{data_stream}/eventEditRules/{event_edit_rule}
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Identifier. Resource name for this EventEditRule resource.
Format: properties/{property}/dataStreams/{data_stream}/eventEditRules/{event_edit_rule}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDisplayName
Required. The display name of this event edit rule. Maximum of 255 characters.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDisplayName
Required. The display name of this event edit rule. Maximum of 255 characters.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEventConditions
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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setEventConditions
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.
| Parameter | |
|---|---|
| Name | Description |
var |
array<MatchingCondition>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getParameterMutations
Required. 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
Required. 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<ParameterMutation>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getProcessingOrder
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.
| Returns | |
|---|---|
| Type | Description |
int|string |
|
setProcessingOrder
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.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|