Class KeyEvent (0.70.0)

publicfinalclassKeyEventextendsGeneratedMessageV3implementsKeyEventOrBuilder

A key event in a Google Analytics property.

Protobuf type google.analytics.admin.v1beta.KeyEvent

Static Fields

COUNTING_METHOD_FIELD_NUMBER

publicstaticfinalintCOUNTING_METHOD_FIELD_NUMBER
Field Value
TypeDescription
int

CREATE_TIME_FIELD_NUMBER

publicstaticfinalintCREATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

CUSTOM_FIELD_NUMBER

publicstaticfinalintCUSTOM_FIELD_NUMBER
Field Value
TypeDescription
int

DEFAULT_VALUE_FIELD_NUMBER

publicstaticfinalintDEFAULT_VALUE_FIELD_NUMBER
Field Value
TypeDescription
int

DELETABLE_FIELD_NUMBER

publicstaticfinalintDELETABLE_FIELD_NUMBER
Field Value
TypeDescription
int

EVENT_NAME_FIELD_NUMBER

publicstaticfinalintEVENT_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

publicstaticfinalintNAME_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

publicstaticKeyEventgetDefaultInstance()
Returns
TypeDescription
KeyEvent

getDescriptor()

publicstaticfinalDescriptors.DescriptorgetDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

publicstaticKeyEvent.BuildernewBuilder()
Returns
TypeDescription
KeyEvent.Builder

newBuilder(KeyEvent prototype)

publicstaticKeyEvent.BuildernewBuilder(KeyEventprototype)
Parameter
NameDescription
prototypeKeyEvent
Returns
TypeDescription
KeyEvent.Builder

parseDelimitedFrom(InputStream input)

publicstaticKeyEventparseDelimitedFrom(InputStreaminput)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
KeyEvent
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticKeyEventparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
KeyEvent
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

publicstaticKeyEventparseFrom(byte[]data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
KeyEvent
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

publicstaticKeyEventparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
KeyEvent
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

publicstaticKeyEventparseFrom(ByteStringdata)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
KeyEvent
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

publicstaticKeyEventparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
KeyEvent
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

publicstaticKeyEventparseFrom(CodedInputStreaminput)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
KeyEvent
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticKeyEventparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
KeyEvent
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

publicstaticKeyEventparseFrom(InputStreaminput)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
KeyEvent
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticKeyEventparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
KeyEvent
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

publicstaticKeyEventparseFrom(ByteBufferdata)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
KeyEvent
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

publicstaticKeyEventparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
KeyEvent
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

publicstaticParser<KeyEvent>parser()
Returns
TypeDescription
Parser<KeyEvent>

Methods

equals(Object obj)

publicbooleanequals(Objectobj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getCountingMethod()

publicKeyEvent.CountingMethodgetCountingMethod()

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
TypeDescription
KeyEvent.CountingMethod

The countingMethod.

getCountingMethodValue()

publicintgetCountingMethodValue()

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
TypeDescription
int

The enum numeric value on the wire for countingMethod.

getCreateTime()

publicTimestampgetCreateTime()

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
TypeDescription
Timestamp

The createTime.

getCreateTimeOrBuilder()

publicTimestampOrBuildergetCreateTimeOrBuilder()

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
TypeDescription
TimestampOrBuilder

getCustom()

publicbooleangetCustom()

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
TypeDescription
boolean

The custom.

getDefaultInstanceForType()

publicKeyEventgetDefaultInstanceForType()
Returns
TypeDescription
KeyEvent

getDefaultValue()

publicKeyEvent.DefaultValuegetDefaultValue()

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
TypeDescription
KeyEvent.DefaultValue

The defaultValue.

getDefaultValueOrBuilder()

publicKeyEvent.DefaultValueOrBuildergetDefaultValueOrBuilder()

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
TypeDescription
KeyEvent.DefaultValueOrBuilder

getDeletable()

publicbooleangetDeletable()

Output only. If set to true, this event can be deleted.

bool deletable = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

The deletable.

getEventName()

publicStringgetEventName()

Immutable. The event name for this key event. Examples: 'click', 'purchase'

string event_name = 2 [(.google.api.field_behavior) = IMMUTABLE];

Returns
TypeDescription
String

The eventName.

getEventNameBytes()

publicByteStringgetEventNameBytes()

Immutable. The event name for this key event. Examples: 'click', 'purchase'

string event_name = 2 [(.google.api.field_behavior) = IMMUTABLE];

Returns
TypeDescription
ByteString

The bytes for eventName.

getName()

publicStringgetName()

Output only. Resource name of this key event. Format: properties/{property}/keyEvents/{key_event}

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
String

The name.

getNameBytes()

publicByteStringgetNameBytes()

Output only. Resource name of this key event. Format: properties/{property}/keyEvents/{key_event}

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
ByteString

The bytes for name.

getParserForType()

publicParser<KeyEvent>getParserForType()
Returns
TypeDescription
Parser<KeyEvent>
Overrides

getSerializedSize()

publicintgetSerializedSize()
Returns
TypeDescription
int
Overrides

hasCreateTime()

publicbooleanhasCreateTime()

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
TypeDescription
boolean

Whether the createTime field is set.

hasDefaultValue()

publicbooleanhasDefaultValue()

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
TypeDescription
boolean

Whether the defaultValue field is set.

hashCode()

publicinthashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

publicfinalbooleanisInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

publicKeyEvent.BuildernewBuilderForType()
Returns
TypeDescription
KeyEvent.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protectedKeyEvent.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
KeyEvent.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protectedObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameterunused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

publicKeyEvent.BuildertoBuilder()
Returns
TypeDescription
KeyEvent.Builder

writeTo(CodedOutputStream output)

publicvoidwriteTo(CodedOutputStreamoutput)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException