Try the MCP server for Google Analytics. Install from
GitHub, and see the
announcement for more details.
REST Resource: properties.dataStreams.eventCreateRules
Stay organized with collections
Save and categorize content based on your preferences.
Resource: 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.
JSON representation |
{
"name": string,
"destinationEvent": string,
"eventConditions": [
{
object (MatchingCondition )
}
],
"sourceCopyParameters": boolean,
"parameterMutations": [
{
object (ParameterMutation )
}
]
} |
Fields |
name |
string
Output only. Resource name for this EventCreateRule resource. Format: properties/{property}/dataStreams/{dataStream}/eventCreateRules/{eventCreateRule}
|
destinationEvent |
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
|
eventConditions[] |
object (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.
|
sourceCopyParameters |
boolean
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.
|
parameterMutations[] |
object (ParameterMutation )
Parameter mutations define parameter behavior on the new event, and are applied in order. A maximum of 20 mutations can be applied.
|
Methods |
|
Creates an EventCreateRule. |
|
Deletes an EventCreateRule. |
|
Lookup for a single EventCreateRule. |
|
Lists EventCreateRules on a web data stream. |
|
Updates an EventCreateRule. |
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\u003eEvent Create Rules define conditions that trigger the creation of a new event based on a source event and allow for parameter modifications.\u003c/p\u003e\n"],["\u003cp\u003eThese rules operate independently and cannot modify events created by other Event Create rules, nor can they be used with Event Edit rules on such events.\u003c/p\u003e\n"],["\u003cp\u003eEvent Create Rules have several configurable fields, including name, destination event, event conditions, source parameter copying, and parameter mutations.\u003c/p\u003e\n"],["\u003cp\u003eYou can manage Event Create Rules through various methods like creating, deleting, looking up, listing, and updating them.\u003c/p\u003e\n"]]],["EventCreateRules trigger the creation of new events based on source event criteria. Rules operate independently, and cannot modify events they create. Key actions include: defining a `destinationEvent` name (under 40 characters, letters/digits/underscores, starts with a letter), setting `eventConditions` (1-10) for rule activation, controlling `sourceCopyParameters` (boolean), and defining up to 20 `parameterMutations`. Methods support creating, deleting, getting, listing, and updating EventCreateRules. A JSON representation of the rule is provided.\n"],null,["# REST Resource: properties.dataStreams.eventCreateRules\n\n- [Resource: EventCreateRule](#EventCreateRule)\n - [JSON representation](#EventCreateRule.SCHEMA_REPRESENTATION)\n- [Methods](#METHODS_SUMMARY)\n\nResource: EventCreateRule\n-------------------------\n\nAn 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.\n\nUnlike Event Edit rules, Event Creation Rules have no defined order. They will all be run independently.\n\nEvent Edit and Event Create rules can't be used to modify an event created from an Event Create rule.\n\n| JSON representation |\n|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"name\": string, \"destinationEvent\": string, \"eventConditions\": [ { object (/analytics/devguides/config/admin/v1/rest/v1alpha/MatchingCondition) } ], \"sourceCopyParameters\": boolean, \"parameterMutations\": [ { object (/analytics/devguides/config/admin/v1/rest/v1alpha/ParameterMutation) } ] } ``` |\n\n| Fields ||\n|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Output only. Resource name for this EventCreateRule resource. Format: properties/{property}/dataStreams/{dataStream}/eventCreateRules/{eventCreateRule} |\n| `destinationEvent` | `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 |\n| `eventConditions[]` | `object (`[MatchingCondition](/analytics/devguides/config/admin/v1/rest/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. |\n| `sourceCopyParameters` | `boolean` 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. |\n| `parameterMutations[]` | `object (`[ParameterMutation](/analytics/devguides/config/admin/v1/rest/v1alpha/ParameterMutation)`)` Parameter mutations define parameter behavior on the new event, and are applied in order. A maximum of 20 mutations can be applied. |\n\n| Methods ------- ||\n|----------------------------------------------------------------------------------------------------------------|----------------------------------------------|\n| ### [create](/analytics/devguides/config/admin/v1/rest/v1alpha/properties.dataStreams.eventCreateRules/create) | Creates an EventCreateRule. |\n| ### [delete](/analytics/devguides/config/admin/v1/rest/v1alpha/properties.dataStreams.eventCreateRules/delete) | Deletes an EventCreateRule. |\n| ### [get](/analytics/devguides/config/admin/v1/rest/v1alpha/properties.dataStreams.eventCreateRules/get) | Lookup for a single EventCreateRule. |\n| ### [list](/analytics/devguides/config/admin/v1/rest/v1alpha/properties.dataStreams.eventCreateRules/list) | Lists EventCreateRules on a web data stream. |\n| ### [patch](/analytics/devguides/config/admin/v1/rest/v1alpha/properties.dataStreams.eventCreateRules/patch) | Updates an EventCreateRule. |"]]