API Reference google_api_retail v0.20.0
View SourceModules
API client metadata for GoogleApi.Retail.V2.
API calls for all endpoints tagged Projects.
Handle Tesla connections for GoogleApi.Retail.V2.
Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
A description of the context in which an error occurred.
An error log which is reported to the Error Reporting system. This proto a superset of google.devtools.clouderrorreporting.v1beta1.ReportedErrorEvent.
HTTP request data that is related to a reported error.
The error payload that is populated on LRO import APIs, including "google.cloud.retail.v2.ProductService.ImportProducts" and "google.cloud.retail.v2.EventService.ImportUserEvents".
Describes a running service that sends errors.
Indicates a location in the source code of the service for which errors are reported.
Request for CatalogService.AddCatalogAttribute method.
Request for AddControl method.
Metadata related to the progress of the AddFulfillmentPlaces operation. Currently empty because there is no meaningful metadata populated from the ProductService.AddFulfillmentPlaces method.
Request message for ProductService.AddFulfillmentPlaces method.
Response of the AddFulfillmentPlacesRequest. Currently empty because there is no meaningful response populated from the ProductService.AddFulfillmentPlaces method.
Metadata related to the progress of the AddLocalInventories operation. Currently empty because there is no meaningful metadata populated from the ProductService.AddLocalInventories method.
Request message for ProductService.AddLocalInventories method.
Response of the ProductService.AddLocalInventories API. Currently empty because there is no meaningful response populated from the ProductService.AddLocalInventories method.
Catalog level attribute config.
An intended audience of the Product for whom it's sold.
Request for BatchUpdateGenerativeQuestionConfig method.
Aggregated response for UpdateGenerativeQuestionConfig method.
A BigQuery output result.
BigQuery source import data from.
The catalog configuration.
Catalog level attribute config for an attribute. For example, if customers want to enable/disable facet for a specific attribute.
Possible options for the facet that corresponds to the current attribute config.
Facet values to ignore on facets during the specified time range for the given SearchResponse.Facet.key attribute.
The current facet key (i.e. attribute config) maps into the merged_facet_key. A facet key can have at most one child. The current facet key and the merged facet key need both to be textual custom attributes or both numerical custom attributes (same type).
Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes.
Options to rerank based on facet values engaged by the user for the current key. That key needs to be a custom textual key and facetable. To use this control, you also need to pass all the facet keys engaged by the user in the request using the field [SearchRequest.FacetSpec]. In particular, if you don't pass the facet keys engaged that you want to rerank on, this control won't be effective. Moreover, to obtain better results, the facet values that you want to rerank on should be close to English (ideally made of words, underscores, and spaces).
Request message for CollectUserEvent method.
The color information of a Product.
Response of the autocomplete query.
Resource that represents attribute results.
Resource that represents completion results.
Deprecated: Recent search of this user.
Catalog level autocomplete config for customers to customize autocomplete feature's settings.
The input config source for completion data.
Detailed completion information including completion attribution token and clicked completion info.
Metadata that is used to define a condition that triggers an action. A valid condition must specify at least one of 'query_terms' or 'products_filter'. If multiple fields are specified, the condition is met if all the fields are satisfied e.g. if a set of query terms and product_filter are set, then only items matching the product_filter for requests with a query matching the query terms wil get boosted.
Query terms that we want to match on.
Used for time-dependent conditions. Example: Want to have rule applied for week long sale.
Configures dynamic metadata that can be linked to a ServingConfig and affect search or recommendation results at serving time.
Metadata associated with a create operation.
A custom attribute that is not explicitly modeled in Product.
Metadata for active A/B testing experiment.
Metadata for active serving config A/B tests.
Request message for the ExportAnalyticsMetrics method.
Response of the ExportAnalyticsMetricsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.
Configuration of destination for Export related errors.
Metadata related to the progress of the Export operation. This is returned by the google.longrunning.Operation.metadata field.
Fulfillment information, such as the store IDs for in-store pickup or region IDs for different shipping methods.
A Gcs output result.
Google Cloud Storage location for input content.
Configuration for a single generated question.
Configuration for overall generative question feature state.
Response message of CatalogService.GetDefaultBranch.
Product image. Recommendations AI and Retail Search use product images to improve prediction and search results. Product images can be returned in results, and are shown in prediction or search previews in the console. Please try to provide correct product images and avoid using images with size too small.
Request message for ImportCompletionData methods.
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.
Configuration of destination for Import related errors.
Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.
Request message for Import methods.
Response of the ImportProductsRequest. If the long running operation is done, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.
Request message for the ImportUserEvents request.
Response of the ImportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.
A floating point interval.
Response for CatalogService.ListCatalogs method.
Response for ListControls method.
Response for ListQuestions method.
Response to a ListModelRequest.
Response message for ProductService.ListProducts method.
Response for ListServingConfigs method.
The inventory information at a place (e.g. a store) identified by a place ID.
Metadata that describes the training and serving parameters of a Model. A Model can be associated with a ServingConfig and then queried through the Predict API.
Additional configs for the frequently-bought-together model type.
Additional model features config.
Represents an ordered combination of valid serving configs, which can be used for PAGE_OPTIMIZATION recommendations.
The output configuration setting.
The BigQuery output destination configuration.
The Google Cloud Storage output destination configuration.
Output result that stores the information about where the exported data is stored.
Request for pausing training of a model.
Metadata for pinning to be returned in the response. This is used for distinguishing between applied vs dropped pins.
List of product ids which have associated pins.
Request message for Predict method.
Response message for predict method.
PredictionResult represents the recommendation prediction results.
The price information of a Product.
The price range of all variant Product having the same Product.primary_product_id.
Product captures all metadata information of items to be recommended or searched.
Product attribute name and numeric interval.
Product attribute which structured by an attribute name and value. This structure is used in conversational search filters and answers. For example, if we have name=color and value=red, this means that the color is red.
Detailed product information associated with a user event.
The inline source for the input config for ImportProducts method.
The input config source for products.
Configures what level the product should be uploaded with regards to how users will be send events and how predictions will be made.
Promotion specification.
A transaction represents the entire purchase transaction.
Metadata related to the progress of the Purge operation. This will be returned by the google.longrunning.Operation.metadata field.
Metadata related to the progress of the PurgeProducts operation. This will be returned by the google.longrunning.Operation.metadata field.
Request message for PurgeProducts method.
Response of the PurgeProductsRequest. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.
Request message for PurgeUserEvents method.
Response of the PurgeUserEventsRequest. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.
The rating of a Product.
Metadata for RejoinUserEvents method.
Request message for RejoinUserEvents method.
Response message for RejoinUserEvents method.
Request for CatalogService.RemoveCatalogAttribute method.
Request for RemoveControl method.
Metadata related to the progress of the RemoveFulfillmentPlaces operation. Currently empty because there is no meaningful metadata populated from the ProductService.RemoveFulfillmentPlaces method.
Request message for ProductService.RemoveFulfillmentPlaces method.
Response of the RemoveFulfillmentPlacesRequest. Currently empty because there is no meaningful response populated from the ProductService.RemoveFulfillmentPlaces method.
Metadata related to the progress of the RemoveLocalInventories operation. Currently empty because there is no meaningful metadata populated from the ProductService.RemoveLocalInventories method.
Request message for ProductService.RemoveLocalInventories method.
Response of the ProductService.RemoveLocalInventories API. Currently empty because there is no meaningful response populated from the ProductService.RemoveLocalInventories method.
Request for CatalogService.ReplaceCatalogAttribute method.
Request for resuming training of a model.
A rule is a condition-action pair A condition defines when a rule is to be triggered. An action specifies what occurs on that trigger. Currently rules only work for controls with SOLUTION_TYPE_SEARCH.
A boost action to apply to results matching condition specified above.
Prevents query_term from being associated with specified terms during search. Example: Don't associate "gShoe" and "cheap".
- Rule Condition: - No Condition.query_terms provided is a global match. - 1 or more Condition.query_terms provided are combined with OR operator. Action Input: The request query and filter that are applied to the retrieved products, in addition to any filters already provided with the SearchRequest. The AND operator is used to combine the query's existing filters with the filter rule(s). NOTE: May result in 0 results when filters conflict. Action Result: Filters the returned objects to be ONLY those that passed the filter.
Attributes
-
filter(type:String.t, default:nil) - A filter to apply on the matching condition results. Supported features: filter must be set. Filter syntax is identical to SearchRequest.filter. For more information, see Filter. To filter products with product ID "product_1" or "product_2", and color "Red" or "Blue": (id: ANY("product_1", "product_2")) AND (colorFamilies: ANY("Red", "Blue")) *
Force returns an attribute/facet in the request around a certain position or above. Rule Condition: Must specify non-empty Condition.query_terms (for search only) or Condition.page_categories (for browse only), but can't specify both. Action Inputs: attribute name, position * Action Result: Will force return a facet key around a certain position or above if the condition is satisfied. Example: Suppose the query is "shoes", the Condition.query_terms is "shoes", the ForceReturnFacetAction.FacetPositionAdjustment.attribute_name is "size" and the ForceReturnFacetAction.FacetPositionAdjustment.position is 8. Two cases: a) The facet key "size" is not already in the top 8 slots, then the facet "size" will appear at a position close to 8. b) The facet key "size" in among the top 8 positions in the request, then it will stay at its current rank.
Each facet position adjustment consists of a single attribute name (i.e. facet key) along with a specified position.
Prevents a term in the query from being used in search. Example: Don't search for "shoddy".
Maps a set of terms to a set of synonyms. Set of synonyms will be treated as synonyms of each query term only. query_terms will not be treated as synonyms of each other. Example: "sneakers" will use a synonym of "shoes". "shoes" will not use a synonym of "sneakers".
Pins one or more specified products to a specific position in the results. Rule Condition: Must specify non-empty Condition.query_terms (for search only) or Condition.page_categories (for browse only), but can't specify both. Action Input: mapping of [pin_position, product_id] pairs (pin position uses 1-based indexing). * Action Result: Will pin products with matching ids to the position specified in the final result order. Example: Suppose the query is shoes, the Condition.query_terms is shoes and the pin_map has {1, "pid1"}, then product with pid1 will be pinned to the top position in the final results. If multiple PinActions are matched to a single request the actions will be processed from most to least recently updated. Pins to positions larger than the max allowed page size of 120 are not allowed.
Redirects a shopper to a specific page. Rule Condition: Must specify Condition.query_terms. Action Input: Request Query * Action Result: Redirects shopper to provided uri.
Removes an attribute/facet in the request if is present. Rule Condition: Must specify non-empty Condition.query_terms (for search only) or Condition.page_categories (for browse only), but can't specify both. Action Input: attribute name * Action Result: Will remove the attribute (as a facet) from the request if it is present. Example: Suppose the query is "shoes", the Condition.query_terms is "shoes" and the attribute name "size", then facet key "size" will be removed from the request (if it is present).
Replaces a term in the query. Multiple replacement candidates can be specified. All query_terms will be replaced with the replacement term. Example: Replace "gShoe" with "google shoe".
Creates a set of terms that will be treated as synonyms of each other. Example: synonyms of "sneakers" and "shoes": "sneakers" will use a synonym of "shoes". "shoes" will use a synonym of "sneakers".
Request message for SearchService.Search method.
Boost specification to boost certain items.
Boost applies to products which match a condition.
This field specifies all conversational related parameters addition to traditional retail search.
This field specifies the current user answer during the conversational search. This can be either user selected from suggested answers or user input plain text.
This field specifies the selected answers during the conversational search.
The specifications of dynamically generated facets.
A facet specification to perform faceted search.
Specifies how a facet is computed.
The specification for personalization.
Specification to determine under which conditions query expansion should occur.
The specification for query spell correction.
This field specifies tile navigation related parameters.
Response message for SearchService.Search method.
This field specifies all related information that is needed on client side for UI rendering of conversational retail search.
Additional filter that client side need to apply.
Suggested answers to the follow-up question.
A facet result.
A facet value which contains value names and their count.
Information describing query expansion including whether expansion has occurred.
Represents the search results.
This field specifies all related information for tile navigation that will be used in client side.
Configures metadata that is used to generate serving time results (e.g. search results or recommendation predictions).
Request message to set a specified branch as new default_branch.
Metadata related to the progress of the SetInventory operation. Currently empty because there is no meaningful metadata populated from the ProductService.SetInventory method.
Request message for ProductService.SetInventory method.
Response of the SetInventoryRequest. Currently empty because there is no meaningful response populated from the ProductService.SetInventory method.
This field specifies the tile information including an attribute key, attribute value. More fields will be added in the future, eg: product id or product counts, etc.
Metadata associated with a tune operation.
Request to manually start a tuning process now (instead of waiting for the periodically scheduled tuning to happen).
Response associated with a tune operation.
Request for UpdateGenerativeQuestionConfig method.
UserEvent captures all metadata information Retail API needs to know about how end users interact with customers' website.
A summary of import result. The UserEventImportSummary summarizes the import status for user events.
The inline source for the input config for ImportUserEvents method.
The input config source for user events.
Information of an end user.
Metadata related to the progress of the AddFulfillmentPlaces operation. Currently empty because there is no meaningful metadata populated from the ProductService.AddFulfillmentPlaces method.
Response of the AddFulfillmentPlacesRequest. Currently empty because there is no meaningful response populated from the ProductService.AddFulfillmentPlaces method.
Metadata related to the progress of the AddLocalInventories operation. Currently empty because there is no meaningful metadata populated from the ProductService.AddLocalInventories method.
Response of the ProductService.AddLocalInventories API. Currently empty because there is no meaningful response populated from the ProductService.AddLocalInventories method.
A BigQuery output result.
Common metadata related to the progress of the operations.
Metadata associated with a create operation.
Metadata related to the EnrollSolution method. This will be returned by the google.longrunning.Operation.metadata field.
Response for EnrollSolution method.
Response of the ExportAnalyticsMetricsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.
Configuration of destination for Export related errors.
Metadata related to the progress of the Export operation. This is returned by the google.longrunning.Operation.metadata field.
Response of the ExportProductsRequest. If the long running operation is done, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.
Response of the ExportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.
A Gcs output result.
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.
Configuration of destination for Import related errors.
Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.
Response of the ImportProductsRequest. If the long running operation is done, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.
Response of the ImportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.
Represents a link between a Merchant Center account and a branch. After a link is established, products from the linked Merchant Center account are streamed to the linked branch.
Merchant Center Feed filter criterion.
Metadata that describes the training and serving parameters of a Model. A Model can be associated with a ServingConfig and then queried through the Predict API.
Additional configs for the frequently-bought-together model type.
Additional model features config.
The PageOptimizationConfig for model training. This determines how many panels to optimize for, and which serving configs to consider for each panel. The purpose of this model is to optimize which ServingConfig to show on which panels in way that optimizes the visitors shopping journey.
A candidate to consider for a given panel. Currently only ServingConfig are valid candidates.
An individual panel with a list of ServingConfigs to consider for it.
Represents an ordered combination of valid serving configs, which can be used for PAGE_OPTIMIZATION recommendations.
Output result that stores the information about where the exported data is stored.
Metadata related to the progress of the Purge operation. This will be returned by the google.longrunning.Operation.metadata field.
Metadata related to the progress of the PurgeProducts operation. This will be returned by the google.longrunning.Operation.metadata field.
Response of the PurgeProductsRequest. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.
Response of the PurgeUserEventsRequest. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.
Metadata for RejoinUserEvents method.
Response message for RejoinUserEvents method.
Metadata related to the progress of the RemoveFulfillmentPlaces operation. Currently empty because there is no meaningful metadata populated from the ProductService.RemoveFulfillmentPlaces method.
Response of the RemoveFulfillmentPlacesRequest. Currently empty because there is no meaningful response populated from the ProductService.RemoveFulfillmentPlaces method.
Metadata related to the progress of the RemoveLocalInventories operation. Currently empty because there is no meaningful metadata populated from the ProductService.RemoveLocalInventories method.
Response of the ProductService.RemoveLocalInventories API. Currently empty because there is no meaningful response populated from the ProductService.RemoveLocalInventories method.
Metadata related to the progress of the SetInventory operation. Currently empty because there is no meaningful metadata populated from the ProductService.SetInventory method.
Response of the SetInventoryRequest. Currently empty because there is no meaningful response populated from the ProductService.SetInventory method.
Metadata related to transform user events operation.
Metadata associated with a tune operation.
Response associated with a tune operation.
A summary of import result. The UserEventImportSummary summarizes the import status for user events.
Metadata related to the progress of the AddFulfillmentPlaces operation. Currently empty because there is no meaningful metadata populated from the ProductService.AddFulfillmentPlaces method.
Response of the AddFulfillmentPlacesRequest. Currently empty because there is no meaningful response populated from the ProductService.AddFulfillmentPlaces method.
Metadata related to the progress of the AddLocalInventories operation. Currently empty because there is no meaningful metadata populated from the ProductService.AddLocalInventories method.
Response of the ProductService.AddLocalInventories API. Currently empty because there is no meaningful response populated from the ProductService.AddLocalInventories method.
A BigQuery output result.
Metadata associated with a create operation.
Response of the ExportAnalyticsMetricsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.
Configuration of destination for Export related errors.
Metadata related to the progress of the Export operation. This is returned by the google.longrunning.Operation.metadata field.
Response of the ExportProductsRequest. If the long running operation is done, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.
Response of the ExportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.
A Gcs output result.
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.
Configuration of destination for Import related errors.
Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.
Response of the ImportProductsRequest. If the long running operation is done, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.
Response of the ImportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.
Metadata that describes the training and serving parameters of a Model. A Model can be associated with a ServingConfig and then queried through the Predict API.
Additional configs for the frequently-bought-together model type.
Additional model features config.
Represents an ordered combination of valid serving configs, which can be used for PAGE_OPTIMIZATION recommendations.
Output result that stores the information about where the exported data is stored.
Metadata related to the progress of the Purge operation. This will be returned by the google.longrunning.Operation.metadata field.
Metadata related to the progress of the PurgeProducts operation. This will be returned by the google.longrunning.Operation.metadata field.
Response of the PurgeProductsRequest. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.
Response of the PurgeUserEventsRequest. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.
Metadata for RejoinUserEvents method.
Response message for RejoinUserEvents method.
Metadata related to the progress of the RemoveFulfillmentPlaces operation. Currently empty because there is no meaningful metadata populated from the ProductService.RemoveFulfillmentPlaces method.
Response of the RemoveFulfillmentPlacesRequest. Currently empty because there is no meaningful response populated from the ProductService.RemoveFulfillmentPlaces method.
Metadata related to the progress of the RemoveLocalInventories operation. Currently empty because there is no meaningful metadata populated from the ProductService.RemoveLocalInventories method.
Response of the ProductService.RemoveLocalInventories API. Currently empty because there is no meaningful response populated from the ProductService.RemoveLocalInventories method.
Metadata related to the progress of the SetInventory operation. Currently empty because there is no meaningful metadata populated from the ProductService.SetInventory method.
Response of the SetInventoryRequest. Currently empty because there is no meaningful response populated from the ProductService.SetInventory method.
Metadata associated with a tune operation.
Response associated with a tune operation.
A summary of import result. The UserEventImportSummary summarizes the import status for user events.
The response message for Operations.ListOperations.
This resource represents a long-running operation that is the result of a network API call.
A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.
Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: A full date, with non-zero year, month, and day values. A month and day, with a zero year (for example, an anniversary). A year on its own, with a zero month and a zero day. A year and month, with a zero day (for example, a credit card expiration date). Related types: google.type.TimeOfDay google.type.DateTime * google.protobuf.Timestamp