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
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.
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Analytics Admin V1alpha Client - Class EventCreateRule (0.29.1)\n\nVersion latestkeyboard_arrow_down\n\n- [0.29.1 (latest)](/php/docs/reference/analytics-admin/latest/V1alpha.EventCreateRule)\n- [0.29.0](/php/docs/reference/analytics-admin/0.29.0/V1alpha.EventCreateRule)\n- [0.28.1](/php/docs/reference/analytics-admin/0.28.1/V1alpha.EventCreateRule)\n- [0.27.0](/php/docs/reference/analytics-admin/0.27.0/V1alpha.EventCreateRule)\n- [0.26.0](/php/docs/reference/analytics-admin/0.26.0/V1alpha.EventCreateRule)\n- [0.25.2](/php/docs/reference/analytics-admin/0.25.2/V1alpha.EventCreateRule)\n- [0.24.2](/php/docs/reference/analytics-admin/0.24.2/V1alpha.EventCreateRule)\n- [0.23.0](/php/docs/reference/analytics-admin/0.23.0/V1alpha.EventCreateRule)\n- [0.22.5](/php/docs/reference/analytics-admin/0.22.5/V1alpha.EventCreateRule)\n- [0.20.0](/php/docs/reference/analytics-admin/0.20.0/V1alpha.EventCreateRule)\n- [0.19.0](/php/docs/reference/analytics-admin/0.19.0/V1alpha.EventCreateRule)\n- [0.18.1](/php/docs/reference/analytics-admin/0.18.1/V1alpha.EventCreateRule)\n- [0.17.0](/php/docs/reference/analytics-admin/0.17.0/V1alpha.EventCreateRule)\n- [0.16.0](/php/docs/reference/analytics-admin/0.16.0/V1alpha.EventCreateRule)\n- [0.15.1](/php/docs/reference/analytics-admin/0.15.1/V1alpha.EventCreateRule)\n- [0.14.0](/php/docs/reference/analytics-admin/0.14.0/V1alpha.EventCreateRule)\n- [0.13.0](/php/docs/reference/analytics-admin/0.13.0/V1alpha.EventCreateRule)\n- [0.12.0](/php/docs/reference/analytics-admin/0.12.0/V1alpha.EventCreateRule)\n- [0.11.1](/php/docs/reference/analytics-admin/0.11.1/V1alpha.EventCreateRule)\n- [0.10.0](/php/docs/reference/analytics-admin/0.10.0/V1alpha.EventCreateRule)\n- [0.9.0](/php/docs/reference/analytics-admin/0.9.0/V1alpha.EventCreateRule)\n- [0.8.2](/php/docs/reference/analytics-admin/0.8.2/V1alpha.EventCreateRule) \n| **Beta**\n|\n|\n| This library is covered by the [Pre-GA Offerings Terms](/terms/service-terms#1)\n| of the Terms of Service. Pre-GA libraries might have limited support,\n| and changes to pre-GA libraries might not be compatible with other pre-GA versions.\n| For more information, see the\n[launch stage descriptions](/products#product-launch-stages). \nReference documentation and code samples for the Google Analytics Admin V1alpha Client class EventCreateRule.\n\nAn Event Create Rule defines conditions that will trigger the creation\nof an entirely new event based upon matched criteria of a source event.\n\nAdditional mutations of the parameters from the source event can be defined.\nUnlike Event Edit rules, Event Creation Rules have no defined order. They\nwill all be run independently.\nEvent Edit and Event Create rules can't be used to modify an event created\nfrom an Event Create rule.\n\nGenerated from protobuf message `google.analytics.admin.v1alpha.EventCreateRule`\n\nNamespace\n---------\n\nGoogle \\\\ Analytics \\\\ Admin \\\\ V1alpha\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getName\n\nOutput only. Resource name for this EventCreateRule resource.\n\nFormat:\nproperties/{property}/dataStreams/{data_stream}/eventCreateRules/{event_create_rule}\n\n### setName\n\nOutput only. Resource name for this EventCreateRule resource.\n\nFormat:\nproperties/{property}/dataStreams/{data_stream}/eventCreateRules/{event_create_rule}\n\n### getDestinationEvent\n\nRequired. The name of the new event to be created.\n\nThis value must:\n\n- be less than 40 characters\n- consist only of letters, digits or _ (underscores)\n- start with a letter\n\n### setDestinationEvent\n\nRequired. The name of the new event to be created.\n\nThis value must:\n\n- be less than 40 characters\n- consist only of letters, digits or _ (underscores)\n- start with a letter\n\n### getEventConditions\n\nRequired. Must have at least one condition, and can have up to 10 max.\n\nConditions on the source event must match for this rule to be applied.\n\n### setEventConditions\n\nRequired. Must have at least one condition, and can have up to 10 max.\n\nConditions on the source event must match for this rule to be applied.\n\n### getSourceCopyParameters\n\nIf true, the source parameters are copied to the new event.\n\nIf false, or unset, all non-internal parameters are not copied from the\nsource event. Parameter mutations are applied after the parameters have\nbeen copied.\n\n### setSourceCopyParameters\n\nIf true, the source parameters are copied to the new event.\n\nIf false, or unset, all non-internal parameters are not copied from the\nsource event. Parameter mutations are applied after the parameters have\nbeen copied.\n\n### getParameterMutations\n\nParameter mutations define parameter behavior on the new event, and\nare applied in order.\n\nA maximum of 20 mutations can be applied.\n\n### setParameterMutations\n\nParameter mutations define parameter behavior on the new event, and\nare applied in order.\n\nA maximum of 20 mutations can be applied."]]
