feat(retail): update the api

#### retail:v2 The following keys were added: - schemas.GoogleCloudRetailV2SearchRequest.properties.searchMode.type (Total Keys: 1) #### retail:v2alpha The following keys were added: - schemas.GoogleCloudRetailV2alphaSearchRequest.properties.searchMode.type (Total Keys: 1) #### retail:v2beta The following keys were added: - schemas.GoogleCloudRetailV2betaSearchRequest.properties.searchMode.type (Total Keys: 1)
googleapis · Oct 19, 2021 · 2aa456a · 2aa456a
1 parent 5d490d4
commit 2aa456a
Show file tree

Hide file tree

Showing 6 changed files with 48 additions and 3 deletions.
diff --git a/docs/dyn/retail_v2.projects.locations.catalogs.placements.html b/docs/dyn/retail_v2.projects.locations.catalogs.placements.html
@@ -384,6 +384,7 @@ <h3>Method Details</h3>
     &quot;condition&quot;: &quot;A String&quot;, # The condition under which query expansion should occur. Default to Condition.DISABLED.
     &quot;pinUnexpandedResults&quot;: True or False, # Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results.
   },
+  &quot;searchMode&quot;: &quot;A String&quot;, # The search mode of the search request. If not specified, a single search request triggers both product search and faceted search.
   &quot;userInfo&quot;: { # Information of an end user. # User information.
     &quot;directUserRequest&quot;: True or False, # True if the request is made directly from the end user, in which case the ip_address and user_agent can be populated from the HTTP request. This flag should be set only if the API request is made directly from the end user such as a mobile app (and not if a gateway or a server is processing and pushing the user events). This should not be set when using the JavaScript tag in UserEventService.CollectUserEvent.
     &quot;ipAddress&quot;: &quot;A String&quot;, # The end user&#x27;s IP address. Required for getting SearchResponse.sponsored_results. This field is used to extract location information for personalization. This field must be either an IPv4 address (e.g. &quot;104.133.9.80&quot;) or an IPv6 address (e.g. &quot;2001:0db8:85a3:0000:0000:8a2e:0370:7334&quot;). Otherwise, an INVALID_ARGUMENT error is returned. This should not be set when using the JavaScript tag in UserEventService.CollectUserEvent or if direct_user_request is set.

diff --git a/docs/dyn/retail_v2alpha.projects.locations.catalogs.placements.html b/docs/dyn/retail_v2alpha.projects.locations.catalogs.placements.html
@@ -385,6 +385,7 @@ <h3>Method Details</h3>
     &quot;pinUnexpandedResults&quot;: True or False, # Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results.
   },
   &quot;relevanceThreshold&quot;: &quot;A String&quot;, # The relevance threshold of the search results. Defaults to RelevanceThreshold.HIGH, which means only the most relevant results are shown, and the least number of results are returned. See more details at this [user guide](https://cloud.google.com/retail/docs/result-size#relevance_thresholding).
+  &quot;searchMode&quot;: &quot;A String&quot;, # The search mode of the search request. If not specified, a single search request triggers both product search and faceted search.
   &quot;userInfo&quot;: { # Information of an end user. # User information.
     &quot;directUserRequest&quot;: True or False, # True if the request is made directly from the end user, in which case the ip_address and user_agent can be populated from the HTTP request. This flag should be set only if the API request is made directly from the end user such as a mobile app (and not if a gateway or a server is processing and pushing the user events). This should not be set when using the JavaScript tag in UserEventService.CollectUserEvent.
     &quot;ipAddress&quot;: &quot;A String&quot;, # The end user&#x27;s IP address. Required for getting SearchResponse.sponsored_results. This field is used to extract location information for personalization. This field must be either an IPv4 address (e.g. &quot;104.133.9.80&quot;) or an IPv6 address (e.g. &quot;2001:0db8:85a3:0000:0000:8a2e:0370:7334&quot;). Otherwise, an INVALID_ARGUMENT error is returned. This should not be set when using the JavaScript tag in UserEventService.CollectUserEvent or if direct_user_request is set.

diff --git a/docs/dyn/retail_v2beta.projects.locations.catalogs.placements.html b/docs/dyn/retail_v2beta.projects.locations.catalogs.placements.html
@@ -384,6 +384,7 @@ <h3>Method Details</h3>
     &quot;condition&quot;: &quot;A String&quot;, # The condition under which query expansion should occur. Default to Condition.DISABLED.
     &quot;pinUnexpandedResults&quot;: True or False, # Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results.
   },
+  &quot;searchMode&quot;: &quot;A String&quot;, # The search mode of the search request. If not specified, a single search request triggers both product search and faceted search.
   &quot;userInfo&quot;: { # Information of an end user. # User information.
     &quot;directUserRequest&quot;: True or False, # True if the request is made directly from the end user, in which case the ip_address and user_agent can be populated from the HTTP request. This flag should be set only if the API request is made directly from the end user such as a mobile app (and not if a gateway or a server is processing and pushing the user events). This should not be set when using the JavaScript tag in UserEventService.CollectUserEvent.
     &quot;ipAddress&quot;: &quot;A String&quot;, # The end user&#x27;s IP address. Required for getting SearchResponse.sponsored_results. This field is used to extract location information for personalization. This field must be either an IPv4 address (e.g. &quot;104.133.9.80&quot;) or an IPv6 address (e.g. &quot;2001:0db8:85a3:0000:0000:8a2e:0370:7334&quot;). Otherwise, an INVALID_ARGUMENT error is returned. This should not be set when using the JavaScript tag in UserEventService.CollectUserEvent or if direct_user_request is set.

diff --git a/googleapiclient/discovery_cache/documents/retail.v2.json b/googleapiclient/discovery_cache/documents/retail.v2.json
@@ -1007,7 +1007,7 @@
       }
     }
   },
-  "revision": "20211011",
+  "revision": "20211014",
   "rootUrl": "https://retail.googleapis.com/",
   "schemas": {
     "GoogleApiHttpBody": {
@@ -2379,6 +2379,20 @@
           "$ref": "GoogleCloudRetailV2SearchRequestQueryExpansionSpec",
           "description": "The query expansion specification that specifies the conditions under which query expansion will occur. See more details at this [user guide](https://cloud.google.com/retail/docs/result-size#query_expansion)."
         },
+        "searchMode": {
+          "description": "The search mode of the search request. If not specified, a single search request triggers both product search and faceted search.",
+          "enum": [
+            "SEARCH_MODE_UNSPECIFIED",
+            "PRODUCT_SEARCH_ONLY",
+            "FACETED_SEARCH_ONLY"
+          ],
+          "enumDescriptions": [
+            "Default value. In this case both product search and faceted search will be performed. Both [SearchResponse.SearchResult] and [SearchResponse.Facet] will be returned.",
+            "Only product search will be performed. The faceted search will be disabled. Only [SearchResponse.SearchResult] will be returned. [SearchResponse.Facet] will not be returned, even if SearchRequest.facet_specs or SearchRequest.dynamic_facet_spec is set.",
+            "Only faceted search will be performed. The product search will be disabled. When in this mode, one or both of SearchRequest.facet_spec and SearchRequest.dynamic_facet_spec should be set. Otherwise, an INVALID_ARGUMENT error is returned. Only [SearchResponse.Facet] will be returned. [SearchResponse.SearchResult] will not be returned."
+          ],
+          "type": "string"
+        },
         "userInfo": {
           "$ref": "GoogleCloudRetailV2UserInfo",
           "description": "User information."

diff --git a/googleapiclient/discovery_cache/documents/retail.v2alpha.json b/googleapiclient/discovery_cache/documents/retail.v2alpha.json
@@ -1012,7 +1012,7 @@
       }
     }
   },
-  "revision": "20211011",
+  "revision": "20211014",
   "rootUrl": "https://retail.googleapis.com/",
   "schemas": {
     "GoogleApiHttpBody": {
@@ -2701,6 +2701,20 @@
           ],
           "type": "string"
         },
+        "searchMode": {
+          "description": "The search mode of the search request. If not specified, a single search request triggers both product search and faceted search.",
+          "enum": [
+            "SEARCH_MODE_UNSPECIFIED",
+            "PRODUCT_SEARCH_ONLY",
+            "FACETED_SEARCH_ONLY"
+          ],
+          "enumDescriptions": [
+            "Default value. In this case both product search and faceted search will be performed. Both [SearchResponse.SearchResult] and [SearchResponse.Facet] will be returned.",
+            "Only product search will be performed. The faceted search will be disabled. Only [SearchResponse.SearchResult] will be returned. [SearchResponse.Facet] will not be returned, even if SearchRequest.facet_specs or SearchRequest.dynamic_facet_spec is set.",
+            "Only faceted search will be performed. The product search will be disabled. When in this mode, one or both of SearchRequest.facet_spec and SearchRequest.dynamic_facet_spec should be set. Otherwise, an INVALID_ARGUMENT error is returned. Only [SearchResponse.Facet] will be returned. [SearchResponse.SearchResult] will not be returned."
+          ],
+          "type": "string"
+        },
         "userInfo": {
           "$ref": "GoogleCloudRetailV2alphaUserInfo",
           "description": "User information."

diff --git a/googleapiclient/discovery_cache/documents/retail.v2beta.json b/googleapiclient/discovery_cache/documents/retail.v2beta.json
@@ -1007,7 +1007,7 @@
       }
     }
   },
-  "revision": "20211011",
+  "revision": "20211014",
   "rootUrl": "https://retail.googleapis.com/",
   "schemas": {
     "GoogleApiHttpBody": {
@@ -2885,6 +2885,20 @@
           "$ref": "GoogleCloudRetailV2betaSearchRequestQueryExpansionSpec",
           "description": "The query expansion specification that specifies the conditions under which query expansion will occur. See more details at this [user guide](https://cloud.google.com/retail/docs/result-size#query_expansion)."
         },
+        "searchMode": {
+          "description": "The search mode of the search request. If not specified, a single search request triggers both product search and faceted search.",
+          "enum": [
+            "SEARCH_MODE_UNSPECIFIED",
+            "PRODUCT_SEARCH_ONLY",
+            "FACETED_SEARCH_ONLY"
+          ],
+          "enumDescriptions": [
+            "Default value. In this case both product search and faceted search will be performed. Both [SearchResponse.SearchResult] and [SearchResponse.Facet] will be returned.",
+            "Only product search will be performed. The faceted search will be disabled. Only [SearchResponse.SearchResult] will be returned. [SearchResponse.Facet] will not be returned, even if SearchRequest.facet_specs or SearchRequest.dynamic_facet_spec is set.",
+            "Only faceted search will be performed. The product search will be disabled. When in this mode, one or both of SearchRequest.facet_spec and SearchRequest.dynamic_facet_spec should be set. Otherwise, an INVALID_ARGUMENT error is returned. Only [SearchResponse.Facet] will be returned. [SearchResponse.SearchResult] will not be returned."
+          ],
+          "type": "string"
+        },
         "userInfo": {
           "$ref": "GoogleCloudRetailV2betaUserInfo",
           "description": "User information."