Class ConversionEvent.Builder (0.56.0)

public static final class ConversionEvent.Builder extends GeneratedMessageV3.Builder<ConversionEvent.Builder> implements ConversionEventOrBuilder

A conversion event in a Google Analytics property.

Protobuf type google.analytics.admin.v1alpha.ConversionEvent

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ConversionEvent.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ConversionEvent.Builder
Overrides

build()

public ConversionEvent build()
Returns
Type Description
ConversionEvent

buildPartial()

public ConversionEvent buildPartial()
Returns
Type Description
ConversionEvent

clear()

public ConversionEvent.Builder clear()
Returns
Type Description
ConversionEvent.Builder
Overrides

clearCountingMethod()

public ConversionEvent.Builder clearCountingMethod()

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
Type Description
ConversionEvent.Builder

This builder for chaining.

clearCreateTime()

public ConversionEvent.Builder clearCreateTime()

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
Type Description
ConversionEvent.Builder

clearCustom()

public ConversionEvent.Builder clearCustom()

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
Type Description
ConversionEvent.Builder

This builder for chaining.

clearDefaultConversionValue()

public ConversionEvent.Builder clearDefaultConversionValue()

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
Type Description
ConversionEvent.Builder

clearDeletable()

public ConversionEvent.Builder clearDeletable()

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

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

Returns
Type Description
ConversionEvent.Builder

This builder for chaining.

clearEventName()

public ConversionEvent.Builder clearEventName()

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

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

Returns
Type Description
ConversionEvent.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public ConversionEvent.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
ConversionEvent.Builder
Overrides

clearName()

public ConversionEvent.Builder clearName()

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

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

Returns
Type Description
ConversionEvent.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ConversionEvent.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
ConversionEvent.Builder
Overrides

clone()

public ConversionEvent.Builder clone()
Returns
Type Description
ConversionEvent.Builder
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
Type Description
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
Type Description
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
Type Description
Timestamp

The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

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
Type Description
Builder

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
Type Description
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
Type Description
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
Type Description
ConversionEvent.DefaultConversionValue

The defaultConversionValue.

getDefaultConversionValueBuilder()

public ConversionEvent.DefaultConversionValue.Builder getDefaultConversionValueBuilder()

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
Type Description
ConversionEvent.DefaultConversionValue.Builder

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
Type Description
ConversionEvent.DefaultConversionValueOrBuilder

getDefaultInstanceForType()

public ConversionEvent getDefaultInstanceForType()
Returns
Type Description
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
Type Description
boolean

The deletable.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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
Type Description
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
Type Description
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
Type Description
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
Type Description
ByteString

The bytes for name.

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
Type Description
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
Type Description
boolean

Whether the defaultConversionValue field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCreateTime(Timestamp value)

public ConversionEvent.Builder mergeCreateTime(Timestamp value)

Output only. Time when this conversion event was created in the property.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
ConversionEvent.Builder

mergeDefaultConversionValue(ConversionEvent.DefaultConversionValue value)

public ConversionEvent.Builder mergeDefaultConversionValue(ConversionEvent.DefaultConversionValue value)

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];

Parameter
Name Description
value ConversionEvent.DefaultConversionValue
Returns
Type Description
ConversionEvent.Builder

mergeFrom(ConversionEvent other)

public ConversionEvent.Builder mergeFrom(ConversionEvent other)
Parameter
Name Description
other ConversionEvent
Returns
Type Description
ConversionEvent.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ConversionEvent.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ConversionEvent.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ConversionEvent.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ConversionEvent.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ConversionEvent.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ConversionEvent.Builder
Overrides

setCountingMethod(ConversionEvent.ConversionCountingMethod value)

public ConversionEvent.Builder setCountingMethod(ConversionEvent.ConversionCountingMethod value)

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];

Parameter
Name Description
value ConversionEvent.ConversionCountingMethod

The countingMethod to set.

Returns
Type Description
ConversionEvent.Builder

This builder for chaining.

setCountingMethodValue(int value)

public ConversionEvent.Builder setCountingMethodValue(int value)

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];

Parameter
Name Description
value int

The enum numeric value on the wire for countingMethod to set.

Returns
Type Description
ConversionEvent.Builder

This builder for chaining.

setCreateTime(Timestamp value)

public ConversionEvent.Builder setCreateTime(Timestamp value)

Output only. Time when this conversion event was created in the property.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
ConversionEvent.Builder

setCreateTime(Timestamp.Builder builderForValue)

public ConversionEvent.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. Time when this conversion event was created in the property.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
ConversionEvent.Builder

setCustom(boolean value)

public ConversionEvent.Builder setCustom(boolean value)

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];

Parameter
Name Description
value boolean

The custom to set.

Returns
Type Description
ConversionEvent.Builder

This builder for chaining.

setDefaultConversionValue(ConversionEvent.DefaultConversionValue value)

public ConversionEvent.Builder setDefaultConversionValue(ConversionEvent.DefaultConversionValue value)

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];

Parameter
Name Description
value ConversionEvent.DefaultConversionValue
Returns
Type Description
ConversionEvent.Builder

setDefaultConversionValue(ConversionEvent.DefaultConversionValue.Builder builderForValue)

public ConversionEvent.Builder setDefaultConversionValue(ConversionEvent.DefaultConversionValue.Builder builderForValue)

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];

Parameter
Name Description
builderForValue ConversionEvent.DefaultConversionValue.Builder
Returns
Type Description
ConversionEvent.Builder

setDeletable(boolean value)

public ConversionEvent.Builder setDeletable(boolean value)

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

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

Parameter
Name Description
value boolean

The deletable to set.

Returns
Type Description
ConversionEvent.Builder

This builder for chaining.

setEventName(String value)

public ConversionEvent.Builder setEventName(String value)

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

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

Parameter
Name Description
value String

The eventName to set.

Returns
Type Description
ConversionEvent.Builder

This builder for chaining.

setEventNameBytes(ByteString value)

public ConversionEvent.Builder setEventNameBytes(ByteString value)

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

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

Parameter
Name Description
value ByteString

The bytes for eventName to set.

Returns
Type Description
ConversionEvent.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public ConversionEvent.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ConversionEvent.Builder
Overrides

setName(String value)

public ConversionEvent.Builder setName(String value)

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

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

Parameter
Name Description
value String

The name to set.

Returns
Type Description
ConversionEvent.Builder

This builder for chaining.

setNameBytes(ByteString value)

public ConversionEvent.Builder setNameBytes(ByteString value)

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

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

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
ConversionEvent.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ConversionEvent.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
ConversionEvent.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final ConversionEvent.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ConversionEvent.Builder
Overrides