Class ProjectsResource.LocationsResource.CatalogsResource.UserEventsResource.CollectRequest

Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a 3rd party domain. This method is used only by the Retail API JavaScript pixel and Google Tag Manager. Users should not call this method directly.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<GoogleApiHttpBody>
CloudRetailBaseServiceRequest<GoogleApiHttpBody>
ProjectsResource.LocationsResource.CatalogsResource.UserEventsResource.CollectRequest
Implements
Inherited Members
Namespace: Google.Apis.CloudRetail.v2
Assembly: Google.Apis.CloudRetail.v2.dll
Syntax
public class ProjectsResource.LocationsResource.CatalogsResource.UserEventsResource.CollectRequest : CloudRetailBaseServiceRequest<GoogleApiHttpBody>, IClientServiceRequest<GoogleApiHttpBody>, IClientServiceRequest

Constructors

CollectRequest(IClientService, string)

Constructs a new Collect request.

Declaration
public CollectRequest(IClientService service, string parent)
Parameters
Type Name Description
IClientService service
string parent

Properties

Ets

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

Declaration
[RequestParameter("ets", RequestParameterType.Query)]
public virtual long? Ets { get; set; }
Property Value
Type Description
long?

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
string
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.CloudRetail.v2.Data.GoogleApiHttpBody>.HttpMethod

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
string
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.CloudRetail.v2.Data.GoogleApiHttpBody>.MethodName

Parent

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

Declaration
[RequestParameter("parent", RequestParameterType.Path)]
public virtual string Parent { get; }
Property Value
Type Description
string

PrebuiltRule

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

Declaration
[RequestParameter("prebuiltRule", RequestParameterType.Query)]
public virtual string PrebuiltRule { get; set; }
Property Value
Type Description
string

RawJson

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.

Declaration
[RequestParameter("rawJson", RequestParameterType.Query)]
public virtual string RawJson { get; set; }
Property Value
Type Description
string

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
string
Overrides
Google.Apis.Requests.ClientServiceRequest<Google.Apis.CloudRetail.v2.Data.GoogleApiHttpBody>.RestPath

Uri

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.

Declaration
[RequestParameter("uri", RequestParameterType.Query)]
public virtual string Uri { get; set; }
Property Value
Type Description
string

UserEvent

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

Declaration
[RequestParameter("userEvent", RequestParameterType.Query)]
public virtual string UserEvent { get; set; }
Property Value
Type Description
string

Methods

InitParameters()

Initializes Collect parameter list.

Declaration
protected override void InitParameters()
Overrides

Implements