Retail v2 API - Class CollectUserEventRequest (2.6.0)

public sealed class CollectUserEventRequest : IMessage<CollectUserEventRequest>, IEquatable<CollectUserEventRequest>, IDeepCloneable<CollectUserEventRequest>, IBufferMessage, IMessage

Reference documentation and code samples for the Retail v2 API class CollectUserEventRequest.

Request message for CollectUserEvent method.

Inheritance

object > CollectUserEventRequest

Namespace

Google.Cloud.Retail.V2

Assembly

Google.Cloud.Retail.V2.dll

Constructors

CollectUserEventRequest()

public CollectUserEventRequest()

CollectUserEventRequest(CollectUserEventRequest)

public CollectUserEventRequest(CollectUserEventRequest other)
Parameter
NameDescription
otherCollectUserEventRequest

Properties

ConversionRuleCase

public CollectUserEventRequest.ConversionRuleOneofCase ConversionRuleCase { get; }
Property Value
TypeDescription
CollectUserEventRequestConversionRuleOneofCase

Ets

public long Ets { get; set; }

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

Property Value
TypeDescription
long

HasPrebuiltRule

public bool HasPrebuiltRule { get; }

Gets whether the "prebuilt_rule" field is set

Property Value
TypeDescription
bool

Parent

public string Parent { get; set; }

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

Property Value
TypeDescription
string

PrebuiltRule

public string PrebuiltRule { get; set; }

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

Property Value
TypeDescription
string

RawJson

public string RawJson { get; set; }

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.

Property Value
TypeDescription
string

Uri

public string Uri { get; set; }

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.

Property Value
TypeDescription
string

UserEvent

public string UserEvent { get; set; }

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

Property Value
TypeDescription
string