Class ConversionEvent (0.70.0)

publicfinalclassConversionEventextendsGeneratedMessageV3implementsConversionEventOrBuilder

A conversion event in a Google Analytics property.

Protobuf type google.analytics.admin.v1alpha.ConversionEvent

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_CONVERSION_VALUE_FIELD_NUMBER

publicstaticfinalintDEFAULT_CONVERSION_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()

publicstaticConversionEventgetDefaultInstance()
Returns
TypeDescription
ConversionEvent

getDescriptor()

publicstaticfinalDescriptors.DescriptorgetDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

publicstaticConversionEvent.BuildernewBuilder()
Returns
TypeDescription
ConversionEvent.Builder

newBuilder(ConversionEvent prototype)

publicstaticConversionEvent.BuildernewBuilder(ConversionEventprototype)
Parameter
NameDescription
prototypeConversionEvent
Returns
TypeDescription
ConversionEvent.Builder

parseDelimitedFrom(InputStream input)

publicstaticConversionEventparseDelimitedFrom(InputStreaminput)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ConversionEvent
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticConversionEventparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ConversionEvent
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

publicstaticConversionEventparseFrom(byte[]data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
ConversionEvent
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

publicstaticConversionEventparseFrom(ByteStringdata)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
ConversionEvent
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

publicstaticConversionEventparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ConversionEvent
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

publicstaticConversionEventparseFrom(CodedInputStreaminput)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
ConversionEvent
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticConversionEventparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ConversionEvent
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

publicstaticConversionEventparseFrom(InputStreaminput)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ConversionEvent
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticConversionEventparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ConversionEvent
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

publicstaticConversionEventparseFrom(ByteBufferdata)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
ConversionEvent
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

publicstaticConversionEventparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ConversionEvent
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

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

Methods

equals(Object obj)

publicbooleanequals(Objectobj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getCountingMethod()

publicConversionEvent.ConversionCountingMethodgetCountingMethod()

Optional. The method by which conversions will be counted across multiple events within a session. If this value is not provided, it will be set to ONCE_PER_EVENT.

.google.analytics.admin.v1alpha.ConversionEvent.ConversionCountingMethod counting_method = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ConversionEvent.ConversionCountingMethod

The countingMethod.

getCountingMethodValue()

publicintgetCountingMethodValue()

Optional. The method by which conversions will be counted across multiple events within a session. If this value is not provided, it will be set to ONCE_PER_EVENT.

.google.analytics.admin.v1alpha.ConversionEvent.ConversionCountingMethod counting_method = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
int

The enum numeric value on the wire for countingMethod.

getCreateTime()

publicTimestampgetCreateTime()

Output only. Time when this conversion 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 conversion 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 conversion event refers to a custom event. If set to false, this conversion 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 conversion events that may be created per property.

bool custom = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

The custom.

getDefaultConversionValue()

publicConversionEvent.DefaultConversionValuegetDefaultConversionValue()

Optional. Defines a default value/currency for a conversion event.

optional .google.analytics.admin.v1alpha.ConversionEvent.DefaultConversionValue default_conversion_value = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ConversionEvent.DefaultConversionValue

The defaultConversionValue.

getDefaultConversionValueOrBuilder()

publicConversionEvent.DefaultConversionValueOrBuildergetDefaultConversionValueOrBuilder()

Optional. Defines a default value/currency for a conversion event.

optional .google.analytics.admin.v1alpha.ConversionEvent.DefaultConversionValue default_conversion_value = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ConversionEvent.DefaultConversionValueOrBuilder

getDefaultInstanceForType()

publicConversionEventgetDefaultInstanceForType()
Returns
TypeDescription
ConversionEvent

getDeletable()

publicbooleangetDeletable()

Output only. If set, this event can currently be deleted with DeleteConversionEvent.

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

Returns
TypeDescription
boolean

The deletable.

getEventName()

publicStringgetEventName()

Immutable. The event name for this conversion 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 conversion 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 conversion event. Format: properties/{property}/conversionEvents/{conversion_event}

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

Returns
TypeDescription
String

The name.

getNameBytes()

publicByteStringgetNameBytes()

Output only. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event}

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

Returns
TypeDescription
ByteString

The bytes for name.

getParserForType()

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

getSerializedSize()

publicintgetSerializedSize()
Returns
TypeDescription
int
Overrides

hasCreateTime()

publicbooleanhasCreateTime()

Output only. Time when this conversion 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.

hasDefaultConversionValue()

publicbooleanhasDefaultConversionValue()

Optional. Defines a default value/currency for a conversion event.

optional .google.analytics.admin.v1alpha.ConversionEvent.DefaultConversionValue default_conversion_value = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
boolean

Whether the defaultConversionValue field is set.

hashCode()

publicinthashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

publicfinalbooleanisInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

publicConversionEvent.BuildernewBuilderForType()
Returns
TypeDescription
ConversionEvent.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protectedConversionEvent.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
ConversionEvent.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

publicConversionEvent.BuildertoBuilder()
Returns
TypeDescription
ConversionEvent.Builder

writeTo(CodedOutputStream output)

publicvoidwriteTo(CodedOutputStreamoutput)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException