Send feedback Class KeyEvent (0.68.0) Stay organized with collections Save and categorize content based on your preferences.
Version 0.68.0 keyboard_arrow_down
public final class KeyEvent extends GeneratedMessageV3 implements KeyEventOrBuilder A key event in a Google Analytics property.
Protobuf type google.analytics.admin.v1beta.KeyEvent
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 COUNTING_METHOD_FIELD_NUMBER
public static final int COUNTING_METHOD_FIELD_NUMBER Field Value Type Description int
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER Field Value Type Description int
CUSTOM_FIELD_NUMBER
public static final int CUSTOM_FIELD_NUMBER Field Value Type Description int
DEFAULT_VALUE_FIELD_NUMBER
public static final int DEFAULT_VALUE_FIELD_NUMBER Field Value Type Description int
DELETABLE_FIELD_NUMBER
public static final int DELETABLE_FIELD_NUMBER Field Value Type Description int
EVENT_NAME_FIELD_NUMBER
public static final int EVENT_NAME_FIELD_NUMBER Field Value Type Description int
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER Field Value Type Description int
Static Methods getDefaultInstance()
public static KeyEvent getDefaultInstance () getDescriptor()
public static final Descriptors . Descriptor getDescriptor () newBuilder()
public static KeyEvent . Builder newBuilder () newBuilder(KeyEvent )
public static KeyEvent . Builder newBuilder ( KeyEvent )
public static KeyEvent parseDelimitedFrom ( InputStream input )
public static KeyEvent parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry ) parseFrom(byte[] data)
public static KeyEvent parseFrom ( byte [] data ) Parameter Name Description databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static KeyEvent parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry ) parseFrom(ByteString data)
public static KeyEvent parseFrom ( ByteString data ) parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static KeyEvent parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static KeyEvent parseFrom ( CodedInputStream input )
public static KeyEvent parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static KeyEvent parseFrom ( InputStream input )
public static KeyEvent parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry ) parseFrom(ByteBuffer data)
public static KeyEvent parseFrom ( ByteBuffer data ) parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static KeyEvent parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry ) parser()
public static Parser<KeyEvent> parser () Methods equals(Object obj)
public boolean equals ( Object obj ) Parameter Name Description objObject
Overrides getCountingMethod()
public KeyEvent . CountingMethod getCountingMethod () Required. The method by which Key Events will be counted across multiple events within a session.
.google.analytics.admin.v1beta.KeyEvent.CountingMethod counting_method = 6 [(.google.api.field_behavior) = REQUIRED];
getCountingMethodValue()
public int getCountingMethodValue () Required. The method by which Key Events will be counted across multiple events within a session.
.google.analytics.admin.v1beta.KeyEvent.CountingMethod counting_method = 6 [(.google.api.field_behavior) = REQUIRED];
Returns Type Description int The enum numeric value on the wire for countingMethod.
getCreateTime()
public Timestamp getCreateTime () Output only. Time when this key event was created in the property.
.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns Type Description Timestamp The createTime.
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder () Output only. Time when this key event was created in the property.
.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
getCustom()
public boolean getCustom () Output only. If set to true, this key event refers to a custom event. If set to false, this key event refers to a default event in GA. Default events typically have special meaning in GA. Default events are usually created for you by the GA system, but in some cases can be created by property admins. Custom events count towards the maximum number of custom key events that may be created per property.
bool custom = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns Type Description boolean The custom.
getDefaultInstanceForType()
public KeyEvent getDefaultInstanceForType () getDefaultValue()
public KeyEvent . DefaultValue getDefaultValue () Optional. Defines a default value/currency for a key event.
.google.analytics.admin.v1beta.KeyEvent.DefaultValue default_value = 7 [(.google.api.field_behavior) = OPTIONAL];
getDefaultValueOrBuilder()
public KeyEvent . DefaultValueOrBuilder getDefaultValueOrBuilder () Optional. Defines a default value/currency for a key event.
.google.analytics.admin.v1beta.KeyEvent.DefaultValue default_value = 7 [(.google.api.field_behavior) = OPTIONAL];
getDeletable()
public boolean getDeletable () Output only. If set to true, this event can be deleted.
bool deletable = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns Type Description boolean The deletable.
getEventName()
public String getEventName () Immutable. The event name for this key event. Examples: 'click', 'purchase'
string event_name = 2 [(.google.api.field_behavior) = IMMUTABLE];
Returns Type Description String The eventName.
getEventNameBytes()
public ByteString getEventNameBytes () Immutable. The event name for this key event. Examples: 'click', 'purchase'
string event_name = 2 [(.google.api.field_behavior) = IMMUTABLE];
Returns Type Description ByteString The bytes for eventName.
getName() Output only. Resource name of this key event. Format: properties/{property}/keyEvents/{key_event}
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns Type Description String The name.
getNameBytes()
public ByteString getNameBytes () Output only. Resource name of this key event. Format: properties/{property}/keyEvents/{key_event}
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns Type Description ByteString The bytes for name.
getParserForType()
public Parser<KeyEvent> getParserForType () Overrides getSerializedSize()
public int getSerializedSize () Returns Type Description int
Overrides hasCreateTime()
public boolean hasCreateTime () Output only. Time when this key event was created in the property.
.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns Type Description boolean Whether the createTime field is set.
hasDefaultValue()
public boolean hasDefaultValue () Optional. Defines a default value/currency for a key event.
.google.analytics.admin.v1beta.KeyEvent.DefaultValue default_value = 7 [(.google.api.field_behavior) = OPTIONAL];
Returns Type Description boolean Whether the defaultValue field is set.
hashCode() Returns Type Description int
Overrides internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable () Overrides isInitialized()
public final boolean isInitialized () Overrides newBuilderForType()
public KeyEvent . Builder newBuilderForType () newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected KeyEvent . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent ) Overrides newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused ) Overrides toBuilder()
public KeyEvent . 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-06-05 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-06-05 UTC."],[[["This document outlines the `KeyEvent` class, a component of the Google Analytics Admin v1beta API, representing a key event within a Google Analytics property."],["The `KeyEvent` class is a type of Protobuf message (`google.analytics.admin.v1beta.KeyEvent`) that extends `GeneratedMessageV3`, implementing the `KeyEventOrBuilder` interface."],["This class provides several methods for working with instances of the class, and contains detailed information on the static fields, static methods, and methods that are available for manipulating it."],["The document also provides a full list of past versions of the Google analytics admin API, ranging from version 0.70.0 (latest) all the way back to 0.14.0."],["Methods for parsing and interacting with the `KeyEvent` class are detailed, including how to manage its fields, serialization, and deserialization."]]],[]]