Try the MCP server for Google Analytics. Install from
GitHub, and see the
announcement for more details.
REST Resource: properties.dataStreams.eventEditRules
Stay organized with collections
Save and categorize content based on your preferences.
Resource: 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.
JSON representation |
{
"name": string,
"displayName": string,
"eventConditions": [
{
object (MatchingCondition )
}
],
"parameterMutations": [
{
object (ParameterMutation )
}
],
"processingOrder": string
} |
Fields |
name |
string
Identifier. Resource name for this EventEditRule resource. Format: properties/{property}/dataStreams/{dataStream}/eventEditRules/{eventEditRule}
|
displayName |
string
Required. The display name of this event edit rule. Maximum of 255 characters.
|
eventConditions[] |
object (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.
|
parameterMutations[] |
object (ParameterMutation )
Required. Parameter mutations define parameter behavior on the new event, and are applied in order. A maximum of 20 mutations can be applied.
|
processingOrder |
string (int64 format)
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.
|
Methods |
|
Creates an EventEditRule. |
|
Deletes an EventEditRule. |
|
Lookup for a single EventEditRule. |
|
Lists EventEditRules on a web data stream. |
|
Updates an EventEditRule. |
|
Changes the processing order of event edit rules on the specified stream. |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-04-02 UTC.
[null,null,["Last updated 2025-04-02 UTC."],[[["\u003cp\u003eAn Event Edit Rule generates a new event based on matching criteria from a source event and allows for parameter modifications.\u003c/p\u003e\n"],["\u003cp\u003eEvent Edit Rules are applied sequentially in their defined order, unlike Event Create rules.\u003c/p\u003e\n"],["\u003cp\u003eThese rules cannot modify events originating from Event Create rules.\u003c/p\u003e\n"],["\u003cp\u003eEvent Edit Rules include definable conditions, parameter mutations, and a processing order for execution.\u003c/p\u003e\n"],["\u003cp\u003eYou can manage Event Edit Rules using methods like create, delete, get, list, patch, and reorder to control event processing.\u003c/p\u003e\n"]]],["Event Edit Rules create new events based on source event criteria, with defined parameter mutations. Rules are applied sequentially based on `processingOrder`. Each rule has a `name`, `displayName`, `eventConditions`, and `parameterMutations`. Rules can be created, deleted, retrieved, listed, updated, and reordered. Matching conditions trigger the rule's application, with mutations modifying parameters. Up to 10 conditions and 20 mutations are allowed.\n"],null,["# REST Resource: properties.dataStreams.eventEditRules\n\n- [Resource: EventEditRule](#EventEditRule)\n - [JSON representation](#EventEditRule.SCHEMA_REPRESENTATION)\n- [Methods](#METHODS_SUMMARY)\n\nResource: EventEditRule\n-----------------------\n\nAn 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.\n\nUnlike Event Create rules, Event Edit Rules are applied in their defined order.\n\nEvent Edit rules can't be used to modify an event created from an Event Create rule.\n\n| JSON representation |\n|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"name\": string, \"displayName\": string, \"eventConditions\": [ { object (/analytics/devguides/config/admin/v1/rest/v1alpha/MatchingCondition) } ], \"parameterMutations\": [ { object (/analytics/devguides/config/admin/v1/rest/v1alpha/ParameterMutation) } ], \"processingOrder\": string } ``` |\n\n| Fields ||\n|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Identifier. Resource name for this EventEditRule resource. Format: properties/{property}/dataStreams/{dataStream}/eventEditRules/{eventEditRule} |\n| `displayName` | `string` Required. The display name of this event edit rule. Maximum of 255 characters. |\n| `eventConditions[]` | `object (`[MatchingCondition](/analytics/devguides/config/admin/v1/rest/v1alpha/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. |\n| `parameterMutations[]` | `object (`[ParameterMutation](/analytics/devguides/config/admin/v1/rest/v1alpha/ParameterMutation)`)` Required. Parameter mutations define parameter behavior on the new event, and are applied in order. A maximum of 20 mutations can be applied. |\n| `processingOrder` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` 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. |\n\n| Methods ------- ||\n|----------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------|\n| ### [create](/analytics/devguides/config/admin/v1/rest/v1alpha/properties.dataStreams.eventEditRules/create) | Creates an EventEditRule. |\n| ### [delete](/analytics/devguides/config/admin/v1/rest/v1alpha/properties.dataStreams.eventEditRules/delete) | Deletes an EventEditRule. |\n| ### [get](/analytics/devguides/config/admin/v1/rest/v1alpha/properties.dataStreams.eventEditRules/get) | Lookup for a single EventEditRule. |\n| ### [list](/analytics/devguides/config/admin/v1/rest/v1alpha/properties.dataStreams.eventEditRules/list) | Lists EventEditRules on a web data stream. |\n| ### [patch](/analytics/devguides/config/admin/v1/rest/v1alpha/properties.dataStreams.eventEditRules/patch) | Updates an EventEditRule. |\n| ### [reorder](/analytics/devguides/config/admin/v1/rest/v1alpha/properties.dataStreams.eventEditRules/reorder) | Changes the processing order of event edit rules on the specified stream. |"]]