Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit 566f33e

Browse files
yoshi-automationyoshi-automation
committedOct 25, 2022
feat(retail): update the api
#### retail:v2alpha The following keys were deleted: - schemas.GoogleCloudRetailLoggingImportErrorContext.properties.inventoryActivity.type (Total Keys: 1) - schemas.GoogleCloudRetailLoggingImportErrorContext.properties.order.type (Total Keys: 1) - schemas.GoogleCloudRetailLoggingImportErrorContext.properties.place (Total Keys: 4) The following keys were added: - resources.projects.resources.locations.resources.catalogs.resources.userEvents.methods.collect.parameters.prebuiltRule (Total Keys: 2) - resources.projects.resources.locations.resources.catalogs.resources.userEvents.methods.collect.parameters.rawJson (Total Keys: 2) - schemas.GoogleCloudRetailV2alphaGcsOutputResult (Total Keys: 3) - schemas.GoogleCloudRetailV2alphaOutputResult.properties.gcsResult (Total Keys: 2) - schemas.GoogleCloudRetailV2betaOutputResult.properties.gcsResult (Total Keys: 2) #### retail:v2beta The following keys were deleted: - schemas.GoogleCloudRetailLoggingImportErrorContext.properties.inventoryActivity.type (Total Keys: 1) - schemas.GoogleCloudRetailLoggingImportErrorContext.properties.order.type (Total Keys: 1) - schemas.GoogleCloudRetailLoggingImportErrorContext.properties.place (Total Keys: 4) The following keys were added: - resources.projects.resources.locations.resources.catalogs.resources.userEvents.methods.collect.parameters.prebuiltRule (Total Keys: 2) - resources.projects.resources.locations.resources.catalogs.resources.userEvents.methods.collect.parameters.rawJson (Total Keys: 2) - schemas.GoogleCloudRetailV2alphaGcsOutputResult (Total Keys: 3) - schemas.GoogleCloudRetailV2alphaOutputResult.properties.gcsResult (Total Keys: 2) - schemas.GoogleCloudRetailV2betaOutputResult.properties.gcsResult (Total Keys: 2)
1 parent 0b9b8fa commit 566f33e

6 files changed

+116
-68
lines changed
 

‎docs/dyn/retail_v2alpha.projects.locations.catalogs.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,7 @@ <h3>Method Details</h3>
165165
Args:
166166
catalog: string, Required. Catalog for which the completion is performed. Full resource name of catalog, such as `projects/*/locations/global/catalogs/default_catalog`. (required)
167167
dataset: string, Determines which dataset to use for fetching completion. &quot;user-data&quot; will use the imported dataset through CompletionService.ImportCompletionData. &quot;cloud-retail&quot; will use the dataset generated by cloud retail based on user events. If leave empty, it will use the &quot;user-data&quot;. Current supported values: * user-data * cloud-retail: This option requires enabling auto-learning function first. See [guidelines](https://cloud.google.com/retail/docs/completion-overview#generated-completion-dataset).
168-
deviceType: string, The device type context for completion suggestions. It is useful to apply different suggestions on different device types, e.g. `DESKTOP`, `MOBILE`. If it is empty, the suggestions are across all device types. Supported formats: * `UNKNOWN_DEVICE_TYPE` * `DESKTOP` * `MOBILE` * A customized string starts with `OTHER_`, e.g. `OTHER_IPHONE`.
168+
deviceType: string, The device type context for completion suggestions. We recommend that you leave this field empty. It can apply different suggestions on different device types, e.g. `DESKTOP`, `MOBILE`. If it is empty, the suggestions are across all device types. Supported formats: * `UNKNOWN_DEVICE_TYPE` * `DESKTOP` * `MOBILE` * A customized string starts with `OTHER_`, e.g. `OTHER_IPHONE`.
169169
languageCodes: string, Note that this field applies for `user-data` dataset only. For requests with `cloud-retail` dataset, setting this field has no effect. The language filters applied to the output suggestions. If set, it should contain the language of the query. If not set, suggestions are returned without considering language restrictions. This is the BCP-47 language code, such as &quot;en-US&quot; or &quot;sr-Latn&quot;. For more information, see [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47). The maximum number of language codes is 3. (repeated)
170170
maxSuggestions: integer, Completion max suggestions. If left unset or set to 0, then will fallback to the configured value CompletionConfig.max_suggestions. The maximum allowed max suggestions is 20. If it is set higher, it will be capped by 20.
171171
query: string, Required. The query used to generate suggestions. The maximum number of allowed characters is 255.

‎docs/dyn/retail_v2alpha.projects.locations.catalogs.userEvents.html

+4-2
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ <h2>Instance Methods</h2>
7878
<code><a href="#close">close()</a></code></p>
7979
<p class="firstline">Close httplib2 connections.</p>
8080
<p class="toc_element">
81-
<code><a href="#collect">collect(parent, ets=None, uri=None, userEvent=None, x__xgafv=None)</a></code></p>
81+
<code><a href="#collect">collect(parent, ets=None, prebuiltRule=None, rawJson=None, uri=None, userEvent=None, x__xgafv=None)</a></code></p>
8282
<p class="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>
8383
<p class="toc_element">
8484
<code><a href="#import_">import_(parent, body=None, x__xgafv=None)</a></code></p>
@@ -99,12 +99,14 @@ <h3>Method Details</h3>
9999
</div>
100100

101101
<div class="method">
102-
<code class="details" id="collect">collect(parent, ets=None, uri=None, userEvent=None, x__xgafv=None)</code>
102+
<code class="details" id="collect">collect(parent, ets=None, prebuiltRule=None, rawJson=None, uri=None, userEvent=None, x__xgafv=None)</code>
103103
<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.
104104

105105
Args:
106106
parent: string, Required. The parent catalog name, such as `projects/1234/locations/global/catalogs/default_catalog`. (required)
107107
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: &quot;default_schema/v1.0&quot;
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.
108110
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.
109111
userEvent: string, Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters.
110112
x__xgafv: string, V1 error format.

‎docs/dyn/retail_v2beta.projects.locations.catalogs.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,7 @@ <h3>Method Details</h3>
165165
Args:
166166
catalog: string, Required. Catalog for which the completion is performed. Full resource name of catalog, such as `projects/*/locations/global/catalogs/default_catalog`. (required)
167167
dataset: string, Determines which dataset to use for fetching completion. &quot;user-data&quot; will use the imported dataset through CompletionService.ImportCompletionData. &quot;cloud-retail&quot; will use the dataset generated by cloud retail based on user events. If leave empty, it will use the &quot;user-data&quot;. Current supported values: * user-data * cloud-retail: This option requires enabling auto-learning function first. See [guidelines](https://cloud.google.com/retail/docs/completion-overview#generated-completion-dataset).
168-
deviceType: string, The device type context for completion suggestions. It is useful to apply different suggestions on different device types, e.g. `DESKTOP`, `MOBILE`. If it is empty, the suggestions are across all device types. Supported formats: * `UNKNOWN_DEVICE_TYPE` * `DESKTOP` * `MOBILE` * A customized string starts with `OTHER_`, e.g. `OTHER_IPHONE`.
168+
deviceType: string, The device type context for completion suggestions. We recommend that you leave this field empty. It can apply different suggestions on different device types, e.g. `DESKTOP`, `MOBILE`. If it is empty, the suggestions are across all device types. Supported formats: * `UNKNOWN_DEVICE_TYPE` * `DESKTOP` * `MOBILE` * A customized string starts with `OTHER_`, e.g. `OTHER_IPHONE`.
169169
languageCodes: string, Note that this field applies for `user-data` dataset only. For requests with `cloud-retail` dataset, setting this field has no effect. The language filters applied to the output suggestions. If set, it should contain the language of the query. If not set, suggestions are returned without considering language restrictions. This is the BCP-47 language code, such as &quot;en-US&quot; or &quot;sr-Latn&quot;. For more information, see [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47). The maximum number of language codes is 3. (repeated)
170170
maxSuggestions: integer, Completion max suggestions. If left unset or set to 0, then will fallback to the configured value CompletionConfig.max_suggestions. The maximum allowed max suggestions is 20. If it is set higher, it will be capped by 20.
171171
query: string, Required. The query used to generate suggestions. The maximum number of allowed characters is 255.

‎docs/dyn/retail_v2beta.projects.locations.catalogs.userEvents.html

+4-2
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ <h2>Instance Methods</h2>
7878
<code><a href="#close">close()</a></code></p>
7979
<p class="firstline">Close httplib2 connections.</p>
8080
<p class="toc_element">
81-
<code><a href="#collect">collect(parent, ets=None, uri=None, userEvent=None, x__xgafv=None)</a></code></p>
81+
<code><a href="#collect">collect(parent, ets=None, prebuiltRule=None, rawJson=None, uri=None, userEvent=None, x__xgafv=None)</a></code></p>
8282
<p class="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>
8383
<p class="toc_element">
8484
<code><a href="#import_">import_(parent, body=None, x__xgafv=None)</a></code></p>
@@ -99,12 +99,14 @@ <h3>Method Details</h3>
9999
</div>
100100

101101
<div class="method">
102-
<code class="details" id="collect">collect(parent, ets=None, uri=None, userEvent=None, x__xgafv=None)</code>
102+
<code class="details" id="collect">collect(parent, ets=None, prebuiltRule=None, rawJson=None, uri=None, userEvent=None, x__xgafv=None)</code>
103103
<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.
104104

105105
Args:
106106
parent: string, Required. The parent catalog name, such as `projects/1234/locations/global/catalogs/default_catalog`. (required)
107107
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: &quot;default_schema/v1.0&quot;
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.
108110
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.
109111
userEvent: string, Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters.
110112
x__xgafv: string, V1 error format.

‎googleapiclient/discovery_cache/documents/retail.v2alpha.json

+53-31
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@
133133
"type": "string"
134134
},
135135
"deviceType": {
136-
"description": "The device type context for completion suggestions. It is useful to apply different suggestions on different device types, e.g. `DESKTOP`, `MOBILE`. If it is empty, the suggestions are across all device types. Supported formats: * `UNKNOWN_DEVICE_TYPE` * `DESKTOP` * `MOBILE` * A customized string starts with `OTHER_`, e.g. `OTHER_IPHONE`.",
136+
"description": "The device type context for completion suggestions. We recommend that you leave this field empty. It can apply different suggestions on different device types, e.g. `DESKTOP`, `MOBILE`. If it is empty, the suggestions are across all device types. Supported formats: * `UNKNOWN_DEVICE_TYPE` * `DESKTOP` * `MOBILE` * A customized string starts with `OTHER_`, e.g. `OTHER_IPHONE`.",
137137
"location": "query",
138138
"type": "string"
139139
},
@@ -1800,6 +1800,16 @@
18001800
"required": true,
18011801
"type": "string"
18021802
},
1803+
"prebuiltRule": {
1804+
"description": "The prebuilt rule name that can convert a specific type of raw_json. For example: \"default_schema/v1.0\"",
1805+
"location": "query",
1806+
"type": "string"
1807+
},
1808+
"rawJson": {
1809+
"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.",
1810+
"location": "query",
1811+
"type": "string"
1812+
},
18031813
"uri": {
18041814
"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.",
18051815
"location": "query",
@@ -2080,7 +2090,7 @@
20802090
}
20812091
}
20822092
},
2083-
"revision": "20220922",
2093+
"revision": "20221014",
20842094
"rootUrl": "https://retail.googleapis.com/",
20852095
"schemas": {
20862096
"GoogleApiHttpBody": {
@@ -2181,7 +2191,7 @@
21812191
"type": "object"
21822192
},
21832193
"GoogleCloudRetailLoggingImportErrorContext": {
2184-
"description": "The error payload that is populated on LRO import APIs. Including: \"google.cloud.retail.v2.ProductService.ImportProducts\" \"google.cloud.retail.v2.EventService.ImportUserEvents\"",
2194+
"description": "The error payload that is populated on LRO import APIs, including \"google.cloud.retail.v2.ProductService.ImportProducts\" and \"google.cloud.retail.v2.EventService.ImportUserEvents\".",
21852195
"id": "GoogleCloudRetailLoggingImportErrorContext",
21862196
"properties": {
21872197
"catalogItem": {
@@ -2192,10 +2202,6 @@
21922202
"description": "Cloud Storage file path of the import source. Can be set for batch operation error.",
21932203
"type": "string"
21942204
},
2195-
"inventoryActivity": {
2196-
"description": "The detailed content which caused the error on importing an inventory activity. http://cs/google3/google/cloud/retail/v2main/inventory_activity.proto",
2197-
"type": "string"
2198-
},
21992205
"lineNumber": {
22002206
"description": "Line number of the content in file. Should be empty for permission or batch operation error.",
22012207
"type": "string"
@@ -2204,26 +2210,6 @@
22042210
"description": "The operation resource name of the LRO.",
22052211
"type": "string"
22062212
},
2207-
"order": {
2208-
"description": "The detailed content which caused the error on importing an order. http://cs/google3/google/cloud/retail/v2main/order.proto",
2209-
"type": "string"
2210-
},
2211-
"place": {
2212-
"description": "The detailed content which caused the error on importing a place. http://cs/google3/google/cloud/retail/v2main/place.proto",
2213-
"type": "string"
2214-
},
2215-
"placeAsset": {
2216-
"description": "The detailed content which caused the error on importing a place asset. http://cs/google3/google/cloud/retail/v2main/place_asset.proto",
2217-
"type": "string"
2218-
},
2219-
"placeProductPrice": {
2220-
"description": "The detailed content which caused the error on importing a place product price. http://cs/google3/google/cloud/retail/v2main/place_product_price.proto",
2221-
"type": "string"
2222-
},
2223-
"placeProductSettings": {
2224-
"description": "The detailed content which caused the error on importing a place product settings. http://cs/google3/google/cloud/retail/v2main/place_product_settings.proto",
2225-
"type": "string"
2226-
},
22272213
"product": {
22282214
"description": "The detailed content which caused the error on importing a product.",
22292215
"type": "string"
@@ -3244,6 +3230,17 @@
32443230
},
32453231
"type": "object"
32463232
},
3233+
"GoogleCloudRetailV2alphaGcsOutputResult": {
3234+
"description": "A Gcs output result.",
3235+
"id": "GoogleCloudRetailV2alphaGcsOutputResult",
3236+
"properties": {
3237+
"outputUri": {
3238+
"description": "The uri of Gcs output",
3239+
"type": "string"
3240+
}
3241+
},
3242+
"type": "object"
3243+
},
32473244
"GoogleCloudRetailV2alphaGcsSource": {
32483245
"description": "Google Cloud Storage location for input content.",
32493246
"id": "GoogleCloudRetailV2alphaGcsSource",
@@ -3920,15 +3917,22 @@
39203917
"type": "object"
39213918
},
39223919
"GoogleCloudRetailV2alphaOutputResult": {
3923-
"description": "Output result.",
3920+
"description": "Output result that stores the information about where the exported data is stored.",
39243921
"id": "GoogleCloudRetailV2alphaOutputResult",
39253922
"properties": {
39263923
"bigqueryResult": {
3927-
"description": "Export result in BigQuery.",
3924+
"description": "The BigQuery location where the result is stored.",
39283925
"items": {
39293926
"$ref": "GoogleCloudRetailV2alphaBigQueryOutputResult"
39303927
},
39313928
"type": "array"
3929+
},
3930+
"gcsResult": {
3931+
"description": "The Google Cloud Storage location where the result is stored.",
3932+
"items": {
3933+
"$ref": "GoogleCloudRetailV2alphaGcsOutputResult"
3934+
},
3935+
"type": "array"
39323936
}
39333937
},
39343938
"type": "object"
@@ -5899,6 +5903,17 @@
58995903
},
59005904
"type": "object"
59015905
},
5906+
"GoogleCloudRetailV2betaGcsOutputResult": {
5907+
"description": "A Gcs output result.",
5908+
"id": "GoogleCloudRetailV2betaGcsOutputResult",
5909+
"properties": {
5910+
"outputUri": {
5911+
"description": "The uri of Gcs output",
5912+
"type": "string"
5913+
}
5914+
},
5915+
"type": "object"
5916+
},
59025917
"GoogleCloudRetailV2betaImportCompletionDataResponse": {
59035918
"description": "Response of the ImportCompletionDataRequest. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful.",
59045919
"id": "GoogleCloudRetailV2betaImportCompletionDataResponse",
@@ -6144,15 +6159,22 @@
61446159
"type": "object"
61456160
},
61466161
"GoogleCloudRetailV2betaOutputResult": {
6147-
"description": "Output result.",
6162+
"description": "Output result that stores the information about where the exported data is stored.",
61486163
"id": "GoogleCloudRetailV2betaOutputResult",
61496164
"properties": {
61506165
"bigqueryResult": {
6151-
"description": "Export result in BigQuery.",
6166+
"description": "The BigQuery location where the result is stored.",
61526167
"items": {
61536168
"$ref": "GoogleCloudRetailV2betaBigQueryOutputResult"
61546169
},
61556170
"type": "array"
6171+
},
6172+
"gcsResult": {
6173+
"description": "The Google Cloud Storage location where the result is stored.",
6174+
"items": {
6175+
"$ref": "GoogleCloudRetailV2betaGcsOutputResult"
6176+
},
6177+
"type": "array"
61566178
}
61576179
},
61586180
"type": "object"

0 commit comments

Comments
 (0)
Please sign in to comment.