Class ConversionEvent (0.51.0)

public final class ConversionEvent extends GeneratedMessageV3 implements ConversionEventOrBuilder

A conversion event in a Google Analytics property.

Protobuf type google.analytics.admin.v1alpha.ConversionEvent

Static Fields

COUNTING_METHOD_FIELD_NUMBER

public static final int COUNTING_METHOD_FIELD_NUMBER
Field Value
TypeDescription
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

CUSTOM_FIELD_NUMBER

public static final int CUSTOM_FIELD_NUMBER
Field Value
TypeDescription
int

DEFAULT_CONVERSION_VALUE_FIELD_NUMBER

public static final int DEFAULT_CONVERSION_VALUE_FIELD_NUMBER
Field Value
TypeDescription
int

DELETABLE_FIELD_NUMBER

public static final int DELETABLE_FIELD_NUMBER
Field Value
TypeDescription
int

EVENT_NAME_FIELD_NUMBER

public static final int EVENT_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static ConversionEvent getDefaultInstance()
Returns
TypeDescription
ConversionEvent

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static ConversionEvent.Builder newBuilder()
Returns
TypeDescription
ConversionEvent.Builder

newBuilder(ConversionEvent prototype)

public static ConversionEvent.Builder newBuilder(ConversionEvent prototype)
Parameter
NameDescription
prototypeConversionEvent
Returns
TypeDescription
ConversionEvent.Builder

parseDelimitedFrom(InputStream input)

public static ConversionEvent parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ConversionEvent
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ConversionEvent parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ConversionEvent
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static ConversionEvent parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
ConversionEvent
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ConversionEvent parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ConversionEvent
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ConversionEvent parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
ConversionEvent
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ConversionEvent parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ConversionEvent
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ConversionEvent parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
ConversionEvent
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ConversionEvent parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ConversionEvent
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static ConversionEvent parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ConversionEvent
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ConversionEvent parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ConversionEvent
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static ConversionEvent parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
ConversionEvent
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ConversionEvent parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ConversionEvent
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<ConversionEvent> parser()
Returns
TypeDescription
Parser<ConversionEvent>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getCountingMethod()

public ConversionEvent.ConversionCountingMethod getCountingMethod()

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

public int getCountingMethodValue()

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

public Timestamp getCreateTime()

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

public TimestampOrBuilder getCreateTimeOrBuilder()

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

public boolean getCustom()

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

public ConversionEvent.DefaultConversionValue getDefaultConversionValue()

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

public ConversionEvent.DefaultConversionValueOrBuilder getDefaultConversionValueOrBuilder()

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

public ConversionEvent getDefaultInstanceForType()
Returns
TypeDescription
ConversionEvent

getDeletable()

public boolean getDeletable()

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

public String getEventName()

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

public ByteString getEventNameBytes()

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

public String getName()

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

public ByteString getNameBytes()

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

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

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hasCreateTime()

public boolean hasCreateTime()

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

public boolean hasDefaultConversionValue()

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

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public ConversionEvent.Builder newBuilderForType()
Returns
TypeDescription
ConversionEvent.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ConversionEvent.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
ConversionEvent.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public ConversionEvent.Builder toBuilder()
Returns
TypeDescription
ConversionEvent.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException