You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<pclass="firstline">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.</p>
<pclass="firstline">Writes a single user event from the browser. For larger user event payload over 16 KB, the POST method should be used instead, otherwise a 400 Bad Request error is returned. This method is used only by the Retail API JavaScript pixel and Google Tag Manager. Users should not call this method directly.</p>
<pclass="firstline">Bulk import of User events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. `Operation.response` is of type `ImportResponse`. Note that it is possible for a subset of the items to be successfully inserted. `Operation.metadata` is of type `ImportMetadata`.</p>
<pre>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.
<pre>Writes a single user event from the browser. For larger user event payload over 16 KB, the POST method should be used instead, otherwise a 400 Bad Request error is returned. This method is used only by the Retail API JavaScript pixel and Google Tag Manager. Users should not call this method directly.
104
104
105
105
Args:
106
106
parent: string, Required. The parent catalog name, such as `projects/1234/locations/global/catalogs/default_catalog`. (required)
107
-
ets: string, The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes.
108
-
prebuiltRule: string, The prebuilt rule name that can convert a specific type of raw_json. For example: "ga4_bq" rule for the GA4 user event schema.
109
-
rawJson: string, 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.
110
-
uri: string, 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.
111
-
userEvent: string, Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters.
107
+
body: object, The request body.
108
+
The object takes the form of:
109
+
110
+
{ # Request message for CollectUserEvent method.
111
+
"ets": "A String", # The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes.
112
+
"prebuiltRule": "A String", # The prebuilt rule name that can convert a specific type of raw_json. For example: "ga4_bq" rule for the GA4 user event schema.
113
+
"rawJson": "A String", # 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.
114
+
"uri": "A String", # 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.
115
+
"userEvent": "A String", # Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters.
<pclass="firstline">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.</p>
<pclass="firstline">Writes a single user event from the browser. For larger user event payload over 16 KB, the POST method should be used instead, otherwise a 400 Bad Request error is returned. This method is used only by the Retail API JavaScript pixel and Google Tag Manager. Users should not call this method directly.</p>
<pre>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.
<pre>Writes a single user event from the browser. For larger user event payload over 16 KB, the POST method should be used instead, otherwise a 400 Bad Request error is returned. This method is used only by the Retail API JavaScript pixel and Google Tag Manager. Users should not call this method directly.
107
107
108
108
Args:
109
109
parent: string, Required. The parent catalog name, such as `projects/1234/locations/global/catalogs/default_catalog`. (required)
110
-
ets: string, The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes.
111
-
prebuiltRule: string, The prebuilt rule name that can convert a specific type of raw_json. For example: "ga4_bq" rule for the GA4 user event schema.
112
-
rawJson: string, 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.
113
-
uri: string, 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.
114
-
userEvent: string, Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters.
110
+
body: object, The request body.
111
+
The object takes the form of:
112
+
113
+
{ # Request message for CollectUserEvent method.
114
+
"ets": "A String", # The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes.
115
+
"prebuiltRule": "A String", # The prebuilt rule name that can convert a specific type of raw_json. For example: "ga4_bq" rule for the GA4 user event schema.
116
+
"rawJson": "A String", # 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.
117
+
"uri": "A String", # 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.
118
+
"userEvent": "A String", # Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters.
<pclass="firstline">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.</p>
<pclass="firstline">Writes a single user event from the browser. For larger user event payload over 16 KB, the POST method should be used instead, otherwise a 400 Bad Request error is returned. This method is used only by the Retail API JavaScript pixel and Google Tag Manager. Users should not call this method directly.</p>
<pre>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.
<pre>Writes a single user event from the browser. For larger user event payload over 16 KB, the POST method should be used instead, otherwise a 400 Bad Request error is returned. This method is used only by the Retail API JavaScript pixel and Google Tag Manager. Users should not call this method directly.
107
107
108
108
Args:
109
109
parent: string, Required. The parent catalog name, such as `projects/1234/locations/global/catalogs/default_catalog`. (required)
110
-
ets: string, The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes.
111
-
prebuiltRule: string, The prebuilt rule name that can convert a specific type of raw_json. For example: "ga4_bq" rule for the GA4 user event schema.
112
-
rawJson: string, 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.
113
-
uri: string, 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.
114
-
userEvent: string, Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters.
110
+
body: object, The request body.
111
+
The object takes the form of:
112
+
113
+
{ # Request message for CollectUserEvent method.
114
+
"ets": "A String", # The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes.
115
+
"prebuiltRule": "A String", # The prebuilt rule name that can convert a specific type of raw_json. For example: "ga4_bq" rule for the GA4 user event schema.
116
+
"rawJson": "A String", # 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.
117
+
"uri": "A String", # 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.
118
+
"userEvent": "A String", # Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters.
Copy file name to clipboardExpand all lines: googleapiclient/discovery_cache/documents/retail.v2.json
+34-29Lines changed: 34 additions & 29 deletions
Original file line number
Diff line number
Diff line change
@@ -1930,49 +1930,26 @@
1930
1930
"userEvents": {
1931
1931
"methods": {
1932
1932
"collect": {
1933
-
"description": "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.",
1933
+
"description": "Writes a single user event from the browser. For larger user event payload over 16 KB, the POST method should be used instead, otherwise a 400 Bad Request error is returned. This method is used only by the Retail API JavaScript pixel and Google Tag Manager. Users should not call this method directly.",
"description": "The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes.",
1943
-
"format": "int64",
1944
-
"location": "query",
1945
-
"type": "string"
1946
-
},
1947
1941
"parent": {
1948
1942
"description": "Required. The parent catalog name, such as `projects/1234/locations/global/catalogs/default_catalog`.",
"description": "The prebuilt rule name that can convert a specific type of raw_json. For example: \"ga4_bq\" rule for the GA4 user event schema.",
1956
-
"location": "query",
1957
-
"type": "string"
1958
-
},
1959
-
"rawJson": {
1960
-
"description": "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.",
1961
-
"location": "query",
1962
-
"type": "string"
1963
-
},
1964
-
"uri": {
1965
-
"description": "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.",
1966
-
"location": "query",
1967
-
"type": "string"
1968
-
},
1969
-
"userEvent": {
1970
-
"description": "Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters.",
"description": "The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes.",
2845
+
"format": "int64",
2846
+
"type": "string"
2847
+
},
2848
+
"prebuiltRule": {
2849
+
"description": "The prebuilt rule name that can convert a specific type of raw_json. For example: \"ga4_bq\" rule for the GA4 user event schema.",
2850
+
"type": "string"
2851
+
},
2852
+
"rawJson": {
2853
+
"description": "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.",
2854
+
"type": "string"
2855
+
},
2856
+
"uri": {
2857
+
"description": "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.",
2858
+
"type": "string"
2859
+
},
2860
+
"userEvent": {
2861
+
"description": "Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters.",
2862
+
"type": "string"
2863
+
}
2864
+
},
2865
+
"type": "object"
2866
+
},
2862
2867
"GoogleCloudRetailV2ColorInfo": {
2863
2868
"description": "The color information of a Product.",
0 commit comments