com.google.cloud.retail.v2

Interface CollectUserEventRequestOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

CollectUserEventRequest, CollectUserEventRequest.Builder

public interface CollectUserEventRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
CollectUserEventRequest.ConversionRuleCase	getConversionRuleCase()
long	getEts() The event timestamp in milliseconds.
String	getParent() Required.
com.google.protobuf.ByteString	getParentBytes() Required.
String	getPrebuiltRule() The prebuilt rule name that can convert a specific type of raw_json.
com.google.protobuf.ByteString	getPrebuiltRuleBytes() The prebuilt rule name that can convert a specific type of raw_json.
String	getRawJson() An arbitrary serialized JSON string that contains necessary information that can comprise a user event.
com.google.protobuf.ByteString	getRawJsonBytes() An arbitrary serialized JSON string that contains necessary information that can comprise a user event.
String	getUri() The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters.
com.google.protobuf.ByteString	getUriBytes() The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters.
String	getUserEvent() Required.
com.google.protobuf.ByteString	getUserEventBytes() Required.
boolean	hasPrebuiltRule() The prebuilt rule name that can convert a specific type of raw_json.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

hasPrebuiltRule

boolean hasPrebuiltRule()

 The prebuilt rule name that can convert a specific type of raw_json.
 For example: "ga4_bq" rule for the GA4 user event schema.
 

string prebuilt_rule = 6;

Returns:

Whether the prebuiltRule field is set.

getPrebuiltRule

String getPrebuiltRule()

 The prebuilt rule name that can convert a specific type of raw_json.
 For example: "ga4_bq" rule for the GA4 user event schema.
 

string prebuilt_rule = 6;

Returns:

The prebuiltRule.

getPrebuiltRuleBytes

com.google.protobuf.ByteString getPrebuiltRuleBytes()

 The prebuilt rule name that can convert a specific type of raw_json.
 For example: "ga4_bq" rule for the GA4 user event schema.
 

string prebuilt_rule = 6;

Returns:

The bytes for prebuiltRule.

getParent

String getParent()

 Required. The parent catalog name, such as
 `projects/1234/locations/global/catalogs/default_catalog`.
 

string parent = 1 [(.google.api.field_behavior) = REQUIRED];

Returns:

The parent.

getParentBytes

com.google.protobuf.ByteString getParentBytes()

 Required. The parent catalog name, such as
 `projects/1234/locations/global/catalogs/default_catalog`.
 

string parent = 1 [(.google.api.field_behavior) = REQUIRED];

Returns:

The bytes for parent.

getUserEvent

String getUserEvent()

 Required. URL encoded UserEvent proto with a length limit of 2,000,000
 characters.
 

string user_event = 2 [(.google.api.field_behavior) = REQUIRED];

Returns:

The userEvent.

getUserEventBytes

com.google.protobuf.ByteString getUserEventBytes()

 Required. URL encoded UserEvent proto with a length limit of 2,000,000
 characters.
 

string user_event = 2 [(.google.api.field_behavior) = REQUIRED];

Returns:

The bytes for userEvent.

getUri

String getUri()

 The URL including cgi-parameters but excluding the hash fragment with a
 length limit of 5,000 characters. This is often more useful than the
 referer URL, because many browsers only send the domain for 3rd party
 requests.
 

string uri = 3;

Returns:

The uri.

getUriBytes

com.google.protobuf.ByteString getUriBytes()

 The URL including cgi-parameters but excluding the hash fragment with a
 length limit of 5,000 characters. This is often more useful than the
 referer URL, because many browsers only send the domain for 3rd party
 requests.
 

string uri = 3;

Returns:

The bytes for uri.

getEts

long getEts()

 The event timestamp in milliseconds. This prevents browser caching of
 otherwise identical get requests. The name is abbreviated to reduce the
 payload bytes.
 

int64 ets = 4;

Returns:

The ets.

getRawJson

String getRawJson()

 An arbitrary serialized JSON string that contains necessary information
 that can comprise a user event. When this field is specified, the
 user_event field will be ignored. Note: line-delimited JSON is not
 supported, a single JSON only.
 

string raw_json = 5;

Returns:

The rawJson.

getRawJsonBytes

com.google.protobuf.ByteString getRawJsonBytes()

 An arbitrary serialized JSON string that contains necessary information
 that can comprise a user event. When this field is specified, the
 user_event field will be ignored. Note: line-delimited JSON is not
 supported, a single JSON only.
 

string raw_json = 5;

Returns:

The bytes for rawJson.

getConversionRuleCase

CollectUserEventRequest.ConversionRuleCase getConversionRuleCase()