Skip to content

Commit 5b8cc25

Browse files
feat(retail): update the API
#### retail:v2alpha The following keys were added: - resources.projects.resources.locations.resources.catalogs.resources.placements.methods.conversationalSearch.description - resources.projects.resources.locations.resources.catalogs.resources.placements.methods.conversationalSearch.flatPath - resources.projects.resources.locations.resources.catalogs.resources.placements.methods.conversationalSearch.httpMethod - resources.projects.resources.locations.resources.catalogs.resources.placements.methods.conversationalSearch.id - resources.projects.resources.locations.resources.catalogs.resources.placements.methods.conversationalSearch.parameterOrder - resources.projects.resources.locations.resources.catalogs.resources.placements.methods.conversationalSearch.parameters.placement.description - resources.projects.resources.locations.resources.catalogs.resources.placements.methods.conversationalSearch.parameters.placement.location - resources.projects.resources.locations.resources.catalogs.resources.placements.methods.conversationalSearch.parameters.placement.pattern - resources.projects.resources.locations.resources.catalogs.resources.placements.methods.conversationalSearch.parameters.placement.required - resources.projects.resources.locations.resources.catalogs.resources.placements.methods.conversationalSearch.parameters.placement.type - resources.projects.resources.locations.resources.catalogs.resources.placements.methods.conversationalSearch.path - resources.projects.resources.locations.resources.catalogs.resources.placements.methods.conversationalSearch.request.$ref - resources.projects.resources.locations.resources.catalogs.resources.placements.methods.conversationalSearch.response.$ref - resources.projects.resources.locations.resources.catalogs.resources.placements.methods.conversationalSearch.scopes - resources.projects.resources.locations.resources.catalogs.resources.servingConfigs.methods.conversationalSearch.description - resources.projects.resources.locations.resources.catalogs.resources.servingConfigs.methods.conversationalSearch.flatPath - resources.projects.resources.locations.resources.catalogs.resources.servingConfigs.methods.conversationalSearch.httpMethod - resources.projects.resources.locations.resources.catalogs.resources.servingConfigs.methods.conversationalSearch.id - resources.projects.resources.locations.resources.catalogs.resources.servingConfigs.methods.conversationalSearch.parameterOrder - resources.projects.resources.locations.resources.catalogs.resources.servingConfigs.methods.conversationalSearch.parameters.placement.description - resources.projects.resources.locations.resources.catalogs.resources.servingConfigs.methods.conversationalSearch.parameters.placement.location - resources.projects.resources.locations.resources.catalogs.resources.servingConfigs.methods.conversationalSearch.parameters.placement.pattern - resources.projects.resources.locations.resources.catalogs.resources.servingConfigs.methods.conversationalSearch.parameters.placement.required - resources.projects.resources.locations.resources.catalogs.resources.servingConfigs.methods.conversationalSearch.parameters.placement.type - resources.projects.resources.locations.resources.catalogs.resources.servingConfigs.methods.conversationalSearch.path - resources.projects.resources.locations.resources.catalogs.resources.servingConfigs.methods.conversationalSearch.request.$ref - resources.projects.resources.locations.resources.catalogs.resources.servingConfigs.methods.conversationalSearch.response.$ref - resources.projects.resources.locations.resources.catalogs.resources.servingConfigs.methods.conversationalSearch.scopes - schemas.GoogleCloudRetailV2alphaConversationalSearchRequest.description - schemas.GoogleCloudRetailV2alphaConversationalSearchRequest.id - schemas.GoogleCloudRetailV2alphaConversationalSearchRequest.properties.branch.description - schemas.GoogleCloudRetailV2alphaConversationalSearchRequest.properties.branch.type - schemas.GoogleCloudRetailV2alphaConversationalSearchRequest.properties.conversationId.description - schemas.GoogleCloudRetailV2alphaConversationalSearchRequest.properties.conversationId.type - schemas.GoogleCloudRetailV2alphaConversationalSearchRequest.properties.conversationalFilteringSpec.$ref - schemas.GoogleCloudRetailV2alphaConversationalSearchRequest.properties.conversationalFilteringSpec.description - schemas.GoogleCloudRetailV2alphaConversationalSearchRequest.properties.pageCategories.description - schemas.GoogleCloudRetailV2alphaConversationalSearchRequest.properties.pageCategories.items.type - schemas.GoogleCloudRetailV2alphaConversationalSearchRequest.properties.pageCategories.type - schemas.GoogleCloudRetailV2alphaConversationalSearchRequest.properties.query.description - schemas.GoogleCloudRetailV2alphaConversationalSearchRequest.properties.query.type - schemas.GoogleCloudRetailV2alphaConversationalSearchRequest.properties.searchParams.$ref - schemas.GoogleCloudRetailV2alphaConversationalSearchRequest.properties.searchParams.description - schemas.GoogleCloudRetailV2alphaConversationalSearchRequest.properties.userInfo.$ref - schemas.GoogleCloudRetailV2alphaConversationalSearchRequest.properties.userInfo.description - schemas.GoogleCloudRetailV2alphaConversationalSearchRequest.properties.visitorId.description - schemas.GoogleCloudRetailV2alphaConversationalSearchRequest.properties.visitorId.type - schemas.GoogleCloudRetailV2alphaConversationalSearchRequest.type - schemas.GoogleCloudRetailV2alphaConversationalSearchRequestConversationalFilteringSpec.description - schemas.GoogleCloudRetailV2alphaConversationalSearchRequestConversationalFilteringSpec.id - schemas.GoogleCloudRetailV2alphaConversationalSearchRequestConversationalFilteringSpec.properties.conversationalFilteringMode.description - schemas.GoogleCloudRetailV2alphaConversationalSearchRequestConversationalFilteringSpec.properties.conversationalFilteringMode.enum - schemas.GoogleCloudRetailV2alphaConversationalSearchRequestConversationalFilteringSpec.properties.conversationalFilteringMode.enumDescriptions - schemas.GoogleCloudRetailV2alphaConversationalSearchRequestConversationalFilteringSpec.properties.conversationalFilteringMode.type - schemas.GoogleCloudRetailV2alphaConversationalSearchRequestConversationalFilteringSpec.properties.enableConversationalFiltering.deprecated - schemas.GoogleCloudRetailV2alphaConversationalSearchRequestConversationalFilteringSpec.properties.enableConversationalFiltering.description - schemas.GoogleCloudRetailV2alphaConversationalSearchRequestConversationalFilteringSpec.properties.enableConversationalFiltering.type - schemas.GoogleCloudRetailV2alphaConversationalSearchRequestConversationalFilteringSpec.properties.userAnswer.$ref - schemas.GoogleCloudRetailV2alphaConversationalSearchRequestConversationalFilteringSpec.properties.userAnswer.description - schemas.GoogleCloudRetailV2alphaConversationalSearchRequestConversationalFilteringSpec.type - schemas.GoogleCloudRetailV2alphaConversationalSearchRequestSearchParams.description - schemas.GoogleCloudRetailV2alphaConversationalSearchRequestSearchParams.id - schemas.GoogleCloudRetailV2alphaConversationalSearchRequestSearchParams.properties.boostSpec.$ref - schemas.GoogleCloudRetailV2alphaConversationalSearchRequestSearchParams.properties.boostSpec.description - schemas.GoogleCloudRetailV2alphaConversationalSearchRequestSearchParams.properties.canonicalFilter.description - schemas.GoogleCloudRetailV2alphaConversationalSearchRequestSearchParams.properties.canonicalFilter.type - schemas.GoogleCloudRetailV2alphaConversationalSearchRequestSearchParams.properties.filter.description - schemas.GoogleCloudRetailV2alphaConversationalSearchRequestSearchParams.properties.filter.type - schemas.GoogleCloudRetailV2alphaConversationalSearchRequestSearchParams.properties.sortBy.description - schemas.GoogleCloudRetailV2alphaConversationalSearchRequestSearchParams.properties.sortBy.type - schemas.GoogleCloudRetailV2alphaConversationalSearchRequestSearchParams.type - schemas.GoogleCloudRetailV2alphaConversationalSearchRequestUserAnswer.description - schemas.GoogleCloudRetailV2alphaConversationalSearchRequestUserAnswer.id - schemas.GoogleCloudRetailV2alphaConversationalSearchRequestUserAnswer.properties.selectedAnswer.$ref - schemas.GoogleCloudRetailV2alphaConversationalSearchRequestUserAnswer.properties.selectedAnswer.description - schemas.GoogleCloudRetailV2alphaConversationalSearchRequestUserAnswer.properties.textAnswer.description - schemas.GoogleCloudRetailV2alphaConversationalSearchRequestUserAnswer.properties.textAnswer.type - schemas.GoogleCloudRetailV2alphaConversationalSearchRequestUserAnswer.type - schemas.GoogleCloudRetailV2alphaConversationalSearchRequestUserAnswerSelectedAnswer.description - schemas.GoogleCloudRetailV2alphaConversationalSearchRequestUserAnswerSelectedAnswer.id - schemas.GoogleCloudRetailV2alphaConversationalSearchRequestUserAnswerSelectedAnswer.properties.productAttributeValue.$ref - schemas.GoogleCloudRetailV2alphaConversationalSearchRequestUserAnswerSelectedAnswer.properties.productAttributeValue.description - schemas.GoogleCloudRetailV2alphaConversationalSearchRequestUserAnswerSelectedAnswer.type - schemas.GoogleCloudRetailV2alphaConversationalSearchResponse.description - schemas.GoogleCloudRetailV2alphaConversationalSearchResponse.id - schemas.GoogleCloudRetailV2alphaConversationalSearchResponse.properties.conversationId.description - schemas.GoogleCloudRetailV2alphaConversationalSearchResponse.properties.conversationId.type - schemas.GoogleCloudRetailV2alphaConversationalSearchResponse.properties.conversationalFilteringResult.$ref - schemas.GoogleCloudRetailV2alphaConversationalSearchResponse.properties.conversationalFilteringResult.description - schemas.GoogleCloudRetailV2alphaConversationalSearchResponse.properties.refinedSearch.description - schemas.GoogleCloudRetailV2alphaConversationalSearchResponse.properties.refinedSearch.items.$ref - schemas.GoogleCloudRetailV2alphaConversationalSearchResponse.properties.refinedSearch.type - schemas.GoogleCloudRetailV2alphaConversationalSearchResponse.properties.rephrasedQuery.deprecated - schemas.GoogleCloudRetailV2alphaConversationalSearchResponse.properties.rephrasedQuery.description - schemas.GoogleCloudRetailV2alphaConversationalSearchResponse.properties.rephrasedQuery.type - schemas.GoogleCloudRetailV2alphaConversationalSearchResponse.type - schemas.GoogleCloudRetailV2alphaConversationalSearchResponseConversationalFilteringResult.description - schemas.GoogleCloudRetailV2alphaConversationalSearchResponseConversationalFilteringResult.id - schemas.GoogleCloudRetailV2alphaConversationalSearchResponseConversationalFilteringResult.properties.additionalFilter.$ref - schemas.GoogleCloudRetailV2alphaConversationalSearchResponseConversationalFilteringResult.properties.additionalFilter.description - schemas.GoogleCloudRetailV2alphaConversationalSearchResponseConversationalFilteringResult.properties.followupQuestion.$ref - schemas.GoogleCloudRetailV2alphaConversationalSearchResponseConversationalFilteringResult.properties.followupQuestion.description - schemas.GoogleCloudRetailV2alphaConversationalSearchResponseConversationalFilteringResult.type - schemas.GoogleCloudRetailV2alphaConversationalSearchResponseConversationalFilteringResultAdditionalFilter.description - schemas.GoogleCloudRetailV2alphaConversationalSearchResponseConversationalFilteringResultAdditionalFilter.id - schemas.GoogleCloudRetailV2alphaConversationalSearchResponseConversationalFilteringResultAdditionalFilter.properties.productAttributeValue.$ref - schemas.GoogleCloudRetailV2alphaConversationalSearchResponseConversationalFilteringResultAdditionalFilter.properties.productAttributeValue.description - schemas.GoogleCloudRetailV2alphaConversationalSearchResponseConversationalFilteringResultAdditionalFilter.type - schemas.GoogleCloudRetailV2alphaConversationalSearchResponseFollowupQuestion.description - schemas.GoogleCloudRetailV2alphaConversationalSearchResponseFollowupQuestion.id - schemas.GoogleCloudRetailV2alphaConversationalSearchResponseFollowupQuestion.properties.followupQuestion.description - schemas.GoogleCloudRetailV2alphaConversationalSearchResponseFollowupQuestion.properties.followupQuestion.type - schemas.GoogleCloudRetailV2alphaConversationalSearchResponseFollowupQuestion.properties.suggestedAnswers.description - schemas.GoogleCloudRetailV2alphaConversationalSearchResponseFollowupQuestion.properties.suggestedAnswers.items.$ref - schemas.GoogleCloudRetailV2alphaConversationalSearchResponseFollowupQuestion.properties.suggestedAnswers.type - schemas.GoogleCloudRetailV2alphaConversationalSearchResponseFollowupQuestion.type - schemas.GoogleCloudRetailV2alphaConversationalSearchResponseFollowupQuestionSuggestedAnswer.description - schemas.GoogleCloudRetailV2alphaConversationalSearchResponseFollowupQuestionSuggestedAnswer.id - schemas.GoogleCloudRetailV2alphaConversationalSearchResponseFollowupQuestionSuggestedAnswer.properties.productAttributeValue.$ref - schemas.GoogleCloudRetailV2alphaConversationalSearchResponseFollowupQuestionSuggestedAnswer.properties.productAttributeValue.description - schemas.GoogleCloudRetailV2alphaConversationalSearchResponseFollowupQuestionSuggestedAnswer.type - schemas.GoogleCloudRetailV2alphaConversationalSearchResponseRefinedSearch.description - schemas.GoogleCloudRetailV2alphaConversationalSearchResponseRefinedSearch.id - schemas.GoogleCloudRetailV2alphaConversationalSearchResponseRefinedSearch.properties.query.description - schemas.GoogleCloudRetailV2alphaConversationalSearchResponseRefinedSearch.properties.query.type - schemas.GoogleCloudRetailV2alphaConversationalSearchResponseRefinedSearch.type - schemas.GoogleCloudRetailV2alphaSearchRequest.properties.languageCode.description - schemas.GoogleCloudRetailV2alphaSearchRequest.properties.languageCode.type - schemas.GoogleCloudRetailV2alphaSearchRequest.properties.placeId.description - schemas.GoogleCloudRetailV2alphaSearchRequest.properties.placeId.type - schemas.GoogleCloudRetailV2alphaSearchRequest.properties.regionCode.description - schemas.GoogleCloudRetailV2alphaSearchRequest.properties.regionCode.type The following keys were changed: - resources.projects.resources.locations.resources.catalogs.methods.completeQuery.parameters.entity.description - resources.projects.resources.locations.resources.catalogs.methods.completeQuery.parameters.visitorId.description - schemas.GoogleCloudRetailV2alphaSearchRequestTileNavigationSpec.properties.appliedTiles.description - schemas.GoogleCloudRetailV2alphaUserEvent.properties.eventType.description #### retail:v2beta The following keys were added: - schemas.GoogleCloudRetailV2betaSearchRequest.properties.languageCode.description - schemas.GoogleCloudRetailV2betaSearchRequest.properties.languageCode.type - schemas.GoogleCloudRetailV2betaSearchRequest.properties.placeId.description - schemas.GoogleCloudRetailV2betaSearchRequest.properties.placeId.type - schemas.GoogleCloudRetailV2betaSearchRequest.properties.regionCode.description - schemas.GoogleCloudRetailV2betaSearchRequest.properties.regionCode.type The following keys were changed: - resources.projects.resources.locations.resources.catalogs.methods.completeQuery.parameters.entity.description - resources.projects.resources.locations.resources.catalogs.methods.completeQuery.parameters.visitorId.description - schemas.GoogleCloudRetailV2betaSearchRequestTileNavigationSpec.properties.appliedTiles.description - schemas.GoogleCloudRetailV2betaUserEvent.properties.eventType.description #### retail:v2 The following keys were added: - schemas.GoogleCloudRetailV2SearchRequest.properties.languageCode.description - schemas.GoogleCloudRetailV2SearchRequest.properties.languageCode.type - schemas.GoogleCloudRetailV2SearchRequest.properties.placeId.description - schemas.GoogleCloudRetailV2SearchRequest.properties.placeId.type - schemas.GoogleCloudRetailV2SearchRequest.properties.regionCode.description - schemas.GoogleCloudRetailV2SearchRequest.properties.regionCode.type The following keys were changed: - resources.projects.resources.locations.resources.catalogs.methods.completeQuery.parameters.entity.description - resources.projects.resources.locations.resources.catalogs.methods.completeQuery.parameters.visitorId.description - schemas.GoogleCloudRetailV2SearchRequestTileNavigationSpec.properties.appliedTiles.description - schemas.GoogleCloudRetailV2UserEvent.properties.eventType.description
1 parent 668b7c6 commit 5b8cc25

File tree

6 files changed

+756
-27
lines changed

6 files changed

+756
-27
lines changed

discovery/retail-v2.json

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@
143143
"type": "boolean"
144144
},
145145
"entity": {
146-
"description": "The entity for customers who run multiple entities, domains, sites, or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc. If this is set, it must be an exact match with UserEvent.entity to get per-entity autocomplete results.",
146+
"description": "The entity for customers who run multiple entities, domains, sites, or regions, for example, `Google US`, `Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc. If this is set, it must be an exact match with UserEvent.entity to get per-entity autocomplete results. Also, this entity should be limited to 256 characters, if too long, it will be truncated to 256 characters in both generation and serving time, and may lead to mis-match. To ensure it works, please set the entity with string within 256 characters.",
147147
"location": "query",
148148
"type": "string"
149149
},
@@ -165,7 +165,7 @@
165165
"type": "string"
166166
},
167167
"visitorId": {
168-
"description": "Required field. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.",
168+
"description": "Recommended field. A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.",
169169
"location": "query",
170170
"type": "string"
171171
}
@@ -2223,7 +2223,7 @@
22232223
}
22242224
}
22252225
},
2226-
"revision": "20250116",
2226+
"revision": "20250314",
22272227
"rootUrl": "https://retail.googleapis.com/",
22282228
"schemas": {
22292229
"GoogleApiHttpBody": {
@@ -5181,6 +5181,10 @@
51815181
"description": "The labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. For more information, see [Requirements for labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) in the Resource Manager documentation.",
51825182
"type": "object"
51835183
},
5184+
"languageCode": {
5185+
"description": "Optional. The BCP-47 language code, such as \"en-US\" or \"sr-Latn\" [list](https://www.unicode.org/cldr/charts/46/summary/root.html). For more information, see [Standardized codes](https://google.aip.dev/143). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate.",
5186+
"type": "string"
5187+
},
51845188
"offset": {
51855189
"description": "A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Products deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an INVALID_ARGUMENT is returned.",
51865190
"format": "int32",
@@ -5210,6 +5214,10 @@
52105214
"$ref": "GoogleCloudRetailV2SearchRequestPersonalizationSpec",
52115215
"description": "The specification for personalization. Notice that if both ServingConfig.personalization_spec and SearchRequest.personalization_spec are set. SearchRequest.personalization_spec will override ServingConfig.personalization_spec."
52125216
},
5217+
"placeId": {
5218+
"description": "Optional. An id corresponding to a place, such as a store id or region id. When specified, we use the price from the local inventory with the matching product's LocalInventory.place_id for revenue optimization.",
5219+
"type": "string"
5220+
},
52135221
"query": {
52145222
"description": "Raw search query. If this field is empty, the request is considered a category browsing request and returned results are based on filter and page_categories.",
52155223
"type": "string"
@@ -5218,6 +5226,10 @@
52185226
"$ref": "GoogleCloudRetailV2SearchRequestQueryExpansionSpec",
52195227
"description": "The query expansion specification that specifies the conditions under which query expansion occurs. For more information, see [Query expansion](https://cloud.google.com/retail/docs/result-size#query_expansion)."
52205228
},
5229+
"regionCode": {
5230+
"description": "Optional. The Unicode country/region code (CLDR) of a location, such as \"US\" and \"419\" [list](https://www.unicode.org/cldr/charts/46/supplemental/territory_information.html). For more information, see [Standardized codes](https://google.aip.dev/143). If set, then results will be boosted based on the region_code provided.",
5231+
"type": "string"
5232+
},
52215233
"searchMode": {
52225234
"description": "The search mode of the search request. If not specified, a single search request triggers both product search and faceted search.",
52235235
"enum": [
@@ -5520,7 +5532,7 @@
55205532
"id": "GoogleCloudRetailV2SearchRequestTileNavigationSpec",
55215533
"properties": {
55225534
"appliedTiles": {
5523-
"description": "This field specifies the tiles which are already clicked in client side. NOTE: This field is not being used for filtering search products. Client side should also put all the applied tiles in SearchRequest.filter.",
5535+
"description": "This optional field specifies the tiles which are already clicked in client side. While the feature works without this field set, particularly for an initial query, it is highly recommended to set this field because it can improve the quality of the search response and removes possible duplicate tiles. NOTE: This field is not being used for filtering search products. Client side should also put all the applied tiles in SearchRequest.filter.",
55245536
"items": {
55255537
"$ref": "GoogleCloudRetailV2Tile"
55265538
},
@@ -6080,7 +6092,7 @@
60806092
"type": "string"
60816093
},
60826094
"eventType": {
6083-
"description": "Required. User event type. Allowed values are: * `add-to-cart`: Products being added to cart. * `remove-from-cart`: Products being removed from cart. * `category-page-view`: Special pages such as sale or promotion pages viewed. * `detail-page-view`: Products detail page viewed. * `home-page-view`: Homepage viewed. * `promotion-offered`: Promotion is offered to a user. * `promotion-not-offered`: Promotion is not offered to a user. * `purchase-complete`: User finishing a purchase. * `search`: Product search. * `shopping-cart-page-view`: User viewing a shopping cart.",
6095+
"description": "Required. User event type. Allowed values are: * `add-to-cart`: Products being added to cart. * `remove-from-cart`: Products being removed from cart. * `category-page-view`: Special pages such as sale or promotion pages viewed. * `detail-page-view`: Products detail page viewed. * `home-page-view`: Homepage viewed. * `purchase-complete`: User finishing a purchase. * `search`: Product search. * `shopping-cart-page-view`: User viewing a shopping cart.",
60846096
"type": "string"
60856097
},
60866098
"experimentIds": {

0 commit comments

Comments
 (0)