Namespace Google.Apis.CloudRetail.v2alpha.Data

Classes

GoogleApiHttpBody

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.

GoogleCloudRetailLoggingErrorContext

A description of the context in which an error occurred.

GoogleCloudRetailLoggingErrorLog

An error log which is reported to the Error Reporting system. This proto a superset of google.devtools.clouderrorreporting.v1beta1.ReportedErrorEvent.

GoogleCloudRetailLoggingHttpRequestContext

HTTP request data that is related to a reported error.

GoogleCloudRetailLoggingImportErrorContext

The error payload that is populated on LRO import APIs, including "google.cloud.retail.v2.ProductService.ImportProducts" and "google.cloud.retail.v2.EventService.ImportUserEvents".

GoogleCloudRetailLoggingServiceContext

Describes a running service that sends errors.

GoogleCloudRetailLoggingSourceLocation

Indicates a location in the source code of the service for which errors are reported.

GoogleCloudRetailV2AddFulfillmentPlacesMetadata

Metadata related to the progress of the AddFulfillmentPlaces operation. Currently empty because there is no meaningful metadata populated from the ProductService.AddFulfillmentPlaces method.

GoogleCloudRetailV2AddFulfillmentPlacesResponse

Response of the AddFulfillmentPlacesRequest. Currently empty because there is no meaningful response populated from the ProductService.AddFulfillmentPlaces method.

GoogleCloudRetailV2AddLocalInventoriesMetadata

Metadata related to the progress of the AddLocalInventories operation. Currently empty because there is no meaningful metadata populated from the ProductService.AddLocalInventories method.

GoogleCloudRetailV2AddLocalInventoriesResponse

Response of the ProductService.AddLocalInventories API. Currently empty because there is no meaningful response populated from the ProductService.AddLocalInventories method.

GoogleCloudRetailV2BigQueryOutputResult

A BigQuery output result.

GoogleCloudRetailV2CreateModelMetadata

Metadata associated with a create operation.

GoogleCloudRetailV2ExportAnalyticsMetricsResponse

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.

GoogleCloudRetailV2ExportErrorsConfig

Configuration of destination for Export related errors.

GoogleCloudRetailV2ExportMetadata

Metadata related to the progress of the Export operation. This is returned by the google.longrunning.Operation.metadata field.

GoogleCloudRetailV2GcsOutputResult

A Gcs output result.

GoogleCloudRetailV2ImportCompletionDataResponse

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.

GoogleCloudRetailV2ImportErrorsConfig

Configuration of destination for Import related errors.

GoogleCloudRetailV2ImportMetadata

Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.

GoogleCloudRetailV2ImportProductsResponse

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.

GoogleCloudRetailV2ImportUserEventsResponse

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.

GoogleCloudRetailV2Model

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.

GoogleCloudRetailV2ModelFrequentlyBoughtTogetherFeaturesConfig

Additional configs for the frequently-bought-together model type.

GoogleCloudRetailV2ModelModelFeaturesConfig

Additional model features config.

GoogleCloudRetailV2ModelServingConfigList

Represents an ordered combination of valid serving configs, which can be used for PAGE_OPTIMIZATION recommendations.

GoogleCloudRetailV2OutputResult

Output result that stores the information about where the exported data is stored.

GoogleCloudRetailV2PurgeMetadata

Metadata related to the progress of the Purge operation. This will be returned by the google.longrunning.Operation.metadata field.

GoogleCloudRetailV2PurgeProductsMetadata

Metadata related to the progress of the PurgeProducts operation. This will be returned by the google.longrunning.Operation.metadata field.

GoogleCloudRetailV2PurgeProductsResponse

Response of the PurgeProductsRequest. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.

GoogleCloudRetailV2PurgeUserEventsResponse

Response of the PurgeUserEventsRequest. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.

GoogleCloudRetailV2RejoinUserEventsMetadata

Metadata for RejoinUserEvents method.

GoogleCloudRetailV2RejoinUserEventsResponse

Response message for RejoinUserEvents method.

GoogleCloudRetailV2RemoveFulfillmentPlacesMetadata

Metadata related to the progress of the RemoveFulfillmentPlaces operation. Currently empty because there is no meaningful metadata populated from the ProductService.RemoveFulfillmentPlaces method.

GoogleCloudRetailV2RemoveFulfillmentPlacesResponse

Response of the RemoveFulfillmentPlacesRequest. Currently empty because there is no meaningful response populated from the ProductService.RemoveFulfillmentPlaces method.

GoogleCloudRetailV2RemoveLocalInventoriesMetadata

Metadata related to the progress of the RemoveLocalInventories operation. Currently empty because there is no meaningful metadata populated from the ProductService.RemoveLocalInventories method.

GoogleCloudRetailV2RemoveLocalInventoriesResponse

Response of the ProductService.RemoveLocalInventories API. Currently empty because there is no meaningful response populated from the ProductService.RemoveLocalInventories method.

GoogleCloudRetailV2SetInventoryMetadata

Metadata related to the progress of the SetInventory operation. Currently empty because there is no meaningful metadata populated from the ProductService.SetInventory method.

GoogleCloudRetailV2SetInventoryResponse

Response of the SetInventoryRequest. Currently empty because there is no meaningful response populated from the ProductService.SetInventory method.

GoogleCloudRetailV2TuneModelMetadata

Metadata associated with a tune operation.

GoogleCloudRetailV2TuneModelResponse

Response associated with a tune operation.

GoogleCloudRetailV2UserEventImportSummary

A summary of import result. The UserEventImportSummary summarizes the import status for user events.

GoogleCloudRetailV2alphaAcceptTermsRequest

Request for AcceptTerms method.

GoogleCloudRetailV2alphaAddCatalogAttributeRequest

Request for CatalogService.AddCatalogAttribute method.

GoogleCloudRetailV2alphaAddControlRequest

Request for AddControl method.

GoogleCloudRetailV2alphaAddFulfillmentPlacesMetadata

Metadata related to the progress of the AddFulfillmentPlaces operation. Currently empty because there is no meaningful metadata populated from the ProductService.AddFulfillmentPlaces method.

GoogleCloudRetailV2alphaAddFulfillmentPlacesRequest

Request message for ProductService.AddFulfillmentPlaces method.

GoogleCloudRetailV2alphaAddFulfillmentPlacesResponse

Response of the AddFulfillmentPlacesRequest. Currently empty because there is no meaningful response populated from the ProductService.AddFulfillmentPlaces method.

GoogleCloudRetailV2alphaAddLocalInventoriesMetadata

Metadata related to the progress of the AddLocalInventories operation. Currently empty because there is no meaningful metadata populated from the ProductService.AddLocalInventories method.

GoogleCloudRetailV2alphaAddLocalInventoriesRequest

Request message for ProductService.AddLocalInventories method.

GoogleCloudRetailV2alphaAddLocalInventoriesResponse

Response of the ProductService.AddLocalInventories API. Currently empty because there is no meaningful response populated from the ProductService.AddLocalInventories method.

GoogleCloudRetailV2alphaAlertConfig

Project level alert config.

GoogleCloudRetailV2alphaAlertConfigAlertPolicy

Alert policy for a customer.

GoogleCloudRetailV2alphaAlertConfigAlertPolicyRecipient

Recipient contact information.

GoogleCloudRetailV2alphaAttributesConfig

Catalog level attribute config.

GoogleCloudRetailV2alphaAudience

An intended audience of the Product for whom it's sold.

GoogleCloudRetailV2alphaBatchRemoveCatalogAttributesRequest

Request for CatalogService.BatchRemoveCatalogAttributes method.

GoogleCloudRetailV2alphaBatchRemoveCatalogAttributesResponse

Response of the CatalogService.BatchRemoveCatalogAttributes.

GoogleCloudRetailV2alphaBatchUpdateGenerativeQuestionConfigsRequest

Request for BatchUpdateGenerativeQuestionConfig method.

GoogleCloudRetailV2alphaBatchUpdateGenerativeQuestionConfigsResponse

Aggregated response for UpdateGenerativeQuestionConfig method.

GoogleCloudRetailV2alphaBigQueryOutputResult

A BigQuery output result.

GoogleCloudRetailV2alphaBigQuerySource

BigQuery source import data from.

GoogleCloudRetailV2alphaBranch

A data branch that stores all instances of Products.

GoogleCloudRetailV2alphaBranchProductCountStatistic

A statistic about the number of products in a branch.

GoogleCloudRetailV2alphaBranchQualityMetric

Metric measured on a group of Products against a certain quality requirement. Contains the number of products that pass the check and the number of products that don't.

GoogleCloudRetailV2alphaCatalog

The catalog configuration.

GoogleCloudRetailV2alphaCatalogAttribute

Catalog level attribute config for an attribute. For example, if customers want to enable/disable facet for a specific attribute.

GoogleCloudRetailV2alphaCatalogAttributeFacetConfig

Possible options for the facet that corresponds to the current attribute config.

GoogleCloudRetailV2alphaCatalogAttributeFacetConfigIgnoredFacetValues

Facet values to ignore on facets during the specified time range for the given SearchResponse.Facet.key attribute.

GoogleCloudRetailV2alphaCatalogAttributeFacetConfigMergedFacet

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).

GoogleCloudRetailV2alphaCatalogAttributeFacetConfigMergedFacetValue

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.

GoogleCloudRetailV2alphaCatalogAttributeFacetConfigRerankConfig

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).

GoogleCloudRetailV2alphaCollectUserEventRequest

Request message for CollectUserEvent method.

GoogleCloudRetailV2alphaColorInfo

The color information of a Product.

GoogleCloudRetailV2alphaCompleteQueryResponse

Response of the autocomplete query.

GoogleCloudRetailV2alphaCompleteQueryResponseAttributeResult

Resource that represents attribute results.

GoogleCloudRetailV2alphaCompleteQueryResponseCompletionResult

Resource that represents completion results.

GoogleCloudRetailV2alphaCompleteQueryResponseRecentSearchResult

Deprecated: Recent search of this user.

GoogleCloudRetailV2alphaCompletionConfig

Catalog level autocomplete config for customers to customize autocomplete feature's settings.

GoogleCloudRetailV2alphaCompletionDataInputConfig

The input config source for completion data.

GoogleCloudRetailV2alphaCompletionDetail

Detailed completion information including completion attribution token and clicked completion info.

GoogleCloudRetailV2alphaCondition

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.

GoogleCloudRetailV2alphaConditionQueryTerm

Query terms that we want to match on.

GoogleCloudRetailV2alphaConditionTimeRange

Used for time-dependent conditions. Example: Want to have rule applied for week long sale.

GoogleCloudRetailV2alphaControl

Configures dynamic metadata that can be linked to a ServingConfig and affect search or recommendation results at serving time.

GoogleCloudRetailV2alphaConversationalSearchRequest

Request message for ConversationalSearchService.ConversationalSearch method.

GoogleCloudRetailV2alphaConversationalSearchRequestConversationalFilteringSpec

This field specifies all conversational filtering related parameters addition to conversational retail search.

GoogleCloudRetailV2alphaConversationalSearchRequestSearchParams

Search parameters.

GoogleCloudRetailV2alphaConversationalSearchRequestUserAnswer

This field specifies the current user answer during the conversational filtering search. This can be either user selected from suggested answers or user input plain text.

GoogleCloudRetailV2alphaConversationalSearchRequestUserAnswerSelectedAnswer

This field specifies the selected answers during the conversational search.

GoogleCloudRetailV2alphaConversationalSearchResponse

Response message for ConversationalSearchService.ConversationalSearch method.

GoogleCloudRetailV2alphaConversationalSearchResponseConversationalFilteringResult

This field specifies all related information that is needed on client side for UI rendering of conversational filtering search.

GoogleCloudRetailV2alphaConversationalSearchResponseConversationalFilteringResultAdditionalFilter

Additional filter that client side need to apply.

GoogleCloudRetailV2alphaConversationalSearchResponseFollowupQuestion

The conversational followup question generated for Intent refinement.

GoogleCloudRetailV2alphaConversationalSearchResponseFollowupQuestionSuggestedAnswer

Suggested answers to the follow-up question. If it's numerical attribute, only ProductAttributeInterval will be set. If it's textual attribute, only productAttributeValue will be set.

GoogleCloudRetailV2alphaConversationalSearchResponseRefinedSearch

The proposed refined search for intent-refinement/bundled shopping conversation. When using CONVERSATIONAL_FILTER_ONLY mode, the refined_query from search response will be populated here.

GoogleCloudRetailV2alphaCreateMerchantCenterAccountLinkMetadata

Common metadata related to the progress of the operations.

GoogleCloudRetailV2alphaCreateModelMetadata

Metadata associated with a create operation.

GoogleCloudRetailV2alphaCustomAttribute

A custom attribute that is not explicitly modeled in Product.

GoogleCloudRetailV2alphaDoubleList

A message with a list of double values.

GoogleCloudRetailV2alphaEnrollSolutionMetadata

Metadata related to the EnrollSolution method. This will be returned by the google.longrunning.Operation.metadata field.

GoogleCloudRetailV2alphaEnrollSolutionRequest

Request for EnrollSolution method.

GoogleCloudRetailV2alphaEnrollSolutionResponse

Response for EnrollSolution method.

GoogleCloudRetailV2alphaExperimentInfo

Metadata for active A/B testing experiment.

GoogleCloudRetailV2alphaExperimentInfoServingConfigExperiment

Metadata for active serving config A/B tests.

GoogleCloudRetailV2alphaExportAnalyticsMetricsRequest

Request message for the ExportAnalyticsMetrics method.

GoogleCloudRetailV2alphaExportAnalyticsMetricsResponse

GoogleCloudRetailV2alphaExportErrorsConfig

Configuration of destination for Export related errors.

GoogleCloudRetailV2alphaExportMetadata

Metadata related to the progress of the Export operation. This is returned by the google.longrunning.Operation.metadata field.

GoogleCloudRetailV2alphaExportProductsRequest

Request message for ExportProducts method.

GoogleCloudRetailV2alphaExportProductsResponse

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.

GoogleCloudRetailV2alphaExportUserEventsRequest

Request message for the ExportUserEvents method.

GoogleCloudRetailV2alphaExportUserEventsResponse

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.

GoogleCloudRetailV2alphaFulfillmentInfo

Fulfillment information, such as the store IDs for in-store pickup or region IDs for different shipping methods.

GoogleCloudRetailV2alphaGcsOutputResult

A Gcs output result.

GoogleCloudRetailV2alphaGcsSource

Google Cloud Storage location for input content.

GoogleCloudRetailV2alphaGenerativeQuestionConfig

Configuration for a single generated question.

GoogleCloudRetailV2alphaGenerativeQuestionsFeatureConfig

Configuration for overall generative question feature state.

GoogleCloudRetailV2alphaGetDefaultBranchResponse

Response message of CatalogService.GetDefaultBranch.

GoogleCloudRetailV2alphaImage

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.

GoogleCloudRetailV2alphaImportCompletionDataRequest

Request message for ImportCompletionData methods.

GoogleCloudRetailV2alphaImportCompletionDataResponse

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.

GoogleCloudRetailV2alphaImportErrorsConfig

Configuration of destination for Import related errors.

GoogleCloudRetailV2alphaImportMetadata

Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.

GoogleCloudRetailV2alphaImportProductsRequest

Request message for Import methods.

GoogleCloudRetailV2alphaImportProductsResponse

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.

GoogleCloudRetailV2alphaImportUserEventsRequest

Request message for the ImportUserEvents request.

GoogleCloudRetailV2alphaImportUserEventsResponse

GoogleCloudRetailV2alphaInterval

A floating point interval.

GoogleCloudRetailV2alphaListBranchesResponse

Response for BranchService.ListBranches method.

GoogleCloudRetailV2alphaListCatalogsResponse

Response for CatalogService.ListCatalogs method.

GoogleCloudRetailV2alphaListControlsResponse

Response for ListControls method.

GoogleCloudRetailV2alphaListEnrolledSolutionsResponse

Response for ListEnrolledSolutions method.

GoogleCloudRetailV2alphaListGenerativeQuestionConfigsResponse

Response for ListQuestions method.

GoogleCloudRetailV2alphaListMerchantCenterAccountLinksResponse

Response for MerchantCenterAccountLinkService.ListMerchantCenterAccountLinks method.

GoogleCloudRetailV2alphaListModelsResponse

Response to a ListModelRequest.

GoogleCloudRetailV2alphaListProductsResponse

Response message for ProductService.ListProducts method.

GoogleCloudRetailV2alphaListServingConfigsResponse

Response for ListServingConfigs method.

GoogleCloudRetailV2alphaLocalInventory

The inventory information at a place (e.g. a store) identified by a place ID.

GoogleCloudRetailV2alphaLoggingConfig

Project level logging config to control what level of log will be generated and written to Cloud Logging.

GoogleCloudRetailV2alphaLoggingConfigLogGenerationRule

The logging configurations for services supporting log generation.

GoogleCloudRetailV2alphaLoggingConfigServiceLogGenerationRule

The granular logging configurations for supported services.

GoogleCloudRetailV2alphaMerchantCenterAccountLink

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.

GoogleCloudRetailV2alphaMerchantCenterAccountLinkMerchantCenterFeedFilter

Merchant Center Feed filter criterion.

GoogleCloudRetailV2alphaMerchantCenterFeedFilter

Merchant Center Feed filter criterion.

GoogleCloudRetailV2alphaMerchantCenterLink

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.

GoogleCloudRetailV2alphaMerchantCenterLinkingConfig

Configures Merchant Center linking. Links contained in the config will be used to sync data from a Merchant Center account to a Cloud Retail branch.

GoogleCloudRetailV2alphaModel

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.

GoogleCloudRetailV2alphaModelFrequentlyBoughtTogetherFeaturesConfig

Additional configs for the frequently-bought-together model type.

GoogleCloudRetailV2alphaModelModelFeaturesConfig

Additional model features config.

GoogleCloudRetailV2alphaModelPageOptimizationConfig

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.

GoogleCloudRetailV2alphaModelPageOptimizationConfigCandidate

A candidate to consider for a given panel. Currently only ServingConfig are valid candidates.

GoogleCloudRetailV2alphaModelPageOptimizationConfigPanel

An individual panel with a list of ServingConfigs to consider for it.

GoogleCloudRetailV2alphaModelServingConfigList

Represents an ordered combination of valid serving configs, which can be used for PAGE_OPTIMIZATION recommendations.

GoogleCloudRetailV2alphaOutputConfig

The output configuration setting.

GoogleCloudRetailV2alphaOutputConfigBigQueryDestination

The BigQuery output destination configuration.

GoogleCloudRetailV2alphaOutputConfigGcsDestination

The Google Cloud Storage output destination configuration.

GoogleCloudRetailV2alphaOutputResult

Output result that stores the information about where the exported data is stored.

GoogleCloudRetailV2alphaPauseModelRequest

Request for pausing training of a model.

GoogleCloudRetailV2alphaPinControlMetadata

Metadata for pinning to be returned in the response. This is used for distinguishing between applied vs dropped pins.

GoogleCloudRetailV2alphaPinControlMetadataProductPins

List of product ids which have associated pins.

GoogleCloudRetailV2alphaPredictRequest

Request message for Predict method.

GoogleCloudRetailV2alphaPredictResponse

Response message for predict method.

GoogleCloudRetailV2alphaPredictResponsePredictionResult

PredictionResult represents the recommendation prediction results.

GoogleCloudRetailV2alphaPriceInfo

The price information of a Product.

GoogleCloudRetailV2alphaPriceInfoPriceRange

The price range of all variant Product having the same Product.primary_product_id.

GoogleCloudRetailV2alphaProduct

Product captures all metadata information of items to be recommended or searched.

GoogleCloudRetailV2alphaProductAttributeInterval

Product attribute name and numeric interval.

GoogleCloudRetailV2alphaProductAttributeValue

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.

GoogleCloudRetailV2alphaProductDetail

Detailed product information associated with a user event.

GoogleCloudRetailV2alphaProductInlineSource

The inline source for the input config for ImportProducts method.

GoogleCloudRetailV2alphaProductInputConfig

The input config source for products.

GoogleCloudRetailV2alphaProductLevelConfig

Configures what level the product should be uploaded with regards to how users will be send events and how predictions will be made.

GoogleCloudRetailV2alphaProject

Metadata that describes a Cloud Retail Project.

GoogleCloudRetailV2alphaPromotion

Promotion specification.

GoogleCloudRetailV2alphaPurchaseTransaction

A transaction represents the entire purchase transaction.

GoogleCloudRetailV2alphaPurgeMetadata

Metadata related to the progress of the Purge operation. This will be returned by the google.longrunning.Operation.metadata field.

GoogleCloudRetailV2alphaPurgeProductsMetadata

Metadata related to the progress of the PurgeProducts operation. This will be returned by the google.longrunning.Operation.metadata field.

GoogleCloudRetailV2alphaPurgeProductsRequest

Request message for PurgeProducts method.

GoogleCloudRetailV2alphaPurgeProductsResponse

Response of the PurgeProductsRequest. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.

GoogleCloudRetailV2alphaPurgeUserEventsRequest

Request message for PurgeUserEvents method.

GoogleCloudRetailV2alphaPurgeUserEventsResponse

Response of the PurgeUserEventsRequest. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.

GoogleCloudRetailV2alphaRating

The rating of a Product.

GoogleCloudRetailV2alphaRejoinUserEventsMetadata

Metadata for RejoinUserEvents method.

GoogleCloudRetailV2alphaRejoinUserEventsRequest

Request message for RejoinUserEvents method.

GoogleCloudRetailV2alphaRejoinUserEventsResponse

Response message for RejoinUserEvents method.

GoogleCloudRetailV2alphaRemoveCatalogAttributeRequest

Request for CatalogService.RemoveCatalogAttribute method.

GoogleCloudRetailV2alphaRemoveControlRequest

Request for RemoveControl method.

GoogleCloudRetailV2alphaRemoveFulfillmentPlacesMetadata

Metadata related to the progress of the RemoveFulfillmentPlaces operation. Currently empty because there is no meaningful metadata populated from the ProductService.RemoveFulfillmentPlaces method.

GoogleCloudRetailV2alphaRemoveFulfillmentPlacesRequest

Request message for ProductService.RemoveFulfillmentPlaces method.

GoogleCloudRetailV2alphaRemoveFulfillmentPlacesResponse

Response of the RemoveFulfillmentPlacesRequest. Currently empty because there is no meaningful response populated from the ProductService.RemoveFulfillmentPlaces method.

GoogleCloudRetailV2alphaRemoveLocalInventoriesMetadata

Metadata related to the progress of the RemoveLocalInventories operation. Currently empty because there is no meaningful metadata populated from the ProductService.RemoveLocalInventories method.

GoogleCloudRetailV2alphaRemoveLocalInventoriesRequest

Request message for ProductService.RemoveLocalInventories method.

GoogleCloudRetailV2alphaRemoveLocalInventoriesResponse

Response of the ProductService.RemoveLocalInventories API. Currently empty because there is no meaningful response populated from the ProductService.RemoveLocalInventories method.

GoogleCloudRetailV2alphaReplaceCatalogAttributeRequest

Request for CatalogService.ReplaceCatalogAttribute method.

GoogleCloudRetailV2alphaResumeModelRequest

Request for resuming training of a model.

GoogleCloudRetailV2alphaRule

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.

GoogleCloudRetailV2alphaRuleBoostAction

A boost action to apply to results matching condition specified above.

GoogleCloudRetailV2alphaRuleDoNotAssociateAction

Prevents query_term from being associated with specified terms during search. Example: Don't associate "gShoe" and "cheap".

GoogleCloudRetailV2alphaRuleFilterAction

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.

GoogleCloudRetailV2alphaRuleForceReturnFacetAction

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.

GoogleCloudRetailV2alphaRuleForceReturnFacetActionFacetPositionAdjustment

Each facet position adjustment consists of a single attribute name (i.e. facet key) along with a specified position.

GoogleCloudRetailV2alphaRuleIgnoreAction

Prevents a term in the query from being used in search. Example: Don't search for "shoddy".

GoogleCloudRetailV2alphaRuleOnewaySynonymsAction

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".

GoogleCloudRetailV2alphaRulePinAction

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.

GoogleCloudRetailV2alphaRuleRedirectAction

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.

GoogleCloudRetailV2alphaRuleRemoveFacetAction

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).

GoogleCloudRetailV2alphaRuleReplacementAction

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".

GoogleCloudRetailV2alphaRuleTwowaySynonymsAction

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".

GoogleCloudRetailV2alphaSearchRequest

Request message for SearchService.Search method.

GoogleCloudRetailV2alphaSearchRequestBoostSpec

Boost specification to boost certain items.

GoogleCloudRetailV2alphaSearchRequestBoostSpecConditionBoostSpec

Boost applies to products which match a condition.

GoogleCloudRetailV2alphaSearchRequestConversationalSearchSpec

This field specifies all conversational related parameters addition to traditional retail search.

GoogleCloudRetailV2alphaSearchRequestConversationalSearchSpecUserAnswer

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.

GoogleCloudRetailV2alphaSearchRequestConversationalSearchSpecUserAnswerSelectedAnswer

This field specifies the selected answers during the conversational search.

GoogleCloudRetailV2alphaSearchRequestDynamicFacetSpec

The specifications of dynamically generated facets.

GoogleCloudRetailV2alphaSearchRequestFacetSpec

A facet specification to perform faceted search.

GoogleCloudRetailV2alphaSearchRequestFacetSpecFacetKey

Specifies how a facet is computed.

GoogleCloudRetailV2alphaSearchRequestPersonalizationSpec

The specification for personalization.

GoogleCloudRetailV2alphaSearchRequestQueryExpansionSpec

Specification to determine under which conditions query expansion should occur.

GoogleCloudRetailV2alphaSearchRequestSpellCorrectionSpec

The specification for query spell correction.

GoogleCloudRetailV2alphaSearchRequestTileNavigationSpec

This field specifies tile navigation related parameters.

GoogleCloudRetailV2alphaSearchResponse

Response message for SearchService.Search method.

GoogleCloudRetailV2alphaSearchResponseConversationalSearchResult

This field specifies all related information that is needed on client side for UI rendering of conversational retail search.

GoogleCloudRetailV2alphaSearchResponseConversationalSearchResultAdditionalFilter

Additional filter that client side need to apply.

GoogleCloudRetailV2alphaSearchResponseConversationalSearchResultSuggestedAnswer

Suggested answers to the follow-up question.

GoogleCloudRetailV2alphaSearchResponseFacet

A facet result.

GoogleCloudRetailV2alphaSearchResponseFacetFacetValue

A facet value which contains value names and their count.

GoogleCloudRetailV2alphaSearchResponseQueryExpansionInfo

Information describing query expansion including whether expansion has occurred.

GoogleCloudRetailV2alphaSearchResponseSearchResult

Represents the search results.

GoogleCloudRetailV2alphaSearchResponseTileNavigationResult

This field specifies all related information for tile navigation that will be used in client side.

GoogleCloudRetailV2alphaServingConfig

Configures metadata that is used to generate serving time results (e.g. search results or recommendation predictions).

GoogleCloudRetailV2alphaSetDefaultBranchRequest

Request message to set a specified branch as new default_branch.

GoogleCloudRetailV2alphaSetInventoryMetadata

Metadata related to the progress of the SetInventory operation. Currently empty because there is no meaningful metadata populated from the ProductService.SetInventory method.

GoogleCloudRetailV2alphaSetInventoryRequest

Request message for ProductService.SetInventory method.

GoogleCloudRetailV2alphaSetInventoryResponse

Response of the SetInventoryRequest. Currently empty because there is no meaningful response populated from the ProductService.SetInventory method.

GoogleCloudRetailV2alphaStringList

A list of string values.

GoogleCloudRetailV2alphaTile

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.

GoogleCloudRetailV2alphaTransformedUserEventsMetadata

Metadata related to transform user events operation.

GoogleCloudRetailV2alphaTuneModelMetadata

Metadata associated with a tune operation.

GoogleCloudRetailV2alphaTuneModelRequest

Request to manually start a tuning process now (instead of waiting for the periodically scheduled tuning to happen).

GoogleCloudRetailV2alphaTuneModelResponse

Response associated with a tune operation.

GoogleCloudRetailV2alphaUpdateGenerativeQuestionConfigRequest

Request for UpdateGenerativeQuestionConfig method.

GoogleCloudRetailV2alphaUserEvent

UserEvent captures all metadata information Retail API needs to know about how end users interact with customers' website.

GoogleCloudRetailV2alphaUserEventImportSummary

A summary of import result. The UserEventImportSummary summarizes the import status for user events.

GoogleCloudRetailV2alphaUserEventInlineSource

The inline source for the input config for ImportUserEvents method.

GoogleCloudRetailV2alphaUserEventInputConfig

The input config source for user events.

GoogleCloudRetailV2alphaUserInfo

Information of an end user.

GoogleCloudRetailV2betaAddFulfillmentPlacesMetadata

Metadata related to the progress of the AddFulfillmentPlaces operation. Currently empty because there is no meaningful metadata populated from the ProductService.AddFulfillmentPlaces method.

GoogleCloudRetailV2betaAddFulfillmentPlacesResponse

Response of the AddFulfillmentPlacesRequest. Currently empty because there is no meaningful response populated from the ProductService.AddFulfillmentPlaces method.

GoogleCloudRetailV2betaAddLocalInventoriesMetadata

Metadata related to the progress of the AddLocalInventories operation. Currently empty because there is no meaningful metadata populated from the ProductService.AddLocalInventories method.

GoogleCloudRetailV2betaAddLocalInventoriesResponse

Response of the ProductService.AddLocalInventories API. Currently empty because there is no meaningful response populated from the ProductService.AddLocalInventories method.

GoogleCloudRetailV2betaBigQueryOutputResult

A BigQuery output result.

GoogleCloudRetailV2betaCreateModelMetadata

Metadata associated with a create operation.

GoogleCloudRetailV2betaExportAnalyticsMetricsResponse

GoogleCloudRetailV2betaExportErrorsConfig

Configuration of destination for Export related errors.

GoogleCloudRetailV2betaExportMetadata

Metadata related to the progress of the Export operation. This is returned by the google.longrunning.Operation.metadata field.

GoogleCloudRetailV2betaExportProductsResponse

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.

GoogleCloudRetailV2betaExportUserEventsResponse

GoogleCloudRetailV2betaGcsOutputResult

A Gcs output result.

GoogleCloudRetailV2betaImportCompletionDataResponse

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.

GoogleCloudRetailV2betaImportErrorsConfig

Configuration of destination for Import related errors.

GoogleCloudRetailV2betaImportMetadata

Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.

GoogleCloudRetailV2betaImportProductsResponse

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.

GoogleCloudRetailV2betaImportUserEventsResponse

GoogleCloudRetailV2betaModel

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.

GoogleCloudRetailV2betaModelFrequentlyBoughtTogetherFeaturesConfig

Additional configs for the frequently-bought-together model type.

GoogleCloudRetailV2betaModelModelFeaturesConfig

Additional model features config.

GoogleCloudRetailV2betaModelServingConfigList

Represents an ordered combination of valid serving configs, which can be used for PAGE_OPTIMIZATION recommendations.

GoogleCloudRetailV2betaOutputResult

Output result that stores the information about where the exported data is stored.

GoogleCloudRetailV2betaPurgeMetadata

Metadata related to the progress of the Purge operation. This will be returned by the google.longrunning.Operation.metadata field.

GoogleCloudRetailV2betaPurgeProductsMetadata

Metadata related to the progress of the PurgeProducts operation. This will be returned by the google.longrunning.Operation.metadata field.

GoogleCloudRetailV2betaPurgeProductsResponse

Response of the PurgeProductsRequest. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.

GoogleCloudRetailV2betaPurgeUserEventsResponse

Response of the PurgeUserEventsRequest. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.

GoogleCloudRetailV2betaRejoinUserEventsMetadata

Metadata for RejoinUserEvents method.

GoogleCloudRetailV2betaRejoinUserEventsResponse

Response message for RejoinUserEvents method.

GoogleCloudRetailV2betaRemoveFulfillmentPlacesMetadata

Metadata related to the progress of the RemoveFulfillmentPlaces operation. Currently empty because there is no meaningful metadata populated from the ProductService.RemoveFulfillmentPlaces method.

GoogleCloudRetailV2betaRemoveFulfillmentPlacesResponse

Response of the RemoveFulfillmentPlacesRequest. Currently empty because there is no meaningful response populated from the ProductService.RemoveFulfillmentPlaces method.

GoogleCloudRetailV2betaRemoveLocalInventoriesMetadata

Metadata related to the progress of the RemoveLocalInventories operation. Currently empty because there is no meaningful metadata populated from the ProductService.RemoveLocalInventories method.

GoogleCloudRetailV2betaRemoveLocalInventoriesResponse

Response of the ProductService.RemoveLocalInventories API. Currently empty because there is no meaningful response populated from the ProductService.RemoveLocalInventories method.

GoogleCloudRetailV2betaSetInventoryMetadata

Metadata related to the progress of the SetInventory operation. Currently empty because there is no meaningful metadata populated from the ProductService.SetInventory method.

GoogleCloudRetailV2betaSetInventoryResponse

Response of the SetInventoryRequest. Currently empty because there is no meaningful response populated from the ProductService.SetInventory method.

GoogleCloudRetailV2betaTuneModelMetadata

Metadata associated with a tune operation.

GoogleCloudRetailV2betaTuneModelResponse

Response associated with a tune operation.

GoogleCloudRetailV2betaUserEventImportSummary

A summary of import result. The UserEventImportSummary summarizes the import status for user events.

GoogleLongrunningListOperationsResponse

The response message for Operations.ListOperations.

GoogleLongrunningOperation

This resource represents a long-running operation that is the result of a network API call.

GoogleProtobufEmpty

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); }

GoogleRpcStatus

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.

GoogleTypeDate

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