Send feedback
Class EventCreateRule (0.56.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version 0.56.0 keyboard_arrow_down
public final class EventCreateRule extends GeneratedMessageV3 implements EventCreateRuleOrBuilder
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.
Protobuf type google.analytics.admin.v1alpha.EventCreateRule
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
DESTINATION_EVENT_FIELD_NUMBER
public static final int DESTINATION_EVENT_FIELD_NUMBER
Field Value
Type
Description
int
EVENT_CONDITIONS_FIELD_NUMBER
public static final int EVENT_CONDITIONS_FIELD_NUMBER
Field Value
Type
Description
int
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
Type
Description
int
PARAMETER_MUTATIONS_FIELD_NUMBER
public static final int PARAMETER_MUTATIONS_FIELD_NUMBER
Field Value
Type
Description
int
SOURCE_COPY_PARAMETERS_FIELD_NUMBER
public static final int SOURCE_COPY_PARAMETERS_FIELD_NUMBER
Field Value
Type
Description
int
Static Methods
getDefaultInstance()
public static EventCreateRule getDefaultInstance ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static EventCreateRule . Builder newBuilder ()
newBuilder(EventCreateRule prototype)
public static EventCreateRule . Builder newBuilder ( EventCreateRule prototype )
public static EventCreateRule parseDelimitedFrom ( InputStream input )
public static EventCreateRule parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static EventCreateRule parseFrom ( byte [] data )
Parameter
Name
Description
data
byte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static EventCreateRule parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static EventCreateRule parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static EventCreateRule parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static EventCreateRule parseFrom ( CodedInputStream input )
public static EventCreateRule parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static EventCreateRule parseFrom ( InputStream input )
public static EventCreateRule parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static EventCreateRule parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static EventCreateRule parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<EventCreateRule> parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name
Description
obj
Object
Overrides
getDefaultInstanceForType()
public EventCreateRule getDefaultInstanceForType ()
getDestinationEvent()
public String 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
string destination_event = 2 [(.google.api.field_behavior) = REQUIRED];
Returns
Type
Description
String
The destinationEvent.
getDestinationEventBytes()
public ByteString getDestinationEventBytes ()
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
string destination_event = 2 [(.google.api.field_behavior) = REQUIRED];
Returns
Type
Description
ByteString
The bytes for destinationEvent.
getEventConditions(int index)
public MatchingCondition getEventConditions ( int index )
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.
repeated .google.analytics.admin.v1alpha.MatchingCondition event_conditions = 3 [(.google.api.field_behavior) = REQUIRED];
Parameter
Name
Description
index
int
getEventConditionsCount()
public int getEventConditionsCount ()
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.
repeated .google.analytics.admin.v1alpha.MatchingCondition event_conditions = 3 [(.google.api.field_behavior) = REQUIRED];
Returns
Type
Description
int
getEventConditionsList()
public List<MatchingCondition> getEventConditionsList ()
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.
repeated .google.analytics.admin.v1alpha.MatchingCondition event_conditions = 3 [(.google.api.field_behavior) = REQUIRED];
getEventConditionsOrBuilder(int index)
public MatchingConditionOrBuilder getEventConditionsOrBuilder ( int index )
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.
repeated .google.analytics.admin.v1alpha.MatchingCondition event_conditions = 3 [(.google.api.field_behavior) = REQUIRED];
Parameter
Name
Description
index
int
getEventConditionsOrBuilderList()
public List <? extends MatchingConditionOrBuilder > getEventConditionsOrBuilderList ()
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.
repeated .google.analytics.admin.v1alpha.MatchingCondition event_conditions = 3 [(.google.api.field_behavior) = REQUIRED];
Returns
Type
Description
List <? extends com.google.analytics.admin.v1alpha.MatchingConditionOrBuilder >
getName()
Output only. Resource name for this EventCreateRule resource.
Format:
properties/{property}/dataStreams/{data_stream}/eventCreateRules/{event_create_rule}
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
Type
Description
String
The name.
getNameBytes()
public ByteString getNameBytes ()
Output only. Resource name for this EventCreateRule resource.
Format:
properties/{property}/dataStreams/{data_stream}/eventCreateRules/{event_create_rule}
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
Type
Description
ByteString
The bytes for name.
getParameterMutations(int index)
public ParameterMutation getParameterMutations ( int index )
Parameter mutations define parameter behavior on the new event, and
are applied in order.
A maximum of 20 mutations can be applied.
repeated .google.analytics.admin.v1alpha.ParameterMutation parameter_mutations = 5;
Parameter
Name
Description
index
int
getParameterMutationsCount()
public int getParameterMutationsCount ()
Parameter mutations define parameter behavior on the new event, and
are applied in order.
A maximum of 20 mutations can be applied.
repeated .google.analytics.admin.v1alpha.ParameterMutation parameter_mutations = 5;
Returns
Type
Description
int
getParameterMutationsList()
public List<ParameterMutation> getParameterMutationsList ()
Parameter mutations define parameter behavior on the new event, and
are applied in order.
A maximum of 20 mutations can be applied.
repeated .google.analytics.admin.v1alpha.ParameterMutation parameter_mutations = 5;
getParameterMutationsOrBuilder(int index)
public ParameterMutationOrBuilder getParameterMutationsOrBuilder ( int index )
Parameter mutations define parameter behavior on the new event, and
are applied in order.
A maximum of 20 mutations can be applied.
repeated .google.analytics.admin.v1alpha.ParameterMutation parameter_mutations = 5;
Parameter
Name
Description
index
int
getParameterMutationsOrBuilderList()
public List <? extends ParameterMutationOrBuilder > getParameterMutationsOrBuilderList ()
Parameter mutations define parameter behavior on the new event, and
are applied in order.
A maximum of 20 mutations can be applied.
repeated .google.analytics.admin.v1alpha.ParameterMutation parameter_mutations = 5;
Returns
Type
Description
List <? extends com.google.analytics.admin.v1alpha.ParameterMutationOrBuilder >
getParserForType()
public Parser<EventCreateRule> getParserForType ()
Overrides
getSerializedSize()
public int getSerializedSize ()
Returns
Type
Description
int
Overrides
getSourceCopyParameters()
public boolean 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.
bool source_copy_parameters = 4;
Returns
Type
Description
boolean
The sourceCopyParameters.
hashCode()
Returns
Type
Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public EventCreateRule . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected EventCreateRule . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type
Description
Object
Overrides
toBuilder()
public EventCreateRule . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Send feedback
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-03-21 UTC.
Need to tell us more?
[[["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-03-21 UTC."],[[["This document outlines the specifications for `EventCreateRule` within the Google Analytics Admin v1alpha Java library, detailing its functionality in creating new events based on defined criteria."],["The `EventCreateRule` allows for conditions to be set that, when met by a source event, will trigger the creation of a new event."],["Parameter mutations can be defined to adjust the parameters of the new event, and they are applied in a set order after source parameters have potentially been copied."],["Event Creation Rules, unlike Event Edit Rules, have no order, and Event Edit and Event Create rules cannot be used to modify events created by an Event Create rule."],["The document provides access to different versions of `EventCreateRule`, with version 0.70.0 listed as the latest, alongside detailed method documentation and inheritance information."]]],[]]