Interface CollectUserEventRequestOrBuilder (2.56.0)

public interface CollectUserEventRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getConversionRuleCase()

public abstract CollectUserEventRequest.ConversionRuleCase getConversionRuleCase()
Returns
Type Description
CollectUserEventRequest.ConversionRuleCase

getEts()

public abstract 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
Type Description
long

The ets.

getParent()

public abstract 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
Type Description
String

The parent.

getParentBytes()

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

The bytes for parent.

getPrebuiltRule()

public abstract 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
Type Description
String

The prebuiltRule.

getPrebuiltRuleBytes()

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

The bytes for prebuiltRule.

getRawJson()

public abstract 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
Type Description
String

The rawJson.

getRawJsonBytes()

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

The bytes for rawJson.

getUri()

public abstract 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
Type Description
String

The uri.

getUriBytes()

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

The bytes for uri.

getUserEvent()

public abstract 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
Type Description
String

The userEvent.

getUserEventBytes()

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

The bytes for userEvent.

hasPrebuiltRule()

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

Whether the prebuiltRule field is set.