Interface ConversionEventOrBuilder (0.51.0)

public interface ConversionEventOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getCountingMethod()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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

getDeletable()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.

hasCreateTime()

public abstract 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 abstract 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.