Package google.cloud.retail.v2alpha

Index

• AnalyticsService (interface)
• BranchService (interface)
• CatalogService (interface)
• CompletionService (interface)
• ControlService (interface)
• GenerativeQuestionService (interface)
• MerchantCenterAccountLinkService (interface)
• ModelService (interface)
• PredictionService (interface)
• ProductService (interface)
• ProjectService (interface)
• SearchService (interface)
• ServingConfigService (interface)
• UserEventService (interface)
• AcceptTermsRequest (message)
• AddCatalogAttributeRequest (message)
• AddControlRequest (message)
• AddFulfillmentPlacesMetadata (message)
• AddFulfillmentPlacesRequest (message)
• AddFulfillmentPlacesResponse (message)
• AddLocalInventoriesMetadata (message)
• AddLocalInventoriesRequest (message)
• AddLocalInventoriesResponse (message)
• AlertConfig (message)
• AlertConfig.AlertPolicy (message)
• AlertConfig.AlertPolicy.EnrollStatus (enum)
• AlertConfig.AlertPolicy.Recipient (message)
• AttributeConfigLevel (enum)
• AttributesConfig (message)
• Audience (message)
• BatchRemoveCatalogAttributesRequest (message)
• BatchRemoveCatalogAttributesResponse (message)
• BigQueryOutputResult (message)
• BigQuerySource (message)
• Branch (message)
• Branch.ProductCountStatistic (message)
• Branch.ProductCountStatistic.ProductCountScope (enum)
• Branch.QualityMetric (message)
• BranchView (enum)
• Catalog (message)
• CatalogAttribute (message)
• CatalogAttribute.AttributeType (enum)
• CatalogAttribute.DynamicFacetableOption (enum)
• CatalogAttribute.ExactSearchableOption (enum)
• CatalogAttribute.FacetConfig (message)
• CatalogAttribute.FacetConfig.IgnoredFacetValues (message)
• CatalogAttribute.FacetConfig.MergedFacet (message)
• CatalogAttribute.FacetConfig.MergedFacetValue (message)
• CatalogAttribute.FacetConfig.RerankConfig (message)
• CatalogAttribute.IndexableOption (enum)
• CatalogAttribute.RetrievableOption (enum)
• CatalogAttribute.SearchableOption (enum)
• CollectUserEventRequest (message)
• ColorInfo (message)
• CompleteQueryRequest (message)
• CompleteQueryResponse (message)
• CompleteQueryResponse.AttributeResult (message)
• CompleteQueryResponse.CompletionResult (message)
• CompleteQueryResponse.RecentSearchResult (message) (deprecated)
• CompletionConfig (message)
• CompletionDataInputConfig (message)
• CompletionDetail (message)
• Condition (message)
• Condition.QueryTerm (message)
• Condition.TimeRange (message)
• Control (message)
• CreateControlRequest (message)
• CreateMerchantCenterAccountLinkMetadata (message)
• CreateMerchantCenterAccountLinkRequest (message)
• CreateModelMetadata (message)
• CreateModelRequest (message)
• CreateProductRequest (message)
• CreateServingConfigRequest (message)
• CustomAttribute (message)
• DeleteControlRequest (message)
• DeleteMerchantCenterAccountLinkRequest (message)
• DeleteModelRequest (message)
• DeleteProductRequest (message)
• DeleteServingConfigRequest (message)
• EnrollSolutionMetadata (message)
• EnrollSolutionRequest (message)
• EnrollSolutionResponse (message)
• ExperimentInfo (message)
• ExperimentInfo.ServingConfigExperiment (message)
• ExportAnalyticsMetricsRequest (message)
• ExportAnalyticsMetricsResponse (message)
• ExportErrorsConfig (message)
• ExportMetadata (message)
• ExportProductsRequest (message)
• ExportProductsResponse (message)
• ExportUserEventsRequest (message)
• ExportUserEventsResponse (message)
• FulfillmentInfo (message)
• GcsOutputResult (message)
• GcsSource (message)
• GetAlertConfigRequest (message)
• GetAttributesConfigRequest (message)
• GetBranchRequest (message)
• GetCompletionConfigRequest (message)
• GetControlRequest (message)
• GetDefaultBranchRequest (message)
• GetDefaultBranchResponse (message)
• GetLoggingConfigRequest (message)
• GetModelRequest (message)
• GetProductRequest (message)
• GetProjectRequest (message)
• GetServingConfigRequest (message)
• Image (message)
• ImportCompletionDataRequest (message)
• ImportCompletionDataResponse (message)
• ImportErrorsConfig (message)
• ImportMetadata (message)
• ImportProductsRequest (message)
• ImportProductsRequest.ReconciliationMode (enum)
• ImportProductsResponse (message)
• ImportUserEventsRequest (message)
• ImportUserEventsResponse (message)
• Interval (message)
• ListBranchesRequest (message)
• ListBranchesResponse (message)
• ListCatalogsRequest (message)
• ListCatalogsResponse (message)
• ListControlsRequest (message)
• ListControlsResponse (message)
• ListEnrolledSolutionsRequest (message)
• ListEnrolledSolutionsResponse (message)
• ListMerchantCenterAccountLinksRequest (message)
• ListMerchantCenterAccountLinksResponse (message)
• ListModelsRequest (message)
• ListModelsResponse (message)
• ListProductsRequest (message)
• ListProductsResponse (message)
• ListServingConfigsRequest (message)
• ListServingConfigsResponse (message)
• LocalInventory (message)
• LoggingConfig (message)
• LoggingConfig.LogGenerationRule (message)
• LoggingConfig.LoggingLevel (enum)
• LoggingConfig.ServiceLogGenerationRule (message)
• MerchantCenterAccountLink (message)
• MerchantCenterAccountLink.MerchantCenterFeedFilter (message)
• MerchantCenterAccountLink.State (enum)
• MerchantCenterFeedFilter (message)
• MerchantCenterLink (message)
• MerchantCenterLinkingConfig (message)
• Model (message)
• Model.ContextProductsType (enum)
• Model.DataState (enum)
• Model.FrequentlyBoughtTogetherFeaturesConfig (message)
• Model.ModelFeaturesConfig (message)
• Model.PageOptimizationConfig (message)
• Model.PageOptimizationConfig.Candidate (message)
• Model.PageOptimizationConfig.Panel (message)
• Model.PageOptimizationConfig.Restriction (enum)
• Model.PeriodicTuningState (enum)
• Model.ServingConfigList (message)
• Model.ServingState (enum)
• Model.TrainingState (enum)
• OutputConfig (message)
• OutputConfig.BigQueryDestination (message)
• OutputConfig.GcsDestination (message)
• OutputResult (message)
• PauseModelRequest (message)
• PredictRequest (message)
• PredictResponse (message)
• PredictResponse.PredictionResult (message)
• PriceInfo (message)
• PriceInfo.PriceRange (message)
• Product (message)
• Product.Availability (enum)
• Product.Type (enum)
• ProductAttributeInterval (message)
• ProductAttributeValue (message)
• ProductDetail (message)
• ProductInlineSource (message)
• ProductInputConfig (message)
• ProductLevelConfig (message)
• Project (message)
• Promotion (message)
• PurchaseTransaction (message)
• PurgeMetadata (message)
• PurgeProductsMetadata (message)
• PurgeProductsRequest (message)
• PurgeProductsResponse (message)
• PurgeUserEventsRequest (message)
• PurgeUserEventsResponse (message)
• Rating (message)
• RecommendationsFilteringOption (enum)
• RejoinUserEventsMetadata (message)
• RejoinUserEventsRequest (message)
• RejoinUserEventsRequest.UserEventRejoinScope (enum)
• RejoinUserEventsResponse (message)
• RemoveCatalogAttributeRequest (message)
• RemoveControlRequest (message)
• RemoveFulfillmentPlacesMetadata (message)
• RemoveFulfillmentPlacesRequest (message)
• RemoveFulfillmentPlacesResponse (message)
• RemoveLocalInventoriesMetadata (message)
• RemoveLocalInventoriesRequest (message)
• RemoveLocalInventoriesResponse (message)
• ReplaceCatalogAttributeRequest (message)
• ResumeModelRequest (message)
• Rule (message)
• Rule.BoostAction (message)
• Rule.DoNotAssociateAction (message)
• Rule.FilterAction (message)
• Rule.ForceReturnFacetAction (message)
• Rule.ForceReturnFacetAction.FacetPositionAdjustment (message)
• Rule.IgnoreAction (message)
• Rule.OnewaySynonymsAction (message)
• Rule.RedirectAction (message)
• Rule.RemoveFacetAction (message)
• Rule.ReplacementAction (message)
• Rule.TwowaySynonymsAction (message)
• SearchRequest (message)
• SearchRequest.BoostSpec (message)
• SearchRequest.BoostSpec.ConditionBoostSpec (message)
• SearchRequest.ConversationalSearchSpec (message)
• SearchRequest.ConversationalSearchSpec.UserAnswer (message)
• SearchRequest.ConversationalSearchSpec.UserAnswer.SelectedAnswer (message)
• SearchRequest.DynamicFacetSpec (message)
• SearchRequest.DynamicFacetSpec.Mode (enum)
• SearchRequest.FacetSpec (message)
• SearchRequest.FacetSpec.FacetKey (message)
• SearchRequest.PersonalizationSpec (message)
• SearchRequest.PersonalizationSpec.Mode (enum)
• SearchRequest.QueryExpansionSpec (message)
• SearchRequest.QueryExpansionSpec.Condition (enum)
• SearchRequest.RelevanceThreshold (enum)
• SearchRequest.SearchMode (enum)
• SearchRequest.SpellCorrectionSpec (message)
• SearchRequest.SpellCorrectionSpec.Mode (enum)
• SearchRequest.TileNavigationSpec (message)
• SearchResponse (message)
• SearchResponse.ConversationalSearchResult (message)
• SearchResponse.ConversationalSearchResult.AdditionalFilter (message)
• SearchResponse.ConversationalSearchResult.SuggestedAnswer (message)
• SearchResponse.Facet (message)
• SearchResponse.Facet.FacetValue (message)
• SearchResponse.QueryExpansionInfo (message)
• SearchResponse.SearchResult (message)
• SearchResponse.TileNavigationResult (message)
• SearchSolutionUseCase (enum)
• ServingConfig (message)
• ServingConfig.DiversityType (enum)
• SetDefaultBranchRequest (message)
• SetInventoryMetadata (message)
• SetInventoryRequest (message)
• SetInventoryResponse (message)
• SolutionType (enum)
• Tile (message)
• TransformedUserEventsMetadata (message)
• TuneModelMetadata (message)
• TuneModelRequest (message)
• TuneModelResponse (message)
• UpdateAlertConfigRequest (message)
• UpdateAttributesConfigRequest (message)
• UpdateCatalogRequest (message)
• UpdateCompletionConfigRequest (message)
• UpdateControlRequest (message)
• UpdateLoggingConfigRequest (message)
• UpdateModelRequest (message)
• UpdateProductRequest (message)
• UpdateServingConfigRequest (message)
• UserEvent (message)
• UserEventImportSummary (message)
• UserEventInlineSource (message)
• UserEventInputConfig (message)
• UserInfo (message)
• WriteUserEventRequest (message)

AnalyticsService

Service for managing & accessing retail search business metric. Retail recommendation business metric is currently not available.

ExportAnalyticsMetrics

rpc ExportAnalyticsMetrics(ExportAnalyticsMetricsRequest) returns (Operation) Exports analytics metrics. Operation.response is of type ExportAnalyticsMetricsResponse. Operation.metadata is of type ExportMetadata. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview. IAM Permissions Requires the following IAM permission on the catalog resource: retail.catalogs.exportAnalyticsMetrics For more information, see the IAM documentation.

BranchService

Service for Branch Management

Branches are automatically created when a Catalog is created. There are fixed three branches in each catalog, and may use ListBranches method to get the details of all branches.

GetBranch
rpc GetBranch(GetBranchRequest) returns (Branch) Retrieves a Branch. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview. IAM Permissions Requires the following IAM permission on the name resource: retail.branches.get For more information, see the IAM documentation.

ListBranches

rpc ListBranches(ListBranchesRequest) returns (ListBranchesResponse) Lists all instances of Branch under the specified parent Catalog. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview. IAM Permissions Requires the following IAM permission on the parent resource: retail.branches.list For more information, see the IAM documentation.

CatalogService

Service for managing catalog configuration.

AddCatalogAttribute

rpc AddCatalogAttribute(AddCatalogAttributeRequest) returns (AttributesConfig) Adds the specified CatalogAttribute to the AttributesConfig. If the CatalogAttribute to add already exists, an ALREADY_EXISTS error is returned. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview. IAM Permissions Requires the following IAM permission on the attributesConfig resource: retail.attributesConfigs.addCatalogAttribute For more information, see the IAM documentation.

BatchRemoveCatalogAttributes

rpc BatchRemoveCatalogAttributes(BatchRemoveCatalogAttributesRequest) returns (BatchRemoveCatalogAttributesResponse) Removes all specified CatalogAttributes from the AttributesConfig. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview. IAM Permissions Requires the following IAM permission on the attributesConfig resource: retail.attributesConfigs.batchRemoveCatalogAttributes For more information, see the IAM documentation.

GetAttributesConfig

rpc GetAttributesConfig(GetAttributesConfigRequest) returns (AttributesConfig) Gets an AttributesConfig. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview. IAM Permissions Requires the following IAM permission on the name resource: retail.attributesConfigs.get For more information, see the IAM documentation.

GetCompletionConfig
rpc GetCompletionConfig(GetCompletionConfigRequest) returns (CompletionConfig) Gets a CompletionConfig. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview.

GetDefaultBranch
rpc GetDefaultBranch(GetDefaultBranchRequest) returns (GetDefaultBranchResponse) Get which branch is currently default branch set by CatalogService.SetDefaultBranch method under a specified parent catalog. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview.

ListCatalogs

rpc ListCatalogs(ListCatalogsRequest) returns (ListCatalogsResponse) Lists all the Catalogs associated with the project. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview. IAM Permissions Requires the following IAM permission on the parent resource: retail.catalogs.list For more information, see the IAM documentation.

RemoveCatalogAttribute

rpc RemoveCatalogAttribute(RemoveCatalogAttributeRequest) returns (AttributesConfig) Removes the specified CatalogAttribute from the AttributesConfig. If the CatalogAttribute to remove does not exist, a NOT_FOUND error is returned. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview. IAM Permissions Requires the following IAM permission on the attributesConfig resource: retail.attributesConfigs.removeCatalogAttribute For more information, see the IAM documentation.

ReplaceCatalogAttribute

rpc ReplaceCatalogAttribute(ReplaceCatalogAttributeRequest) returns (AttributesConfig) Replaces the specified CatalogAttribute in the AttributesConfig by updating the catalog attribute with the same CatalogAttribute.key. If the CatalogAttribute to replace does not exist, a NOT_FOUND error is returned. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview. IAM Permissions Requires the following IAM permission on the attributesConfig resource: retail.attributesConfigs.replaceCatalogAttribute For more information, see the IAM documentation.

SetDefaultBranch

rpc SetDefaultBranch(SetDefaultBranchRequest) returns (Empty) Set a specified branch id as default branch. API methods such as SearchService.Search, ProductService.GetProduct, ProductService.ListProducts will treat requests using "default_branch" to the actual branch id set as default. For example, if projects/*/locations/*/catalogs/*/branches/1 is set as default, setting SearchRequest.branch to projects/*/locations/*/catalogs/*/branches/default_branch is equivalent to setting SearchRequest.branch to projects/*/locations/*/catalogs/*/branches/1. Using multiple branches can be useful when developers would like to have a staging branch to test and verify for future usage. When it becomes ready, developers switch on the staging branch using this API while keeping using projects/*/locations/*/catalogs/*/branches/default_branch as SearchRequest.branch to route the traffic to this staging branch. CAUTION: If you have live predict/search traffic, switching the default branch could potentially cause outages if the ID space of the new branch is very different from the old one. More specifically: PredictionService will only return product IDs from branch {newBranch}. SearchService will only return product IDs from branch {newBranch} (if branch is not explicitly set). UserEventService will only join events with products from branch {newBranch}. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview. IAM Permissions Requires the following IAM permission on the catalog resource: retail.catalogs.update For more information, see the IAM documentation.

UpdateAttributesConfig

rpc UpdateAttributesConfig(UpdateAttributesConfigRequest) returns (AttributesConfig) Updates the AttributesConfig. The catalog attributes in the request will be updated in the catalog, or inserted if they do not exist. Existing catalog attributes not included in the request will remain unchanged. Attributes that are assigned to products, but do not exist at the catalog level, are always included in the response. The product attribute is assigned default values for missing catalog attribute fields, e.g., searchable and dynamic facetable options. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview. IAM Permissions Requires the following IAM permission on the name resource: retail.attributesConfigs.update For more information, see the IAM documentation.

UpdateCatalog
rpc UpdateCatalog(UpdateCatalogRequest) returns (Catalog) Updates the Catalogs. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview. IAM Permissions Requires the following IAM permission on the name resource: retail.catalogs.update For more information, see the IAM documentation.

UpdateCompletionConfig
rpc UpdateCompletionConfig(UpdateCompletionConfigRequest) returns (CompletionConfig) Updates the CompletionConfigs. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview.

CompletionService

Autocomplete service for retail.

This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature.

CompleteQuery

rpc CompleteQuery(CompleteQueryRequest) returns (CompleteQueryResponse) Completes the specified prefix with keyword suggestions. This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview. IAM Permissions Requires the following IAM permission on the catalog resource: retail.catalogs.completeQuery For more information, see the IAM documentation.

ImportCompletionData

rpc ImportCompletionData(ImportCompletionDataRequest) returns (Operation) Bulk import of processed completion dataset. Request processing is asynchronous. Partial updating is not supported. The operation is successfully finished only after the imported suggestions are indexed successfully and ready for serving. The process takes hours. This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview. IAM Permissions Requires the following IAM permission on the parent resource: retail.catalogs.import For more information, see the IAM documentation.

ControlService

Service for modifying Control.

CreateControl

rpc CreateControl(CreateControlRequest) returns (Control) Creates a Control. If the Control to create already exists, an ALREADY_EXISTS error is returned. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview. IAM Permissions Requires the following IAM permission on the parent resource: retail.controls.create For more information, see the IAM documentation.

DeleteControl

rpc DeleteControl(DeleteControlRequest) returns (Empty) Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error is returned. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview. IAM Permissions Requires the following IAM permission on the name resource: retail.controls.delete For more information, see the IAM documentation.

GetControl
rpc GetControl(GetControlRequest) returns (Control) Gets a Control. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview. IAM Permissions Requires the following IAM permission on the name resource: retail.controls.get For more information, see the IAM documentation.

ListControls

rpc ListControls(ListControlsRequest) returns (ListControlsResponse) Lists all Controls by their parent Catalog. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview. IAM Permissions Requires the following IAM permission on the parent resource: retail.controls.list For more information, see the IAM documentation.

UpdateControl

rpc UpdateControl(UpdateControlRequest) returns (Control) Updates a Control. Control cannot be set to a different oneof field, if so an INVALID_ARGUMENT is returned. If the Control to update does not exist, a NOT_FOUND error is returned. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview. IAM Permissions Requires the following IAM permission on the name resource: retail.controls.update For more information, see the IAM documentation.

GenerativeQuestionService

Service for managing LLM generated questions in search serving.

MerchantCenterAccountLinkService

Merchant Center Link service to link a Branch to a Merchant Center Account.

CreateMerchantCenterAccountLink
rpc CreateMerchantCenterAccountLink(CreateMerchantCenterAccountLinkRequest) returns (Operation) Creates a MerchantCenterAccountLink. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview.

DeleteMerchantCenterAccountLink
rpc DeleteMerchantCenterAccountLink(DeleteMerchantCenterAccountLinkRequest) returns (Empty) Deletes a MerchantCenterAccountLink. If the MerchantCenterAccountLink to delete does not exist, a NOT_FOUND error is returned. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview.

ListMerchantCenterAccountLinks
rpc ListMerchantCenterAccountLinks(ListMerchantCenterAccountLinksRequest) returns (ListMerchantCenterAccountLinksResponse) Lists all MerchantCenterAccountLinks under the specified parent Catalog. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview.

ModelService

Service for performing CRUD operations on models. Recommendation models contain all the metadata necessary to generate a set of models for the Predict() API. A model is queried indirectly via a ServingConfig, which associates a model with a given Placement (e.g. Frequently Bought Together on Home Page).

This service allows you to do the following:

• Initiate training of a model.
• Pause training of an existing model.
• List all the available models along with their metadata.
• Control their tuning schedule.

CreateModel
rpc CreateModel(CreateModelRequest) returns (Operation) Creates a new model. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview. IAM Permissions Requires the following IAM permission on the parent resource: retail.models.create For more information, see the IAM documentation.

DeleteModel
rpc DeleteModel(DeleteModelRequest) returns (Empty) Deletes an existing model. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview. IAM Permissions Requires the following IAM permission on the name resource: retail.models.delete For more information, see the IAM documentation.

GetModel
rpc GetModel(GetModelRequest) returns (Model) Gets a model. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview. IAM Permissions Requires the following IAM permission on the name resource: retail.models.get For more information, see the IAM documentation.

ListModels

rpc ListModels(ListModelsRequest) returns (ListModelsResponse) Lists all the models linked to this event store. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview. IAM Permissions Requires the following IAM permission on the parent resource: retail.models.list For more information, see the IAM documentation.

PauseModel
rpc PauseModel(PauseModelRequest) returns (Model) Pauses the training of an existing model. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview. IAM Permissions Requires the following IAM permission on the name resource: retail.models.pause For more information, see the IAM documentation.

ResumeModel
rpc ResumeModel(ResumeModelRequest) returns (Model) Resumes the training of an existing model. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview. IAM Permissions Requires the following IAM permission on the name resource: retail.models.resume For more information, see the IAM documentation.

TuneModel
rpc TuneModel(TuneModelRequest) returns (Operation) Tunes an existing model. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview. IAM Permissions Requires the following IAM permission on the name resource: retail.models.tune For more information, see the IAM documentation.

UpdateModel

rpc UpdateModel(UpdateModelRequest) returns (Model) Update of model metadata. Only fields that currently can be updated are: filtering_option and periodic_tuning_state. If other values are provided, this API method ignores them. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview. IAM Permissions Requires the following IAM permission on the name resource: retail.models.update For more information, see the IAM documentation.

PredictionService

Service for making recommendation prediction.

Predict

rpc Predict(PredictRequest) returns (PredictResponse) Makes a recommendation prediction. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview. IAM Permissions Requires one of the following IAM permissions on the placement resource, depending on the resource type: retail.placements.predict retail.servingConfigs.predict For more information, see the IAM documentation.

ProductService

Service for ingesting Product information of the customer's website.

AddFulfillmentPlaces

rpc AddFulfillmentPlaces(AddFulfillmentPlacesRequest) returns (Operation) We recommend that you use the ProductService.AddLocalInventories method instead of the ProductService.AddFulfillmentPlaces method. ProductService.AddLocalInventories achieves the same results but provides more fine-grained control over ingesting local inventory data. Incrementally adds place IDs to Product.fulfillment_info.place_ids. This process is asynchronous and does not require the Product to exist before updating fulfillment information. If the request is valid, the update will be enqueued and processed downstream. As a consequence, when a response is returned, the added place IDs are not immediately manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts. The returned Operations will be obsolete after 1 day, and GetOperation API will return NOT_FOUND afterwards. If conflicting updates are issued, the Operations associated with the stale updates will not be marked as done until being obsolete. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview. IAM Permissions Requires the following IAM permission on the product resource: retail.products.update For more information, see the IAM documentation.

AddLocalInventories

rpc AddLocalInventories(AddLocalInventoriesRequest) returns (Operation) Updates local inventory information for a Product at a list of places, while respecting the last update timestamps of each inventory field. This process is asynchronous and does not require the Product to exist before updating inventory information. If the request is valid, the update will be enqueued and processed downstream. As a consequence, when a response is returned, updates are not immediately manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts. Local inventory information can only be modified using this method. ProductService.CreateProduct and ProductService.UpdateProduct has no effect on local inventories. The returned Operations will be obsolete after 1 day, and GetOperation API will return NOT_FOUND afterwards. If conflicting updates are issued, the Operations associated with the stale updates will not be marked as done until being obsolete. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview. IAM Permissions Requires the following IAM permission on the product resource: retail.products.update For more information, see the IAM documentation.

CreateProduct
rpc CreateProduct(CreateProductRequest) returns (Product) Creates a Product. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview. IAM Permissions Requires the following IAM permission on the parent resource: retail.products.create For more information, see the IAM documentation.

DeleteProduct
rpc DeleteProduct(DeleteProductRequest) returns (Empty) Deletes a Product. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview. IAM Permissions Requires the following IAM permission on the name resource: retail.products.delete For more information, see the IAM documentation.

ExportProducts
rpc ExportProducts(ExportProductsRequest) returns (Operation) Exports multiple Products. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview. IAM Permissions Requires the following IAM permission on the parent resource: retail.products.export For more information, see the IAM documentation.

GetProduct
rpc GetProduct(GetProductRequest) returns (Product) Gets a Product. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview. IAM Permissions Requires the following IAM permission on the name resource: retail.products.get For more information, see the IAM documentation.

ImportProducts

rpc ImportProducts(ImportProductsRequest) returns (Operation) Bulk import of multiple Products. Request processing may be synchronous. Non-existing items are created. Note that it is possible for a subset of the Products to be successfully updated. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview. IAM Permissions Requires the following IAM permission on the parent resource: retail.products.import For more information, see the IAM documentation.

ListProducts

rpc ListProducts(ListProductsRequest) returns (ListProductsResponse) Gets a list of Products. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview. IAM Permissions Requires the following IAM permission on the parent resource: retail.products.list For more information, see the IAM documentation.

PurgeProducts

rpc PurgeProducts(PurgeProductsRequest) returns (Operation) Permanently deletes all selected Products under a branch. This process is asynchronous. If the request is valid, the removal will be enqueued and processed offline. Depending on the number of Products, this operation could take hours to complete. Before the operation completes, some Products may still be returned by ProductService.GetProduct or ProductService.ListProducts. Depending on the number of Products, this operation could take hours to complete. To get a sample of Products that would be deleted, set PurgeProductsRequest.force to false. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview. IAM Permissions Requires the following IAM permission on the parent resource: retail.products.purge For more information, see the IAM documentation.

RemoveFulfillmentPlaces

rpc RemoveFulfillmentPlaces(RemoveFulfillmentPlacesRequest) returns (Operation) We recommend that you use the ProductService.RemoveLocalInventories method instead of the ProductService.RemoveFulfillmentPlaces method. ProductService.RemoveLocalInventories achieves the same results but provides more fine-grained control over ingesting local inventory data. Incrementally removes place IDs from a Product.fulfillment_info.place_ids. This process is asynchronous and does not require the Product to exist before updating fulfillment information. If the request is valid, the update will be enqueued and processed downstream. As a consequence, when a response is returned, the removed place IDs are not immediately manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts. The returned Operations will be obsolete after 1 day, and GetOperation API will return NOT_FOUND afterwards. If conflicting updates are issued, the Operations associated with the stale updates will not be marked as done until being obsolete. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview. IAM Permissions Requires the following IAM permission on the product resource: retail.products.update For more information, see the IAM documentation.

RemoveLocalInventories

rpc RemoveLocalInventories(RemoveLocalInventoriesRequest) returns (Operation) Remove local inventory information for a Product at a list of places at a removal timestamp. This process is asynchronous. If the request is valid, the removal will be enqueued and processed downstream. As a consequence, when a response is returned, removals are not immediately manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts. Local inventory information can only be removed using this method. ProductService.CreateProduct and ProductService.UpdateProduct has no effect on local inventories. The returned Operations will be obsolete after 1 day, and GetOperation API will return NOT_FOUND afterwards. If conflicting updates are issued, the Operations associated with the stale updates will not be marked as done until being obsolete. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview. IAM Permissions Requires the following IAM permission on the product resource: retail.products.update For more information, see the IAM documentation.

SetInventory

rpc SetInventory(SetInventoryRequest) returns (Operation) Updates inventory information for a Product while respecting the last update timestamps of each inventory field. This process is asynchronous and does not require the Product to exist before updating fulfillment information. If the request is valid, the update is enqueued and processed downstream. As a consequence, when a response is returned, updates are not immediately manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts. When inventory is updated with ProductService.CreateProduct and ProductService.UpdateProduct, the specified inventory field value(s) overwrite any existing value(s) while ignoring the last update time for this field. Furthermore, the last update times for the specified inventory fields are overwritten by the times of the ProductService.CreateProduct or ProductService.UpdateProduct request. If no inventory fields are set in CreateProductRequest.product, then any pre-existing inventory information for this product is used. If no inventory fields are set in SetInventoryRequest.set_mask, then any existing inventory information is preserved. Pre-existing inventory information can only be updated with ProductService.SetInventory, ProductService.AddFulfillmentPlaces, and ProductService.RemoveFulfillmentPlaces. The returned Operations is obsolete after one day, and the GetOperation API returns NOT_FOUND afterwards. If conflicting updates are issued, the Operations associated with the stale updates are not marked as done until they are obsolete. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview. IAM Permissions Requires the following IAM permission on the name resource: retail.products.update For more information, see the IAM documentation.

UpdateProduct
rpc UpdateProduct(UpdateProductRequest) returns (Product) Updates a Product. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview. IAM Permissions Requires the following IAM permission on the name resource: retail.products.update For more information, see the IAM documentation.

ProjectService

Service for settings at Project level.

AcceptTerms
rpc AcceptTerms(AcceptTermsRequest) returns (Project) Accepts service terms for this project. By making requests to this API, you agree to the terms of service linked below. https://cloud.google.com/retail/data-use-terms Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview.

EnrollSolution

rpc EnrollSolution(EnrollSolutionRequest) returns (Operation) The method enrolls a solution of type Retail Search into a project. The Recommendations AI solution type is enrolled by default when your project enables Retail API, so you don't need to call the enrollSolution method for recommendations. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview.

GetAlertConfig

rpc GetAlertConfig(GetAlertConfigRequest) returns (AlertConfig) Get the AlertConfig of the requested project. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview. IAM Permissions Requires the following IAM permission on the name resource: retail.alertConfigs.get For more information, see the IAM documentation.

GetLoggingConfig
rpc GetLoggingConfig(GetLoggingConfigRequest) returns (LoggingConfig) Gets the LoggingConfig of the requested project. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview.

GetProject

rpc GetProject(GetProjectRequest) returns (Project) Gets the project. Throws NOT_FOUND if the project wasn't initialized for the Retail API service. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview. IAM Permissions Requires the following IAM permission on the name resource: retail.retailProjects.get For more information, see the IAM documentation.

ListEnrolledSolutions
rpc ListEnrolledSolutions(ListEnrolledSolutionsRequest) returns (ListEnrolledSolutionsResponse) Lists all the retail API solutions the project has enrolled. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview.

UpdateAlertConfig

rpc UpdateAlertConfig(UpdateAlertConfigRequest) returns (AlertConfig) Update the alert config of the requested project. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview. IAM Permissions Requires the following IAM permission on the name resource: retail.alertConfigs.update For more information, see the IAM documentation.

UpdateLoggingConfig
rpc UpdateLoggingConfig(UpdateLoggingConfigRequest) returns (LoggingConfig) Updates the LoggingConfig of the requested project. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview.

SearchService

Service for search.

This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature.

Search

rpc Search(SearchRequest) returns (SearchResponse) Performs a search. This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview. IAM Permissions Requires one of the following IAM permissions on the placement resource, depending on the resource type: retail.placements.search retail.servingConfigs.search For more information, see the IAM documentation.

ServingConfigService

Service for modifying ServingConfig.

AddControl

rpc AddControl(AddControlRequest) returns (ServingConfig) Enables a Control on the specified ServingConfig. The control is added in the last position of the list of controls it belongs to (e.g. if it's a facet spec control it will be applied in the last position of servingConfig.facetSpecIds) Returns a ALREADY_EXISTS error if the control has already been applied. Returns a FAILED_PRECONDITION error if the addition could exceed maximum number of control allowed for that type of control. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview. IAM Permissions Requires the following IAM permission on the servingConfig resource: retail.servingConfigs.update For more information, see the IAM documentation.

CreateServingConfig

rpc CreateServingConfig(CreateServingConfigRequest) returns (ServingConfig) Creates a ServingConfig. A maximum of 100 ServingConfigs are allowed in a Catalog, otherwise a FAILED_PRECONDITION error is returned. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview. IAM Permissions Requires the following IAM permission on the parent resource: retail.servingConfigs.create For more information, see the IAM documentation.

DeleteServingConfig

rpc DeleteServingConfig(DeleteServingConfigRequest) returns (Empty) Deletes a ServingConfig. Returns a NotFound error if the ServingConfig does not exist. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview. IAM Permissions Requires the following IAM permission on the name resource: retail.servingConfigs.delete For more information, see the IAM documentation.

GetServingConfig

rpc GetServingConfig(GetServingConfigRequest) returns (ServingConfig) Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview. IAM Permissions Requires the following IAM permission on the name resource: retail.servingConfigs.get For more information, see the IAM documentation.

ListServingConfigs

rpc ListServingConfigs(ListServingConfigsRequest) returns (ListServingConfigsResponse) Lists all ServingConfigs linked to this catalog. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview. IAM Permissions Requires the following IAM permission on the parent resource: retail.servingConfigs.list For more information, see the IAM documentation.

RemoveControl

rpc RemoveControl(RemoveControlRequest) returns (ServingConfig) Disables a Control on the specified ServingConfig. The control is removed from the ServingConfig. Returns a NOT_FOUND error if the Control is not enabled for the ServingConfig. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview. IAM Permissions Requires the following IAM permission on the servingConfig resource: retail.servingConfigs.update For more information, see the IAM documentation.

UpdateServingConfig

rpc UpdateServingConfig(UpdateServingConfigRequest) returns (ServingConfig) Updates a ServingConfig. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview. IAM Permissions Requires the following IAM permission on the name resource: retail.servingConfigs.update For more information, see the IAM documentation.

UserEventService

Service for ingesting end user actions on the customer website.

CollectUserEvent

rpc CollectUserEvent(CollectUserEventRequest) returns (HttpBody) Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a 3rd party domain. This method is used only by the Retail API JavaScript pixel and Google Tag Manager. Users should not call this method directly. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview.

ExportUserEvents
rpc ExportUserEvents(ExportUserEventsRequest) returns (Operation) Exports user events. Operation.response is of type ExportResponse. Operation.metadata is of type ExportMetadata. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview.

ImportUserEvents

rpc ImportUserEvents(ImportUserEventsRequest) returns (Operation) Bulk import of User events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview. IAM Permissions Requires the following IAM permission on the parent resource: retail.userEvents.import For more information, see the IAM documentation.

PurgeUserEvents

rpc PurgeUserEvents(PurgeUserEventsRequest) returns (Operation) Deletes permanently all user events specified by the filter provided. Depending on the number of events specified by the filter, this operation could take hours or days to complete. To test a filter, use the list command first. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview. IAM Permissions Requires the following IAM permission on the parent resource: retail.userEvents.purge For more information, see the IAM documentation.

RejoinUserEvents

rpc RejoinUserEvents(RejoinUserEventsRequest) returns (Operation) Starts a user-event rejoin operation with latest product catalog. Events are not annotated with detailed product information for products that are missing from the catalog when the user event is ingested. These events are stored as unjoined events with limited usage on training and serving. You can use this method to start a join operation on specified events with the latest version of product catalog. You can also use this method to correct events joined with the wrong product catalog. A rejoin operation can take hours or days to complete. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview. IAM Permissions Requires the following IAM permission on the parent resource: retail.userEvents.rejoin For more information, see the IAM documentation.

WriteUserEvent

rpc WriteUserEvent(WriteUserEventRequest) returns (UserEvent) Writes a single user event. Authorization scopes Requires the following OAuth scope: https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview. IAM Permissions Requires the following IAM permission on the parent resource: retail.userEvents.create For more information, see the IAM documentation.

AcceptTermsRequest

Request for AcceptTerms method.

Fields
project	string Required. Full resource name of the project. Format: projects/{project_number_or_id}/retailProject

AddCatalogAttributeRequest

Request for CatalogService.AddCatalogAttribute method.

Fields
attributes_config	string Required. Full AttributesConfig resource name. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/attributesConfig
catalog_attribute	CatalogAttribute Required. The CatalogAttribute to add.

AddControlRequest

Request for AddControl method.

Fields
serving_config	string Required. The source ServingConfig resource name . Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/servingConfigs/{serving_config_id}
control_id	string Required. The id of the control to apply. Assumed to be in the same catalog as the serving config - if id is not found a NOT_FOUND error is returned.

AddFulfillmentPlacesMetadata

This type has no fields.

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

AddFulfillmentPlacesRequest

Request message for ProductService.AddFulfillmentPlaces method.

Fields
product	string Required. Full resource name of Product, such as projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id. If the caller does not have permission to access the Product, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.
type	string Required. The fulfillment type, including commonly used types (such as pickup in store and same day delivery), and custom types. Supported values: "pickup-in-store" "ship-to-store" "same-day-delivery" "next-day-delivery" "custom-type-1" "custom-type-2" "custom-type-3" "custom-type-4" "custom-type-5" If this field is set to an invalid value other than these, an INVALID_ARGUMENT error is returned. This field directly corresponds to Product.fulfillment_info.type.
place_ids[]	string Required. The IDs for this type, such as the store IDs for "pickup-in-store" or the region IDs for "same-day-delivery" to be added for this type. Duplicate IDs will be automatically ignored. At least 1 value is required, and a maximum of 2000 values are allowed. Each value must be a string with a length limit of 10 characters, matching the pattern [a-zA-Z0-9_-]+, such as "store1" or "REGION-2". Otherwise, an INVALID_ARGUMENT error is returned. If the total number of place IDs exceeds 2000 for this type after adding, then the update will be rejected.
add_time	Timestamp The time when the fulfillment updates are issued, used to prevent out-of-order updates on fulfillment information. If not provided, the internal system time will be used.
allow_missing	bool If set to true, and the Product is not found, the fulfillment information will still be processed and retained for at most 1 day and processed once the Product is created. If set to false, a NOT_FOUND error is returned if the Product is not found.

AddFulfillmentPlacesResponse

This type has no fields.

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

AddLocalInventoriesMetadata

This type has no fields.

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

AddLocalInventoriesRequest

Request message for ProductService.AddLocalInventories method.

Fields
product	string Required. Full resource name of Product, such as projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id. If the caller does not have permission to access the Product, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.
local_inventories[]	LocalInventory Required. A list of inventory information at difference places. Each place is identified by its place ID. At most 3000 inventories are allowed per request.
add_mask	FieldMask Indicates which inventory fields in the provided list of LocalInventory to update. The field is updated to the provided value. If a field is set while the place does not have a previous local inventory, the local inventory at that store is created. If a field is set while the value of that field is not provided, the original field value, if it exists, is deleted. If the mask is not set or set with empty paths, all inventory fields will be updated. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned and the entire update will be ignored.
add_time	Timestamp The time when the inventory updates are issued. Used to prevent out-of-order updates on local inventory fields. If not provided, the internal system time will be used.
allow_missing	bool If set to true, and the Product is not found, the local inventory will still be processed and retained for at most 1 day and processed once the Product is created. If set to false, a NOT_FOUND error is returned if the Product is not found.

AddLocalInventoriesResponse

This type has no fields.

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

AlertConfig

Project level alert config.

Fields
name	string Required. Immutable. The name of the AlertConfig singleton resource. Format: projects/*/alertConfig
alert_policies[]	AlertPolicy Alert policies for a customer. They must be unique by [AlertPolicy.alert_group]

AlertPolicy

Alert policy for a customer.

Fields
alert_group	string The feature that provides alerting capability. Supported value: - search-data-quality for retail search customers. - conv-data-quality for retail conversation customers.
enroll_status	EnrollStatus The enrollment status of a customer.
recipients[]	Recipient Recipients for the alert policy. One alert policy should not exceed 20 recipients.

EnrollStatus

The enrollment status enum for alert policy.

Enums
ENROLL_STATUS_UNSPECIFIED	Default value. Used for customers who have not responded to the alert policy.
ENROLLED	Customer is enrolled in this policy.
DECLINED	Customer declined this policy.

Recipient

Recipient contact information.

Fields
email_address	string Email address of the recipient.

AttributeConfigLevel

At which level we offer configuration for attributes.

Enums
ATTRIBUTE_CONFIG_LEVEL_UNSPECIFIED	Value used when unset. In this case, server behavior defaults to CATALOG_LEVEL_ATTRIBUTE_CONFIG.
PRODUCT_LEVEL_ATTRIBUTE_CONFIG	At this level, we honor the attribute configurations set in Product.attributes.
CATALOG_LEVEL_ATTRIBUTE_CONFIG	At this level, we honor the attribute configurations set in CatalogConfig.attribute_configs.

AttributesConfig

Catalog level attribute config.

Fields
name	string Required. Immutable. The fully qualified resource name of the attribute config. Format: projects/*/locations/*/catalogs/*/attributesConfig
catalog_attributes	map<string, CatalogAttribute> Enable attribute(s) config at catalog level. For example, indexable, dynamic_facetable, or searchable for each attribute. The key is catalog attribute's name. For example: color, brands, attributes.custom_attribute, such as attributes.xyz. The maximum number of catalog attributes allowed in a request is 1000.
attribute_config_level	AttributeConfigLevel Output only. The AttributeConfigLevel used for this catalog.

Audience

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

Fields
genders[]	string The genders of the audience. Strongly encouraged to use the standard values: "male", "female", "unisex". At most 5 values are allowed. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Google Merchant Center property gender. Schema.org property Product.audience.suggestedGender.
age_groups[]	string The age groups of the audience. Strongly encouraged to use the standard values: "newborn" (up to 3 months old), "infant" (3–12 months old), "toddler" (1–5 years old), "kids" (5–13 years old), "adult" (typically teens or older). At most 5 values are allowed. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Google Merchant Center property age_group. Schema.org property Product.audience.suggestedMinAge and Product.audience.suggestedMaxAge.

BatchRemoveCatalogAttributesRequest

Request for CatalogService.BatchRemoveCatalogAttributes method.

Fields
attributes_config	string Required. The attributes config resource shared by all catalog attributes being deleted. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/attributesConfig
attribute_keys[]	string Required. The attribute name keys of the CatalogAttributes to delete. A maximum of 1000 catalog attributes can be deleted in a batch.

BatchRemoveCatalogAttributesResponse

Response of the CatalogService.BatchRemoveCatalogAttributes.

Fields
deleted_catalog_attributes[]	string Catalog attributes that were deleted. Only pre-loaded catalog attributes that are neither in use by products nor predefined can be deleted.
reset_catalog_attributes[]	string Catalog attributes that were reset. Catalog attributes that are either in use by products or are predefined attributes cannot be deleted; however, their configuration properties will reset to default values upon removal request.

BigQueryOutputResult

A BigQuery output result.

Fields
dataset_id	string The ID of a BigQuery Dataset.
table_id	string The ID of a BigQuery Table.

BigQuerySource

BigQuery source import data from.

Fields
project_id	string The project ID (can be project # or ID) that the BigQuery source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.
dataset_id	string Required. The BigQuery data set to copy the data from with a length limit of 1,024 characters.
table_id	string Required. The BigQuery table to copy the data from with a length limit of 1,024 characters.
gcs_staging_dir	string Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the BigQuery export to a specific Cloud Storage directory.
data_schema	string The schema to use when parsing the data from the source. Supported values for product imports: product (default): One JSON Product per line. Each product must have a valid Product.id. product_merchant_center: See Importing catalog data from Merchant Center. Supported values for user events imports: user_event (default): One JSON UserEvent per line. user_event_ga360: The schema is available here: https://support.google.com/analytics/answer/3437719. user_event_ga4: The schema is available here: https://support.google.com/analytics/answer/7029846. Supported values for autocomplete imports: suggestions (default): One JSON completion suggestion per line. denylist: One JSON deny suggestion per line. allowlist: One JSON allow suggestion per line.
Union field partition. BigQuery table partition info. Leave this empty if the BigQuery table is not partitioned. partition can be only one of the following:
partition_date	Date BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD format. Only supported in ImportProductsRequest.

Branch

A data branch that stores all instances of Products.

Fields
name	string Immutable. Full resource name of the branch, such as projects/*/locations/global/catalogs/default_catalog/branches/branch_id.
display_name	string Output only. Human readable name of the branch to display in the UI.
is_default	bool Output only. Indicates whether this branch is set as the default branch of its parent catalog.
last_product_import_time	Timestamp Output only. Timestamp of last import through ProductService.ImportProducts. Empty value means no import has been made to this branch.
product_count_stats[]	ProductCountStatistic Output only. Statistics for number of products in the branch, provided for different scopes. This field is not populated in [BranchView.BASIC][] view.
quality_metrics[]	QualityMetric Output only. The quality metrics measured among products of this branch. See QualityMetric.requirement_key for supported metrics. Metrics could be missing if failed to retrieve. This field is not populated in [BranchView.BASIC][] view.

ProductCountStatistic

A statistic about the number of products in a branch.

Fields
scope	ProductCountScope [ProductCountScope] of the [counts].
counts	map<string, int64> The number of products in scope broken down into different groups. The key is a group representing a set of products, and the value is the number of products in that group. Note: keys in this map may change over time. Possible keys: * "primary-in-stock", products have Product.Type.PRIMARY type and Product.Availability.IN_STOCK availability. "primary-out-of-stock", products have Product.Type.PRIMARY type and Product.Availability.OUT_OF_STOCK availability. "primary-preorder", products have Product.Type.PRIMARY type and Product.Availability.PREORDER availability. "primary-backorder", products have Product.Type.PRIMARY type and Product.Availability.BACKORDER availability. "variant-in-stock", products have Product.Type.VARIANT type and Product.Availability.IN_STOCK availability. "variant-out-of-stock", products have Product.Type.VARIANT type and Product.Availability.OUT_OF_STOCK availability. "variant-preorder", products have Product.Type.VARIANT type and Product.Availability.PREORDER availability. "variant-backorder", products have Product.Type.VARIANT type and Product.Availability.BACKORDER availability. "price-discounted", products have [Product.price_info.price] < [Product.price_info.original_price].

ProductCountScope

Scope of what products are included for this count.

Enums
PRODUCT_COUNT_SCOPE_UNSPECIFIED	Default value for enum. This value is not used in the API response.
ALL_PRODUCTS	Scope for all existing products in the branch. Useful for understanding how many products there are in a branch.
LAST_24_HOUR_UPDATE	Scope for products created or updated in the last 24 hours.

QualityMetric

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.

Fields
requirement_key	string The key that represents a quality requirement rule. Supported keys: * "has-valid-uri": product has a valid and accessible uri. "available-expire-time-conformance": Product.available_time is early than "now", and Product.expire_time is greater than "now". "has-searchable-attributes": product has at least one attribute set to searchable. "has-description": product has non-empty description. "has-at-least-bigram-title": Product title has at least two words. A comprehensive title helps to improve search quality. "variant-has-image": the variant products has at least one image. You may ignore this metric if all your products are at primary level. "variant-has-price-info": the variant products has price_info set. You may ignore this metric if all your products are at primary level. "has-publish-time": product has non-empty publish_time.
qualified_product_count	int32 Number of products passing the quality requirement check. We only check searchable products.
unqualified_product_count	int32 Number of products failing the quality requirement check. We only check searchable products.
suggested_quality_percent_threshold	double Value from 0 to 100 representing the suggested percentage of products that meet the quality requirements to get good search and recommendation performance. 100 * (qualified_product_count) / (qualified_product_count + unqualified_product_count) should be greater or equal to this suggestion.
unqualified_sample_products[]	Product A list of a maximum of 100 sample products that do not qualify for this requirement. This field is only populated in the response to BranchService.GetBranch API, and is always empty for BranchService.ListBranches. Only the following fields are set in the Product. Product.name Product.id Product.title

BranchView

A view that specifies different level of fields of a Branch to show in responses.

Enums
BRANCH_VIEW_UNSPECIFIED	The value when it's unspecified. This defaults to the BASIC view.
BRANCH_VIEW_BASIC	Includes basic metadata about the branch, but not statistical fields. See documentation of fields of Branch to find what fields are excluded from BASIC view.
BRANCH_VIEW_FULL	Includes all fields of a Branch.

Catalog

The catalog configuration.

Fields
name	string Required. Immutable. The fully qualified resource name of the catalog.
display_name	string Required. Immutable. The catalog display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
product_level_config	ProductLevelConfig Required. The product level configuration.
merchant_center_linking_config	MerchantCenterLinkingConfig The Merchant Center linking configuration. After a link is added, the data stream from Merchant Center to Cloud Retail will be enabled automatically. The requester must have access to the Merchant Center account in order to make changes to this field.

CatalogAttribute

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

Fields
key	string Required. Attribute name. For example: color, brands, attributes.custom_attribute, such as attributes.xyz. To be indexable, the attribute name can contain only alpha-numeric characters and underscores. For example, an attribute named attributes.abc_xyz can be indexed, but an attribute named attributes.abc-xyz cannot be indexed. If the attribute key starts with attributes., then the attribute is a custom attribute. Attributes such as brands, patterns, and title are built-in and called system attributes.
in_use	bool Output only. Indicates whether this attribute has been used by any products. True if at least one Product is using this attribute in Product.attributes. Otherwise, this field is False. CatalogAttribute can be pre-loaded by using CatalogService.AddCatalogAttribute, CatalogService.ImportCatalogAttributes, or CatalogService.UpdateAttributesConfig APIs. This field is False for pre-loaded CatalogAttributes. Only pre-loaded catalog attributes that are neither in use by products nor predefined can be deleted. Catalog attributes that are either in use by products or are predefined attributes cannot be deleted; however, their configuration properties will reset to default values upon removal request. After catalog changes, it takes about 10 minutes for this field to update.
type	AttributeType Output only. The type of this attribute. This is derived from the attribute in Product.attributes.
indexable_option	IndexableOption When AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if INDEXABLE_ENABLED attribute values are indexed so that it can be filtered, faceted, or boosted in SearchService.Search. Must be specified when AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, otherwise throws INVALID_FORMAT error.
dynamic_facetable_option	DynamicFacetableOption If DYNAMIC_FACETABLE_ENABLED, attribute values are available for dynamic facet. Could only be DYNAMIC_FACETABLE_DISABLED if CatalogAttribute.indexable_option is INDEXABLE_DISABLED. Otherwise, an INVALID_ARGUMENT error is returned. Must be specified, otherwise throws INVALID_FORMAT error.
searchable_option	SearchableOption When AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if SEARCHABLE_ENABLED, attribute values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but attribute type is numerical, attribute values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical attributes. Must be specified, when AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, otherwise throws INVALID_FORMAT error.
recommendations_filtering_option	RecommendationsFilteringOption When AttributesConfig.attribute_config_level is CATALOG_LEVEL_ATTRIBUTE_CONFIG, if RECOMMENDATIONS_FILTERING_ENABLED, attribute values are filterable for recommendations. This option works for categorical features only, does not work for numerical features, inventory filtering.
exact_searchable_option	ExactSearchableOption If EXACT_SEARCHABLE_ENABLED, attribute values will be exact searchable. This property only applies to textual custom attributes and requires indexable set to enabled to enable exact-searchable. If unset, the server behavior defaults to EXACT_SEARCHABLE_DISABLED.
retrievable_option	RetrievableOption If RETRIEVABLE_ENABLED, attribute values are retrievable in the search results. If unset, the server behavior defaults to RETRIEVABLE_DISABLED.
facet_config	FacetConfig Contains facet options.

AttributeType

The type of an attribute.

Enums
UNKNOWN	The type of the attribute is unknown. Used when type cannot be derived from attribute that is not in_use.
TEXTUAL	Textual attribute.
NUMERICAL	Numerical attribute.

DynamicFacetableOption

The status of the dynamic facetable option of a catalog attribute.

Enums
DYNAMIC_FACETABLE_OPTION_UNSPECIFIED	Value used when unset.
DYNAMIC_FACETABLE_ENABLED	Dynamic facetable option enabled for an attribute.
DYNAMIC_FACETABLE_DISABLED	Dynamic facetable option disabled for an attribute.

ExactSearchableOption

The status of the exact-searchable option of a catalog attribute.

Enums
EXACT_SEARCHABLE_OPTION_UNSPECIFIED	Value used when unset.
EXACT_SEARCHABLE_ENABLED	Exact searchable option enabled for an attribute.
EXACT_SEARCHABLE_DISABLED	Exact searchable option disabled for an attribute.

FacetConfig

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

Fields
facet_intervals[]	Interval If you don't set the facet SearchRequest.FacetSpec.FacetKey.intervals in the request to a numerical attribute, then we use the computed intervals with rounded bounds obtained from all its product numerical attribute values. The computed intervals might not be ideal for some attributes. Therefore, we give you the option to overwrite them with the facet_intervals field. The maximum of facet intervals per CatalogAttribute is 40. Each interval must have a lower bound or an upper bound. If both bounds are provided, then the lower bound must be smaller or equal than the upper bound.
ignored_facet_values[]	IgnoredFacetValues Each instance represents a list of attribute values to ignore as facet values for a specific time range. The maximum number of instances per CatalogAttribute is 25.
merged_facet_values[]	MergedFacetValue Each instance replaces a list of facet values by a merged facet value. If a facet value is not in any list, then it will stay the same. To avoid conflicts, only paths of length 1 are accepted. In other words, if "dark_blue" merged into "BLUE", then the latter can't merge into "blues" because this would create a path of length 2. The maximum number of instances of MergedFacetValue per CatalogAttribute is 100. This feature is available only for textual custom attributes.
merged_facet	MergedFacet Use this field only if you want to merge a facet key into another facet key.
rerank_config	RerankConfig Set this field only if you want to rerank based on facet values engaged by the user for the current key. This option is only possible for custom facetable textual keys.

IgnoredFacetValues

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

Fields
values[]	string List of facet values to ignore for the following time range. The facet values are the same as the attribute values. There is a limit of 10 values per instance of IgnoredFacetValues. Each value can have at most 128 characters.
start_time	Timestamp Time range for the current list of facet values to ignore. If multiple time ranges are specified for an facet value for the current attribute, consider all of them. If both are empty, ignore always. If start time and end time are set, then start time must be before end time. If start time is not empty and end time is empty, then will ignore these facet values after the start time.
end_time	Timestamp If start time is empty and end time is not empty, then ignore these facet values before end time.

MergedFacet

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

Fields

merged_facet_key

string The merged facet key should be a valid facet key that is different than the facet key of the current catalog attribute. We refer this is merged facet key as the child of the current catalog attribute. This merged facet key can't be a parent of another facet key (i.e. no directed path of length 2). This merged facet key needs to be either a textual custom attribute or a numerical custom attribute.

MergedFacetValue

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.

Fields
values[]	string All the facet values that are replaces by the same merged_value that follows. The maximum number of values per MergedFacetValue is 25. Each value can have up to 128 characters.
merged_value	string All the previous values are replaced by this merged facet value. This merged_value must be non-empty and can have up to 128 characters.

RerankConfig

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

Fields
rerank_facet	bool If set to true, then we also rerank the dynamic facets based on the facet values engaged by the user for the current attribute key during serving.
facet_values[]	string If empty, rerank on all facet values for the current key. Otherwise, will rerank on the facet values from this list only.

IndexableOption

The status of the indexable option of a catalog attribute.

Enums
INDEXABLE_OPTION_UNSPECIFIED	Value used when unset.
INDEXABLE_ENABLED	Indexable option enabled for an attribute.
INDEXABLE_DISABLED	Indexable option disabled for an attribute.

RetrievableOption

The status of the retrievable option of a catalog attribute.

Enums
RETRIEVABLE_OPTION_UNSPECIFIED	Value used when unset.
RETRIEVABLE_ENABLED	Retrievable option enabled for an attribute.
RETRIEVABLE_DISABLED	Retrievable option disabled for an attribute.

SearchableOption

The status of the searchable option of a catalog attribute.

Enums
SEARCHABLE_OPTION_UNSPECIFIED	Value used when unset.
SEARCHABLE_ENABLED	Searchable option enabled for an attribute.
SEARCHABLE_DISABLED	Searchable option disabled for an attribute.

CollectUserEventRequest

Request message for CollectUserEvent method.

Fields
parent	string Required. The parent catalog name, such as projects/1234/locations/global/catalogs/default_catalog.
user_event	string Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters.
uri	string The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers only send the domain for 3rd party requests.
ets	int64 The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes.
raw_json	string An arbitrary serialized JSON string that contains necessary information that can comprise a user event. When this field is specified, the user_event field will be ignored. Note: line-delimited JSON is not supported, a single JSON only.
Union field conversion_rule. The rule that can convert the raw_json to a user event. It is needed only when the raw_json is set. conversion_rule can be only one of the following:
prebuilt_rule	string The prebuilt rule name that can convert a specific type of raw_json. For example: "ga4_bq" rule for the GA4 user event schema.

ColorInfo

The color information of a Product.

Fields
color_families[]	string The standard color families. Strongly recommended to use the following standard color groups: "Red", "Pink", "Orange", "Yellow", "Purple", "Green", "Cyan", "Blue", "Brown", "White", "Gray", "Black" and "Mixed". Normally it is expected to have only 1 color family. May consider using single "Mixed" instead of multiple values. A maximum of 5 values are allowed. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Google Merchant Center property color. Schema.org property Product.color.
colors[]	string The color display names, which may be different from standard color family names, such as the color aliases used in the website frontend. Normally it is expected to have only 1 color. May consider using single "Mixed" instead of multiple values. A maximum of 75 colors are allowed. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Google Merchant Center property color. Schema.org property Product.color.

CompleteQueryRequest

Autocomplete parameters.

Fields
catalog	string Required. Catalog for which the completion is performed. Full resource name of catalog, such as projects/*/locations/global/catalogs/default_catalog.
query	string Required. The query used to generate suggestions. The maximum number of allowed characters is 255.
visitor_id	string 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.
language_codes[]	string Note that this field applies for user-data dataset only. For requests with cloud-retail dataset, setting this field has no effect. The language filters applied to the output suggestions. If set, it should contain the language of the query. If not set, suggestions are returned without considering language restrictions. This is the BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see Tags for Identifying Languages. The maximum number of language codes is 3.
device_type	string The device type context for completion suggestions. We recommend that you leave this field empty. It can apply different suggestions on different device types, e.g. DESKTOP, MOBILE. If it is empty, the suggestions are across all device types. Supported formats: UNKNOWN_DEVICE_TYPE DESKTOP MOBILE A customized string starts with OTHER_, e.g. OTHER_IPHONE.
dataset	string Determines which dataset to use for fetching completion. "user-data" will use the imported dataset through CompletionService.ImportCompletionData. "cloud-retail" will use the dataset generated by cloud retail based on user events. If leave empty, it will use the "user-data". Current supported values: user-data cloud-retail: This option requires enabling auto-learning function first. See guidelines.
max_suggestions	int32 Completion max suggestions. If left unset or set to 0, then will fallback to the configured value CompletionConfig.max_suggestions. The maximum allowed max suggestions is 20. If it is set higher, it will be capped by 20.
enable_attribute_suggestions	bool If true, attribute suggestions are enabled and provided in the response. This field is only available for the "cloud-retail" dataset.
entity	string 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.

CompleteQueryResponse

Response of the autocomplete query.

Fields
completion_results[]	CompletionResult Results of the matching suggestions. The result list is ordered and the first result is top suggestion.
attribution_token	string A unique complete token. This should be included in the UserEvent.completion_detail for search events resulting from this completion, which enables accurate attribution of complete model performance.
recent_search_results[] (deprecated)	RecentSearchResult This item is deprecated! Deprecated. Matched recent searches of this user. The maximum number of recent searches is 10. This field is a restricted feature. If you want to enable it, contact Retail Search support. This feature is only available when CompleteQueryRequest.visitor_id field is set and UserEvent is imported. The recent searches satisfy the follow rules: They are ordered from latest to oldest. They are matched with CompleteQueryRequest.query case insensitively. They are transformed to lower case. They are UTF-8 safe. Recent searches are deduplicated. More recent searches will be reserved when duplication happens.
attribute_results	map<string, AttributeResult> A map of matched attribute suggestions. This field is only available for "cloud-retail" dataset. Current supported keys: brands categories

AttributeResult

Resource that represents attribute results. The list of suggestions for the attribute.

Fields
suggestions[]	string

CompletionResult

Resource that represents completion results.

Fields
suggestion	string The suggestion for the query.
attributes	map<string, CustomAttribute> Custom attributes for the suggestion term. For "user-data", the attributes are additional custom attributes ingested through BigQuery. For "cloud-retail", the attributes are product attributes generated by Cloud Retail. It requires UserEvent.product_details is imported properly.
facets[]	Facet Facet information for the suggestion term. Gives the number of items resulting from a search with this suggestion term for each facet. This is an experimental feature for limited customers. If you want to receive this facet information, reach out to the Retail support team.
total_product_count	int32 Total number of products associated with a search with this suggestion. This is an experimental feature for limited customers. If you want to receive this product count information, reach out to the Retail support team.

RecentSearchResult

This item is deprecated!

Deprecated: Recent search of this user.

Fields
recent_search	string The recent search query.

CompletionConfig

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

Fields
name	string Required. Immutable. Fully qualified name projects/*/locations/*/catalogs/*/completionConfig
matching_order	string Specifies the matching order for autocomplete suggestions, e.g., a query consisting of 'sh' with 'out-of-order' specified would suggest "women's shoes", whereas a query of 'red s' with 'exact-prefix' specified would suggest "red shoes". Currently supported values: 'out-of-order' 'exact-prefix' Default value: 'exact-prefix'.
max_suggestions	int32 The maximum number of autocomplete suggestions returned per term. Default value is 20. If left unset or set to 0, then will fallback to default value. Value range is 1 to 20.
min_prefix_length	int32 The minimum number of characters needed to be typed in order to get suggestions. Default value is 2. If left unset or set to 0, then will fallback to default value. Value range is 1 to 20.
auto_learning	bool If set to true, the auto learning function is enabled. Auto learning uses user data to generate suggestions using ML techniques. Default value is false. Only after enabling auto learning can users use cloud-retail data in CompleteQueryRequest.
suggestions_input_config	CompletionDataInputConfig Output only. The source data for the latest import of the autocomplete suggestion phrases.
last_suggestions_import_operation	string Output only. Name of the LRO corresponding to the latest suggestion terms list import. Can use GetOperation API method to retrieve the latest state of the Long Running Operation.
denylist_input_config	CompletionDataInputConfig Output only. The source data for the latest import of the autocomplete denylist phrases.
last_denylist_import_operation	string Output only. Name of the LRO corresponding to the latest denylist import. Can use GetOperation API to retrieve the latest state of the Long Running Operation.
allowlist_input_config	CompletionDataInputConfig Output only. The source data for the latest import of the autocomplete allowlist phrases.
last_allowlist_import_operation	string Output only. Name of the LRO corresponding to the latest allowlist import. Can use GetOperation API to retrieve the latest state of the Long Running Operation.

CompletionDataInputConfig

The input config source for completion data.

Fields
Union field source. The source of the input. Supported BigQuerySource.data_schema values for suggestions imports: suggestions (default): One JSON completion suggestion per line. denylist: One JSON deny suggestion per line. allowlist: One JSON allow suggestion per line. source can be only one of the following:
big_query_source	BigQuerySource Required. BigQuery input source. Add the IAM permission "BigQuery Data Viewer" for [e-mail] before using this feature otherwise an error is thrown.

CompletionDetail

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

Fields
completion_attribution_token	string Completion attribution token in CompleteQueryResponse.attribution_token.
selected_suggestion	string End user selected CompleteQueryResponse.CompletionResult.suggestion.
selected_position	int32 End user selected CompleteQueryResponse.CompletionResult.suggestion position, starting from 0.

Condition

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.

Fields
query_terms[]	QueryTerm A list (up to 10 entries) of terms to match the query on. If not specified, match all queries. If many query terms are specified, the condition is matched if any of the terms is a match (i.e. using the OR operator).
active_time_range[]	TimeRange Range of time(s) specifying when Condition is active. Condition true if any time range matches.
page_categories[]	string Used to support browse uses cases. A list (up to 10 entries) of categories or departments. The format should be the same as UserEvent.page_categories;

QueryTerm

Query terms that we want to match on.

Fields
value	string The value of the term to match on. Value cannot be empty. Value can have at most 3 terms if specified as a partial match. Each space separated string is considered as one term. For example, "a b c" is 3 terms and allowed, but " a b c d" is 4 terms and not allowed for a partial match.
full_match	bool Whether this is supposed to be a full or partial match.

TimeRange

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

Fields
start_time	Timestamp Start of time range. Range is inclusive.
end_time	Timestamp End of time range. Range is inclusive.

Control

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

Fields
name	string Immutable. Fully qualified name projects/*/locations/global/catalogs/*/controls/*
display_name	string Required. The human readable control display name. Used in Retail UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is thrown.
associated_serving_config_ids[]	string Output only. List of serving config ids that are associated with this control in the same Catalog. Note the association is managed via the ServingConfig, this is an output only denormalized view.
solution_types[]	SolutionType Required. Immutable. The solution types that the control is used for. Currently we support setting only one type of solution at creation time. Only SOLUTION_TYPE_SEARCH value is supported at the moment. If no solution type is provided at creation time, will default to SOLUTION_TYPE_SEARCH.
search_solution_use_case[]	SearchSolutionUseCase Specifies the use case for the control. Affects what condition fields can be set. Only settable by search controls. Will default to SEARCH_SOLUTION_USE_CASE_SEARCH if not specified. Currently only allow one search_solution_use_case per control.
Union field control. The behavior/type of the control A behavior/type must be specified on creation. Type cannot be changed once specified (e.g. A Rule control will always be a Rule control.). An INVALID_ARGUMENT will be returned if either condition is violated. control can be only one of the following:
facet_spec (deprecated)	FacetSpec This item is deprecated! A facet specification to perform faceted search. Note that this field is deprecated and will throw NOT_IMPLEMENTED if used for creating a control.
rule	Rule A rule control - a condition-action pair. Enacts a set action when the condition is triggered. For example: Boost "gShoe" when query full matches "Running Shoes".

CreateControlRequest

Request for CreateControl method.

Fields
parent	string Required. Full resource name of parent catalog. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}
control	Control Required. The Control to create.
control_id	string Required. The ID to use for the Control, which will become the final component of the Control's resource name. This value should be 4-63 characters, and valid characters are /[a-z][0-9]-_/.

CreateMerchantCenterAccountLinkMetadata

Common metadata related to the progress of the operations.

Fields
create_time	Timestamp Operation create time.
update_time	Timestamp Operation last update time. If the operation is done, this is also the finish time.

CreateMerchantCenterAccountLinkRequest

Request for MerchantCenterAccountLinkService.CreateMerchantCenterAccountLink method.

Fields
parent	string Required. The branch resource where this MerchantCenterAccountLink will be created. Format: projects/{PROJECT_NUMBER}/locations/global/catalogs/{CATALOG_ID}
merchant_center_account_link	MerchantCenterAccountLink Required. The MerchantCenterAccountLink to create. If the caller does not have permission to create the MerchantCenterAccountLink, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

CreateModelMetadata

Metadata associated with a create operation.

Fields
model	string The resource name of the model that this create applies to. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}

CreateModelRequest

Request for creating a model.

Fields
parent	string Required. The parent resource under which to create the model. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}
model	Model Required. The payload of the Model to create.
dry_run	bool Optional. Whether to run a dry run to validate the request (without actually creating the model).

CreateProductRequest

Request message for ProductService.CreateProduct method.

Fields
parent	string Required. The parent catalog resource name, such as projects/*/locations/global/catalogs/default_catalog/branches/default_branch.
product	Product Required. The Product to create.
product_id	string Required. The ID to use for the Product, which will become the final component of the Product.name. If the caller does not have permission to create the Product, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. This field must be unique among all Products with the same parent. Otherwise, an ALREADY_EXISTS error is returned. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.

CreateServingConfigRequest

Request for CreateServingConfig method.

Fields
parent	string Required. Full resource name of parent. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}
serving_config	ServingConfig Required. The ServingConfig to create.
serving_config_id	string Required. The ID to use for the ServingConfig, which will become the final component of the ServingConfig's resource name. This value should be 4-63 characters, and valid characters are /[a-z][0-9]-_/.

CustomAttribute

A custom attribute that is not explicitly modeled in Product.

Fields
text[]	string The textual values of this custom attribute. For example, ["yellow", "green"] when the key is "color". Empty string is not allowed. Otherwise, an INVALID_ARGUMENT error is returned. Exactly one of text or numbers should be set. Otherwise, an INVALID_ARGUMENT error is returned.
numbers[]	double The numerical values of this custom attribute. For example, [2.3, 15.4] when the key is "lengths_cm". Exactly one of text or numbers should be set. Otherwise, an INVALID_ARGUMENT error is returned.
searchable (deprecated)	bool This item is deprecated! This field is normally ignored unless AttributesConfig.attribute_config_level of the Catalog is set to the deprecated 'PRODUCT_LEVEL_ATTRIBUTE_CONFIG' mode. For information about product-level attribute configuration, see Configuration modes. If true, custom attribute values are searchable by text queries in SearchService.Search. This field is ignored in a UserEvent. Only set if type text is set. Otherwise, a INVALID_ARGUMENT error is returned.
indexable (deprecated)	bool This item is deprecated! This field is normally ignored unless AttributesConfig.attribute_config_level of the Catalog is set to the deprecated 'PRODUCT_LEVEL_ATTRIBUTE_CONFIG' mode. For information about product-level attribute configuration, see Configuration modes. If true, custom attribute values are indexed, so that they can be filtered, faceted or boosted in SearchService.Search. This field is ignored in a UserEvent. See SearchRequest.filter, SearchRequest.facet_specs and SearchRequest.boost_spec for more details.

DeleteControlRequest

Request for DeleteControl method.

Fields
name	string Required. The resource name of the Control to delete. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/controls/{control_id}

DeleteMerchantCenterAccountLinkRequest

Request for MerchantCenterAccountLinkService.DeleteMerchantCenterAccountLink method.

Fields
name	string Required. Full resource name. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/merchantCenterAccountLinks/{merchant_center_account_link_id}

DeleteModelRequest

Request for deleting a model.

Fields
name	string Required. The resource name of the Model to delete. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}

DeleteProductRequest

Request message for ProductService.DeleteProduct method.

Fields
name	string Required. Full resource name of Product, such as projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id. If the caller does not have permission to delete the Product, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the Product to delete does not exist, a NOT_FOUND error is returned. The Product to delete can neither be a Product.Type.COLLECTION Product member nor a Product.Type.PRIMARY Product with more than one variants. Otherwise, an INVALID_ARGUMENT error is returned. All inventory information for the named Product will be deleted.
force	bool This value only applies to the case when the target product is of type PRIMARY. When deleting a product of VARIANT/COLLECTION type, this value will be ignored. When set to true, the subsequent variant products will be deleted. When set to false, if the primary product has active variant products, an error will be returned.

DeleteServingConfigRequest

Request for DeleteServingConfig method.

Fields
name	string Required. The resource name of the ServingConfig to delete. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/servingConfigs/{serving_config_id}

EnrollSolutionMetadata

This type has no fields.

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

EnrollSolutionRequest

Request for EnrollSolution method.

Fields
project	string Required. Full resource name of parent. Format: projects/{project_number_or_id}
solution	SolutionType Required. Solution to enroll.

EnrollSolutionResponse

Response for EnrollSolution method.

Fields
enrolled_solution	SolutionType Retail API solution that the project has enrolled.

ExperimentInfo

Metadata for active A/B testing Experiment.

Fields
experiment	string The fully qualified resource name of the experiment that provides the serving config under test, should an active experiment exist. For example: projects/*/locations/global/catalogs/default_catalog/experiments/experiment_id
Union field experiment_metadata. Information associated with the specific experiment entity being recorded. experiment_metadata can be only one of the following:
serving_config_experiment	ServingConfigExperiment A/B test between existing Cloud Retail Search ServingConfigs.

ServingConfigExperiment

Metadata for active serving config A/B tests.

Fields
original_serving_config	string The fully qualified resource name of the original SearchRequest.placement in the search request prior to reassignment by experiment API. For example: projects/*/locations/*/catalogs/*/servingConfigs/*.
experiment_serving_config	string The fully qualified resource name of the serving config Experiment.VariantArm.serving_config_id responsible for generating the search response. For example: projects/*/locations/*/catalogs/*/servingConfigs/*.

ExportAnalyticsMetricsRequest

Request message for the ExportAnalyticsMetrics method.

Fields
catalog	string Required. Full resource name of the parent catalog. Expected format: projects/*/locations/*/catalogs/*
output_config	OutputConfig Required. The output location of the data.
filter	string A filtering expression to specify restrictions on returned metrics. The expression is a sequence of terms. Each term applies a restriction to the returned metrics. Use this expression to restrict results to a specific time range. Currently we expect only one types of fields: timestamp: This can be specified twice, once with a less than operator and once with a greater than operator. The timestamp restriction should result in one, contiguous, valid, timestamp range. Some examples of valid filters expressions: Example 1: timestamp > "2012-04-23T18:25:43.511Z" timestamp < "2012-04-23T18:30:43.511Z" Example 2: timestamp > "2012-04-23T18:25:43.511Z"

ExportAnalyticsMetricsResponse

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.

Fields
error_samples[]	Status A sample of errors encountered while processing the request.
errors_config	ExportErrorsConfig This field is never set.
output_result	OutputResult Output result indicating where the data were exported to.

ExportErrorsConfig

Configuration of destination for Export related errors.

Fields
Union field destination. Required. Errors destination. destination can be only one of the following:
gcs_prefix	string Google Cloud Storage path for import errors. This must be an empty, existing Cloud Storage bucket. Export errors will be written to a file in this bucket, one per line, as a JSON-encoded google.rpc.Status message.

ExportMetadata

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

Fields
create_time	Timestamp Operation create time.
update_time	Timestamp Operation last update time. If the operation is done, this is also the finish time.

ExportProductsRequest

Request message for ExportProducts method.

Fields
parent	string Required. Resource name of a Branch, and default_branch for branch_id component is supported. For example projects/1234/locations/global/catalogs/default_catalog/branches/default_branch
output_config	OutputConfig Required. The output location of the data.
filter	string A filtering expression to specify restrictions on returned events. The expression is a sequence of terms. Each term applies a restriction to the returned products. Use this expression to restrict results to a specific time range, tag, or stock state or to filter products by product type. For example, lastModifiedTime > "2012-04-23T18:25:43.511Z" lastModifiedTime<"2012-04-23T18:25:43.511Z" productType=primary We expect only four types of fields: lastModifiedTime: This can be specified twice, once with a less than operator and once with a greater than operator. The lastModifiedTime restriction should result in one, contiguous, valid, last-modified, time range. productType: Supported values are primary and variant. The Boolean operators OR and NOT are supported if the expression is enclosed in parentheses and must be separated from the productType values by a space. availability: Supported values are IN_STOCK, OUT_OF_STOCK, PREORDER, and BACKORDER. Boolean operators OR and NOT are supported if the expression is enclosed in parentheses and must be separated from the availability values by a space. Tag expressions: Restricts output to products that match all of the specified tags. Boolean operators OR and NOT are supported if the expression is enclosed in parentheses and the operators are separated from the tag values by a space. Also supported is '-"tagA"', which is equivalent to 'NOT "tagA"'. Tag values must be double-quoted, UTF-8 encoded strings and have a size limit of 1,000 characters. Some examples of valid filters expressions: Example 1: lastModifiedTime > "2012-04-23T18:25:43.511Z" lastModifiedTime < "2012-04-23T18:30:43.511Z" Example 2: lastModifiedTime > "2012-04-23T18:25:43.511Z" productType = "variant" Example 3: tag=("Red" OR "Blue") tag="New-Arrival" tag=(NOT "promotional") productType = "primary" lastModifiedTime < "2018-04-23T18:30:43.511Z" Example 4: lastModifiedTime > "2012-04-23T18:25:43.511Z" Example 5: availability = (IN_STOCK OR BACKORDER)

ExportProductsResponse

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.

Fields
error_samples[]	Status A sample of errors encountered while processing the request.
errors_config	ExportErrorsConfig This field is never set.
output_result	OutputResult Output result indicating where the data were exported to.

ExportUserEventsRequest

Request message for the ExportUserEvents method.

Fields
parent	string Required. Resource name of a Catalog. For example projects/1234/locations/global/catalogs/default_catalog
output_config	OutputConfig Required. The output location of the data.
filter	string A filtering expression to specify restrictions on returned events. The expression is a sequence of terms. Each term applies a restriction to the returned user events. Use this expression to restrict results to a specific time range or to filter events by eventType. For example, eventTime > "2012-04-23T18:25:43.511Z" eventsMissingCatalogItems eventTime<"2012-04-23T18:25:43.511Z" eventType=search We expect only three types of fields: eventTime: This can be specified twice, once with a less than operator and once with a greater than operator. The eventTime restriction should result in one, contiguous, valid, eventTime range. eventType: Boolean operators OR and NOT are supported if the expression is enclosed in parentheses and the operators are separated from the tag values by a space. eventsMissingCatalogItems: This restricts results to events for which catalog items were not found in the catalog. The default behavior is to return only those events for which catalog items were found. Some examples of valid filters expressions: Example 1: eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z" Example 2: eventTime > "2012-04-23T18:25:43.511Z" eventType = detail-page-view Example 3: eventsMissingCatalogItems eventType = (NOT search) eventTime < "2018-04-23T18:30:43.511Z" Example 4: eventTime > "2012-04-23T18:25:43.511Z" Example 5: eventType = (detail-page-view OR search) Example 6: eventsMissingCatalogItems

ExportUserEventsResponse

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.

Fields
error_samples[]	Status A sample of errors encountered while processing the request.
errors_config	ExportErrorsConfig This field is never set.
output_result	OutputResult Output result indicating where the data were exported to.

FulfillmentInfo

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

Fields
type	string The fulfillment type, including commonly used types (such as pickup in store and same day delivery), and custom types. Customers have to map custom types to their display names before rendering UI. Supported values: "pickup-in-store" "ship-to-store" "same-day-delivery" "next-day-delivery" "custom-type-1" "custom-type-2" "custom-type-3" "custom-type-4" "custom-type-5" If this field is set to an invalid value other than these, an INVALID_ARGUMENT error is returned.
place_ids[]	string The IDs for this type, such as the store IDs for FulfillmentInfo.type.pickup-in-store or the region IDs for FulfillmentInfo.type.same-day-delivery. A maximum of 3000 values are allowed. Each value must be a string with a length limit of 30 characters, matching the pattern [a-zA-Z0-9_-]+, such as "store1" or "REGION-2". Otherwise, an INVALID_ARGUMENT error is returned.

GcsOutputResult

A Gcs output result.

Fields
output_uri	string The uri of Gcs output

GcsSource

Google Cloud Storage location for input content.

Fields
input_uris[]	string Required. Google Cloud Storage URIs to input files. URI can be up to 2000 characters long. URIs can match the full object path (for example, gs://bucket/directory/object.json) or a pattern matching one or more files, such as gs://bucket/directory/*.json. A request can contain at most 100 files, and each file can be up to 2 GB. See Importing product information for the expected file format and setup instructions.
data_schema	string The schema to use when parsing the data from the source. Supported values for product imports: product (default): One JSON Product per line. Each product must have a valid Product.id. product_merchant_center: See Importing catalog data from Merchant Center. Supported values for user events imports: user_event (default): One JSON UserEvent per line. user_event_ga360: Using https://support.google.com/analytics/answer/3437719. Supported values for control imports: control (default): One JSON Control per line. Supported values for catalog attribute imports: catalog_attribute (default): One CSV CatalogAttribute per line.

GetAlertConfigRequest

Request for ProjectService.GetAlertConfig method.

Fields
name	string Required. Full AlertConfig resource name. Format: projects/{project_number}/alertConfig

GetAttributesConfigRequest

Request for CatalogService.GetAttributesConfig method.

Fields
name	string Required. Full AttributesConfig resource name. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/attributesConfig

GetBranchRequest

Request for BranchService.GetBranch method.

Fields
name	string Required. The name of the branch to retrieve. Format: projects/*/locations/global/catalogs/default_catalog/branches/some_branch_id. "default_branch" can be used as a special branch_id, it returns the default branch that has been set for the catalog.
view	BranchView The view to apply to the returned Branch. Defaults to [Branch.BranchView.BASIC] if unspecified. See documentation of fields of Branch to find what fields are excluded from BASIC view.

GetCompletionConfigRequest

Request for CatalogService.GetCompletionConfig method.

Fields
name	string Required. Full CompletionConfig resource name. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/completionConfig

GetControlRequest

Request for GetControl method.

Fields
name	string Required. The resource name of the Control to get. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/controls/{control_id}

GetDefaultBranchRequest

Request message to show which branch is currently the default branch.

Fields
catalog	string The parent catalog resource name, such as projects/*/locations/global/catalogs/default_catalog.

GetDefaultBranchResponse

Response message of CatalogService.GetDefaultBranch.

Fields
branch	string Full resource name of the branch id currently set as default branch.
set_time	Timestamp The time when this branch is set to default.
note	string This corresponds to SetDefaultBranchRequest.note field, when this branch was set as default.

GetLoggingConfigRequest

Request for ProjectService.GetLoggingConfig method.

Fields
name	string Required. Full LoggingConfig resource name. Format: projects/{project_number}/loggingConfig

GetModelRequest

Request for getting a model.

Fields
name	string Required. The resource name of the Model to get. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog}/models/{model_id}

GetProductRequest

Request message for ProductService.GetProduct method.

Fields
name	string Required. Full resource name of Product, such as projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id. If the caller does not have permission to access the Product, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested Product does not exist, a NOT_FOUND error is returned.

GetProjectRequest

Request for GetProject method.

Fields
name	string Required. Full resource name of the project. Format: projects/{project_number_or_id}/retailProject

GetServingConfigRequest

Request for GetServingConfig method.

Fields
name	string Required. The resource name of the ServingConfig to get. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/servingConfigs/{serving_config_id}

Image

Product image. Recommendations AI and Retail Search do not use product images to improve prediction and search results. However, product images can be returned in results, and are shown in prediction or search previews in the console.

Fields
uri	string Required. URI of the image. This field must be a valid UTF-8 encoded URI with a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. Google Merchant Center property image_link. Schema.org property Product.image.
height	int32 Height of the image in number of pixels. This field must be nonnegative. Otherwise, an INVALID_ARGUMENT error is returned.
width	int32 Width of the image in number of pixels. This field must be nonnegative. Otherwise, an INVALID_ARGUMENT error is returned.

ImportCompletionDataRequest

Request message for ImportCompletionData methods.

Fields
parent	string Required. The catalog which the suggestions dataset belongs to. Format: projects/1234/locations/global/catalogs/default_catalog.
input_config	CompletionDataInputConfig Required. The desired input location of the data.
notification_pubsub_topic	string Pub/Sub topic for receiving notification. If this field is set, when the import is finished, a notification is sent to specified Pub/Sub topic. The message data is JSON string of a Operation. Format of the Pub/Sub topic is projects/{project}/topics/{topic}.

ImportCompletionDataResponse

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.

Fields
error_samples[]	Status A sample of errors encountered while processing the request.

ImportErrorsConfig

Configuration of destination for Import related errors.

Fields
Union field destination. Required. Errors destination. destination can be only one of the following:
gcs_prefix	string Google Cloud Storage prefix for import errors. This must be an empty, existing Cloud Storage directory. Import errors are written to sharded files in this directory, one per line, as a JSON-encoded google.rpc.Status message.

ImportMetadata

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

Fields
create_time	Timestamp Operation create time.
update_time	Timestamp Operation last update time. If the operation is done, this is also the finish time.
success_count	int64 Count of entries that were processed successfully.
failure_count	int64 Count of entries that encountered errors while processing.
request_id (deprecated)	string This item is deprecated! Deprecated. This field is never set.
notification_pubsub_topic	string Pub/Sub topic for receiving notification. If this field is set, when the import is finished, a notification is sent to specified Pub/Sub topic. The message data is JSON string of a Operation. Format of the Pub/Sub topic is projects/{project}/topics/{topic}.
transformed_user_events_metadata	TransformedUserEventsMetadata Metadata related to transform user events.

ImportProductsRequest

Request message for Import methods.

Fields
parent	string Required. projects/1234/locations/global/catalogs/default_catalog/branches/default_branch If no updateMask is specified, requires products.create permission. If updateMask is specified, requires products.update permission.
request_id (deprecated)	string This item is deprecated! Deprecated. This field has no effect.
input_config	ProductInputConfig Required. The desired input location of the data.
errors_config	ImportErrorsConfig The desired location of errors incurred during the Import.
update_mask	FieldMask Indicates which fields in the provided imported products to update. If not set, all fields are updated. If provided, only the existing product fields are updated. Missing products will not be created.
reconciliation_mode	ReconciliationMode The mode of reconciliation between existing products and the products to be imported. Defaults to ReconciliationMode.INCREMENTAL.
notification_pubsub_topic	string Full Pub/Sub topic name for receiving notification. If this field is set, when the import is finished, a notification is sent to specified Pub/Sub topic. The message data is JSON string of a Operation. Format of the Pub/Sub topic is projects/{project}/topics/{topic}. It has to be within the same project as ImportProductsRequest.parent. Make sure that both [e-mail] and service-<project number>@gcp-sa-retail.iam.gserviceaccount.com have the pubsub.topics.publish IAM permission on the topic. Only supported when ImportProductsRequest.reconciliation_mode is set to FULL.
skip_default_branch_protection	bool If true, this performs the FULL import even if it would delete a large proportion of the products in the default branch, which could potentially cause outages if you have live predict/search traffic. Only supported when ImportProductsRequest.reconciliation_mode is set to FULL.

ReconciliationMode

Indicates how imported products are reconciled with the existing products created or imported before.

Enums
RECONCILIATION_MODE_UNSPECIFIED	Defaults to INCREMENTAL.
INCREMENTAL	Inserts new products or updates existing products.
FULL	Calculates diff and replaces the entire product dataset. Existing products may be deleted if they are not present in the source location.

ImportProductsResponse

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.

Fields
error_samples[]	Status A sample of errors encountered while processing the request.
errors_config	ImportErrorsConfig Echoes the destination for the complete errors in the request if set.

ImportUserEventsRequest

Request message for the ImportUserEvents request.

Fields
parent	string Required. projects/1234/locations/global/catalogs/default_catalog
input_config	UserEventInputConfig Required. The desired input location of the data.
errors_config	ImportErrorsConfig The desired location of errors incurred during the Import. Cannot be set for inline user event imports.

ImportUserEventsResponse

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.

Fields
error_samples[]	Status A sample of errors encountered while processing the request.
errors_config	ImportErrorsConfig Echoes the destination for the complete errors if this field was set in the request.
import_summary	UserEventImportSummary Aggregated statistics of user event import status.

Interval

A floating point interval.

Fields
Union field min. The lower bound of the interval. If neither of the min fields are set, then the lower bound is negative infinity. This field must not be larger than max. Otherwise, an INVALID_ARGUMENT error is returned. min can be only one of the following:
minimum	double Inclusive lower bound.
exclusive_minimum	double Exclusive lower bound.
Union field max. The upper bound of the interval. If neither of the max fields are set, then the upper bound is positive infinity. This field must be not smaller than min. Otherwise, an INVALID_ARGUMENT error is returned. max can be only one of the following:
maximum	double Inclusive upper bound.
exclusive_maximum	double Exclusive upper bound.

ListBranchesRequest

Request for BranchService.ListBranches method.

Fields
parent	string Required. The parent catalog resource name.
view	BranchView The view to apply to the returned Branch. Defaults to [Branch.BranchView.BASIC] if unspecified. See documentation of fields of Branch to find what fields are excluded from BASIC view.

ListBranchesResponse

Response for BranchService.ListBranches method.

Fields
branches[]	Branch The Branches.

ListCatalogsRequest

Request for CatalogService.ListCatalogs method.

Fields
parent	string Required. The account resource name with an associated location. If the caller does not have permission to list Catalogs under this location, regardless of whether or not this location exists, a PERMISSION_DENIED error is returned.
page_size	int32 Maximum number of Catalogs to return. If unspecified, defaults to 50. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT is returned.
page_token	string A page token ListCatalogsResponse.next_page_token, received from a previous CatalogService.ListCatalogs call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to CatalogService.ListCatalogs must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.

ListCatalogsResponse

Response for CatalogService.ListCatalogs method.

Fields
catalogs[]	Catalog All the customer's Catalogs.
next_page_token	string A token that can be sent as ListCatalogsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

ListControlsRequest

Request for ListControls method.

Fields
parent	string Required. The catalog resource name. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}
page_size	int32 Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.
page_token	string Optional. A page token, received from a previous ListControls call. Provide this to retrieve the subsequent page.
filter	string Optional. A filter to apply on the list results. Supported features: List all the products under the parent branch if filter is unset. List controls that are used in a single ServingConfig: 'serving_config = "boosted_home_page_cvr"'

ListControlsResponse

Response for ListControls method.

Fields
controls[]	Control All the Controls for a given catalog.
next_page_token	string Pagination token, if not returned indicates the last page.

ListEnrolledSolutionsRequest

Request for ListEnrolledSolutions method.

Fields
parent	string Required. Full resource name of parent. Format: projects/{project_number_or_id}

ListEnrolledSolutionsResponse

Response for ListEnrolledSolutions method.

Fields
enrolled_solutions[]	SolutionType Retail API solutions that the project has enrolled.

ListMerchantCenterAccountLinksRequest

Request for MerchantCenterAccountLinkService.ListMerchantCenterAccountLinks method.

Fields
parent	string Required. The parent Catalog of the resource. It must match this format: projects/{PROJECT_NUMBER}/locations/global/catalogs/{CATALOG_ID}

ListMerchantCenterAccountLinksResponse

Response for MerchantCenterAccountLinkService.ListMerchantCenterAccountLinks method.

Fields
merchant_center_account_links[]	MerchantCenterAccountLink The links.

ListModelsRequest

Request for listing models associated with a resource.

Fields
parent	string Required. The parent for which to list models. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}
page_size	int32 Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.
page_token	string Optional. A page token, received from a previous ListModels call. Provide this to retrieve the subsequent page.

ListModelsResponse

Response to a ListModelRequest.

Fields
models[]	Model List of Models.
next_page_token	string Pagination token, if not returned indicates the last page.

ListProductsRequest

Request message for ProductService.ListProducts method.

Fields
parent	string Required. The parent branch resource name, such as projects/*/locations/global/catalogs/default_catalog/branches/0. Use default_branch as the branch ID, to list products under the default branch. If the caller does not have permission to list Products under this branch, regardless of whether or not this branch exists, a PERMISSION_DENIED error is returned.
page_size	int32 Maximum number of Products to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT error is returned.
page_token	string A page token ListProductsResponse.next_page_token, received from a previous ProductService.ListProducts call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ProductService.ListProducts must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.
filter	string A filter to apply on the list results. Supported features: List all the products under the parent branch if filter is unset. List Product.Type.VARIANT Products sharing the same Product.Type.PRIMARY Product. For example: primary_product_id = "some_product_id" List Products bundled in a Product.Type.COLLECTION Product. For example: collection_product_id = "some_product_id" List Products with a partibular type. For example: type = "PRIMARY" type = "VARIANT" type = "COLLECTION" If the field is unrecognizable, an INVALID_ARGUMENT error is returned. If the specified Product.Type.PRIMARY Product or Product.Type.COLLECTION Product does not exist, a NOT_FOUND error is returned.
read_mask	FieldMask The fields of Product to return in the responses. If not set or empty, the following fields are returned: Product.name Product.id Product.title Product.uri Product.images Product.price_info Product.brands If "*" is provided, all fields are returned. Product.name is always returned no matter what mask is set. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned.
require_total_size	bool If true and page_token is empty, ListProductsResponse.total_size is set to the total count of matched items irrespective of pagination. Notice that setting this field to true affects the performance.

ListProductsResponse

Response message for ProductService.ListProducts method.

Fields
products[]	Product The Products.
next_page_token	string A token that can be sent as ListProductsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
total_size	int32 The total count of matched Products irrespective of pagination. The total number of Products returned by pagination may be less than the total_size that matches. This field is ignored if ListProductsRequest.require_total_size is not set or ListProductsRequest.page_token is not empty.

ListServingConfigsRequest

Request for ListServingConfigs method.

Fields
parent	string Required. The catalog resource name. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}
page_size	int32 Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned.
page_token	string Optional. A page token, received from a previous ListServingConfigs call. Provide this to retrieve the subsequent page.

ListServingConfigsResponse

Response for ListServingConfigs method.

Fields
serving_configs[]	ServingConfig All the ServingConfigs for a given catalog.
next_page_token	string Pagination token, if not returned indicates the last page.

LocalInventory

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

Fields
place_id	string The place ID for the current set of inventory information.
price_info	PriceInfo Product price and cost information. Google Merchant Center property price.
attributes	map<string, CustomAttribute> Additional local inventory attributes, for example, store name, promotion tags, etc. This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is returned: At most 30 attributes are allowed. The key must be a UTF-8 encoded string with a length limit of 32 characters. The key must match the pattern: [a-zA-Z0-9][a-zA-Z0-9_]*. For example, key0LikeThis or KEY_1_LIKE_THIS. The attribute values must be of the same type (text or number). Only 1 value is allowed for each attribute. For text values, the length limit is 256 UTF-8 characters. The attribute does not support search. The searchable field should be unset or set to false. The max summed total bytes of custom attribute keys and values per product is 5MiB.
fulfillment_types[]	string Input only. Supported fulfillment types. Valid fulfillment type values include commonly used types (such as pickup in store and same day delivery), and custom types. Customers have to map custom types to their display names before rendering UI. Supported values: "pickup-in-store" "ship-to-store" "same-day-delivery" "next-day-delivery" "custom-type-1" "custom-type-2" "custom-type-3" "custom-type-4" "custom-type-5" If this field is set to an invalid value other than these, an INVALID_ARGUMENT error is returned. All the elements must be distinct. Otherwise, an INVALID_ARGUMENT error is returned.

LoggingConfig

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

Fields
name	string Required. Immutable. The name of the LoggingConfig singleton resource. Format: projects/*/loggingConfig
default_log_generation_rule	LogGenerationRule The log generation rule that applies by default to all services supporting log generation. It can be overridden by ServiceLogGenerationRule for service level control.
service_log_generation_rules[]	ServiceLogGenerationRule Controls logging configurations more granularly for each supported service. This overrides the default_log_generation_rule for the services specified. For those not mentioned, they will fallback to the default log generation rule.

LogGenerationRule

The logging configurations for services supporting log generation.

Fields
logging_level	LoggingLevel The logging level. By default it is set to LOG_WARNINGS_AND_ABOVE.
info_log_sample_rate	float The log sample rate for INFO level log entries. You can use this to reduce the number of entries generated for INFO level logs. DO NOT set this field if the logging_level is not LoggingLevel.LOG_ALL. Otherwise, an INVALID_ARGUMENT error is returned. Sample rate for INFO logs defaults to 1 when unset (generate and send all INFO logs to Cloud Logging). Its value must be greater than 0 and less than or equal to 1.

LoggingLevel

The setting to control log generation.

Enums
LOGGING_LEVEL_UNSPECIFIED	Default value. Defaults to LOG_FOR_WARNINGS_AND_ABOVE if unset.
LOGGING_DISABLED	No log will be generated and sent to Cloud Logging.
LOG_ERRORS_AND_ABOVE	Log for operations resulted in fatal error.
LOG_WARNINGS_AND_ABOVE	In addition to LOG_ERRORS_AND_ABOVE, also log for operations that have soft errors, quality suggestions.
LOG_ALL	Log all operations, including successful ones.

ServiceLogGenerationRule

The granular logging configurations for supported services.

Fields
service_name	string Required. Supported service names: "CatalogService", "CompletionService", "ControlService", "MerchantCenterStreaming", "ModelService", "PredictionService", "ProductService", "ServingConfigService", "UserEventService",
log_generation_rule	LogGenerationRule The log generation rule that applies to this service.

MerchantCenterAccountLink

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.

Fields
name	string Output only. Immutable. Full resource name of the Merchant Center Account Link, such as projects/*/locations/global/catalogs/default_catalog/merchantCenterAccountLinks/merchant_center_account_link.
id	string Output only. Immutable. MerchantCenterAccountLink identifier, which is the final component of name. This field is auto generated and follows the convention: BranchId_MerchantCenterAccountId. projects/*/locations/global/catalogs/default_catalog/merchantCenterAccountLinks/id_1.
merchant_center_account_id	int64 Required. The linked Merchant center account id. The account must be a standalone account or a sub-account of a MCA.
branch_id	string Required. The branch ID (e.g. 0/1/2) within the catalog that products from merchant_center_account_id are streamed to. When updating this field, an empty value will use the currently configured default branch. However, changing the default branch later on won't change the linked branch here. A single branch ID can only have one linked Merchant Center account ID.
feed_label	string The FeedLabel used to perform filtering. Note: this replaces region_id. Example value: US. Example value: FeedLabel1.
language_code	string Language of the title/description and other string attributes. Use language tags defined by BCP 47. ISO 639-1. This specifies the language of offers in Merchant Center that will be accepted. If empty, no language filtering will be performed. Example value: en.
feed_filters[]	MerchantCenterFeedFilter Criteria for the Merchant Center feeds to be ingested via the link. All offers will be ingested if the list is empty. Otherwise the offers will be ingested from selected feeds.
state	State Output only. Represents the state of the link.
project_id	string Output only. Google Cloud project ID.
source	string Optional. An optional arbitrary string that could be used as a tag for tracking link source.

MerchantCenterFeedFilter

Merchant Center Feed filter criterion.

Fields
primary_feed_id	int64 Merchant Center primary feed ID.
primary_feed_name	string Merchant Center primary feed name. The name is used for the display purposes only.

State

The state of the link.

Enums
STATE_UNSPECIFIED	Default value.
PENDING	Link is created and LRO is not complete.
ACTIVE	Link is active.
FAILED	Link creation failed.

MerchantCenterFeedFilter

Merchant Center Feed filter criterion.

Fields
primary_feed_id	int64 Merchant Center primary feed ID.
primary_feed_name	string Merchant Center primary feed name. The name is used for the display purposes only.

MerchantCenterLink

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.

Fields
merchant_center_account_id	int64 Required. The linked Merchant Center account ID. The account must be a standalone account or a sub-account of a MCA.
branch_id	string The branch ID (e.g. 0/1/2) within this catalog that products from merchant_center_account_id are streamed to. When updating this field, an empty value will use the currently configured default branch. However, changing the default branch later on won't change the linked branch here. A single branch ID can only have one linked Merchant Center account ID.
destinations[]	string String representing the destination to import for, all if left empty. List of possible values is given in Included destination. List of allowed string values: "Shopping_ads", "Buy_on_google_listings", "Display_ads", "Local_inventory _ads", "Free_listings", "Free_local_listings" NOTE: The string values are case sensitive.
region_code	string Region code of offers to accept. 2-letter Uppercase ISO 3166-1 alpha-2 code. List of values can be found here under the region tag. If left blank no region filtering will be performed. Example value: US.
language_code	string Language of the title/description and other string attributes. Use language tags defined by BCP 47. ISO 639-1. This specifies the language of offers in Merchant Center that will be accepted. If empty no language filtering will be performed. Example value: en.
feeds[]	MerchantCenterFeedFilter Criteria for the Merchant Center feeds to be ingested via the link. All offers will be ingested if the list is empty. Otherwise the offers will be ingested from selected feeds.

MerchantCenterLinkingConfig

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.

Fields
links[]	MerchantCenterLink Links between Merchant Center accounts and branches.

Model

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.

Fields
name	string Required. The fully qualified resource name of the model. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id} catalog_id has char limit of 50. recommendation_model_id has char limit of 40.
display_name	string Required. The display name of the model. Should be human readable, used to display Recommendation Models in the Retail Cloud Console Dashboard. UTF-8 encoded string with limit of 1024 characters.
training_state	TrainingState Optional. The training state that the model is in (e.g. TRAINING or PAUSED). Since part of the cost of running the service is frequency of training - this can be used to determine when to train model in order to control cost. If not specified: the default value for CreateModel method is TRAINING. The default value for UpdateModel method is to keep the state the same as before.
serving_state	ServingState Output only. The serving state of the model: ACTIVE, NOT_ACTIVE.
create_time	Timestamp Output only. Timestamp the Recommendation Model was created at.
update_time	Timestamp Output only. Timestamp the Recommendation Model was last updated. E.g. if a Recommendation Model was paused - this would be the time the pause was initiated.
type	string Required. The type of model e.g. home-page. Currently supported values: recommended-for-you, others-you-may-like, frequently-bought-together, page-optimization, similar-items, buy-it-again, on-sale-items, and recently-viewed(readonly value). This field together with optimization_objective describe model metadata to use to control model training and serving. See https://cloud.google.com/retail/docs/models for more details on what the model metadata control and which combination of parameters are valid. For invalid combinations of parameters (e.g. type = frequently-bought-together and optimization_objective = ctr), you receive an error 400 if you try to create/update a recommendation with this set of knobs.
optimization_objective	string Optional. The optimization objective e.g. cvr. Currently supported values: ctr, cvr, revenue-per-order. If not specified, we choose default based on model type. Default depends on type of recommendation: recommended-for-you => ctr others-you-may-like => ctr frequently-bought-together => revenue_per_order This field together with optimization_objective describe model metadata to use to control model training and serving. See https://cloud.google.com/retail/docs/models for more details on what the model metadata control and which combination of parameters are valid. For invalid combinations of parameters (e.g. type = frequently-bought-together and optimization_objective = ctr), you receive an error 400 if you try to create/update a recommendation with this set of knobs.
periodic_tuning_state	PeriodicTuningState Optional. The state of periodic tuning. The period we use is 3 months - to do a one-off tune earlier use the TuneModel method. Default value is PERIODIC_TUNING_ENABLED.
last_tune_time	Timestamp Output only. The timestamp when the latest successful tune finished.
tuning_operation	string Output only. The tune operation associated with the model. Can be used to determine if there is an ongoing tune for this recommendation. Empty field implies no tune is goig on.
data_state	DataState Output only. The state of data requirements for this model: DATA_OK and DATA_ERROR. Recommendation model cannot be trained if the data is in DATA_ERROR state. Recommendation model can have DATA_ERROR state even if serving state is ACTIVE: models were trained successfully before, but cannot be refreshed because model no longer has sufficient data for training.
filtering_option	RecommendationsFilteringOption Optional. If RECOMMENDATIONS_FILTERING_ENABLED, recommendation filtering by attributes is enabled for the model.
serving_config_lists[]	ServingConfigList Output only. The list of valid serving configs associated with the PageOptimizationConfig.
model_features_config	ModelFeaturesConfig Optional. Additional model features config.
Union field training_config. Training configuration specific to a Model.type - currently, only for page optimization. training_config can be only one of the following:
page_optimization_config	PageOptimizationConfig Optional. The page optimization config.

ContextProductsType

Use single or multiple context products for recommendations.

Enums
CONTEXT_PRODUCTS_TYPE_UNSPECIFIED	Unspecified default value, should never be explicitly set. Defaults to MULTIPLE_CONTEXT_PRODUCTS.
SINGLE_CONTEXT_PRODUCT	Use only a single product as context for the recommendation. Typically used on pages like add-to-cart or product details.
MULTIPLE_CONTEXT_PRODUCTS	Use one or multiple products as context for the recommendation. Typically used on shopping cart pages.

DataState

Describes whether this model have sufficient training data to be continuously trained.

Enums
DATA_STATE_UNSPECIFIED	Unspecified default value, should never be explicitly set.
DATA_OK	The model has sufficient training data.
DATA_ERROR	The model does not have sufficient training data. Error messages can be queried via Stackdriver.

FrequentlyBoughtTogetherFeaturesConfig

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

Fields
context_products_type	ContextProductsType Optional. Specifies the context of the model when it is used in predict requests. Can only be set for the frequently-bought-together type. If it isn't specified, it defaults to MULTIPLE_CONTEXT_PRODUCTS.

ModelFeaturesConfig

Additional model features config.

Fields
Union field type_dedicated_config. type_dedicated_config can be only one of the following:
frequently_bought_together_config	FrequentlyBoughtTogetherFeaturesConfig Additional configs for frequently-bought-together models.

PageOptimizationConfig

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.

Fields
page_optimization_event_type	string Required. The type of UserEvent this page optimization is shown for. Each page has an associated event type - this will be the corresponding event type for the page that the page optimization model is used on. Supported types: add-to-cart: Products being added to cart. detail-page-view: Products detail page viewed. home-page-view: Homepage viewed category-page-view: Homepage viewed shopping-cart-page-view: User viewing a shopping cart. home-page-view only allows models with type recommended-for-you. All other page_optimization_event_type allow all Model.types.
panels[]	Panel Required. A list of panel configurations. Limit = 5.
restriction	Restriction Optional. How to restrict results across panels e.g. can the same ServingConfig be shown on multiple panels at once. If unspecified, default to UNIQUE_MODEL_RESTRICTION.

Candidate

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

Fields
Union field candidate. candidate can be only one of the following:
serving_config_id	string This has to be a valid ServingConfig identifier. For example, for a ServingConfig with full name: projects/*/locations/global/catalogs/default_catalog/servingConfigs/my_candidate_config, this would be my_candidate_config.

Panel

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

Fields
display_name	string Optional. The name to display for the panel.
candidates[]	Candidate Required. The candidates to consider on the panel.
default_candidate	Candidate Required. The default candidate. If the model fails at serving time, we fall back to the default.

Restriction

Restrictions of expected returned results.

Enums
RESTRICTION_UNSPECIFIED	Unspecified value for restriction.
NO_RESTRICTION	Allow any ServingConfig to be show on any number of panels. Example: Panel1 candidates: pdp_ctr, pdp_cvr, home_page_ctr_no_diversity Panel2 candidates: home_page_ctr_no_diversity, home_page_ctr_diversity, pdp_cvr_no_diversity Restriction = NO_RESTRICTION Valid combinations: (pdp_ctr, home_page_ctr_no_diversity) (pdp_ctr, home_page_ctr_diversity) (pdp_ctr, pdp_cvr_no_diversity) (pdp_cvr, home_page_ctr_no_diversity) (pdp_cvr, home_page_ctr_diversity) (pdp_cvr, pdp_cvr_no_diversity) (home_page_ctr_no_diversity, home_page_ctr_no_diversity) (home_page_ctr_no_diversity, home_page_ctr_diversity) (home_page_ctr_no_diversity, pdp_cvr_no_diversity) Invalid combinations: []
UNIQUE_SERVING_CONFIG_RESTRICTION	Do not allow the same ServingConfig.name to be shown on multiple panels. Example: Panel1 candidates: pdp_ctr, pdp_cvr, home_page_ctr_no_diversity Panel2 candidates: home_page_ctr_no_diversity, home_page_ctr_diversity_low, pdp_cvr_no_diversity Restriction = UNIQUE_SERVING_CONFIG_RESTRICTION Valid combinations: (pdp_ctr, home_page_ctr_no_diversity) (pdp_ctr, home_page_ctr_diversity_low) (pdp_ctr, pdp_cvr_no_diversity) (pdp_ctr, pdp_cvr_no_diversity) (pdp_cvr, home_page_ctr_no_diversity) (pdp_cvr, home_page_ctr_diversity_low) (pdp_cvr, pdp_cvr_no_diversity) (home_page_ctr_no_diversity, home_page_ctr_diversity_low) (home_page_ctr_no_diversity, pdp_cvr_no_diversity) Invalid combinations: (home_page_ctr_no_diversity, home_page_ctr_no_diversity)
UNIQUE_MODEL_RESTRICTION	Do not allow multiple ServingConfigs with same Model.name to be show on on different panels. Example: Panel1 candidates: pdp_ctr, pdp_cvr, home_page_ctr_no_diversity Panel2 candidates: home_page_ctr_no_diversity, home_page_ctr_diversity_low, pdp_cvr_no_diversity Restriction = UNIQUE_MODEL_RESTRICTION Valid combinations: (pdp_ctr, home_page_ctr_no_diversity) (pdp_ctr, home_page_ctr_diversity) (pdp_ctr, pdp_cvr_no_diversity) (pdp_ctr, pdp_cvr_no_diversity) (pdp_cvr, home_page_ctr_no_diversity) (pdp_cvr, home_page_ctr_diversity_low) (home_page_ctr_no_diversity, pdp_cvr_no_diversity) Invalid combinations: (home_page_ctr_no_diversity, home_page_ctr_no_diversity) (pdp_cvr, pdp_cvr_no_diversity)
UNIQUE_MODEL_TYPE_RESTRICTION	Do not allow multiple ServingConfigs with same Model.type to be shown on different panels. Example: Panel1 candidates: pdp_ctr, pdp_cvr, home_page_ctr_no_diversity Panel2 candidates: home_page_ctr_no_diversity, home_page_ctr_diversity_low, pdp_cvr_no_diversity Restriction = UNIQUE_MODEL_RESTRICTION Valid combinations: (pdp_ctr, home_page_ctr_no_diversity) (pdp_ctr, home_page_ctr_diversity) (pdp_cvr, home_page_ctr_no_diversity) (pdp_cvr, home_page_ctr_diversity_low) (home_page_ctr_no_diversity, pdp_cvr_no_diversity) Invalid combinations: (pdp_ctr, pdp_cvr_no_diversity) (pdp_ctr, pdp_cvr_no_diversity) (pdp_cvr, pdp_cvr_no_diversity) (home_page_ctr_no_diversity, home_page_ctr_no_diversity) (home_page_ctr_no_diversity, home_page_ctr_diversity)

PeriodicTuningState

Describes whether periodic tuning is enabled for this model or not. Periodic tuning is scheduled at most every three months. You can start a tuning process manually by using the TuneModel method, which starts a tuning process immediately and resets the quarterly schedule. Enabling or disabling periodic tuning does not affect any current tuning processes.

Enums
PERIODIC_TUNING_STATE_UNSPECIFIED	Unspecified default value, should never be explicitly set.
PERIODIC_TUNING_DISABLED	The model has periodic tuning disabled. Tuning can be reenabled by calling the EnableModelPeriodicTuning method or by calling the TuneModel method.
ALL_TUNING_DISABLED	The model cannot be tuned with periodic tuning OR the TuneModel method. Hide the options in customer UI and reject any requests through the backend self serve API.
PERIODIC_TUNING_ENABLED	The model has periodic tuning enabled. Tuning can be disabled by calling the DisableModelPeriodicTuning method.

ServingConfigList

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

Fields
serving_config_ids[]	string Optional. A set of valid serving configs that may be used for PAGE_OPTIMIZATION.

ServingState

The serving state of the model.

Enums
SERVING_STATE_UNSPECIFIED	Unspecified serving state.
INACTIVE	The model is not serving.
ACTIVE	The model is serving and can be queried.
TUNED	The model is trained on tuned hyperparameters and can be queried.

TrainingState

The training state of the model.

Enums
TRAINING_STATE_UNSPECIFIED	Unspecified training state.
PAUSED	The model training is paused.
TRAINING	The model is training.

OutputConfig

The output configuration setting.

Fields
Union field destination. The configuration of destination for holding output data. destination can be only one of the following:
gcs_destination	GcsDestination The Google Cloud Storage location where the output is to be written to.
bigquery_destination	BigQueryDestination The BigQuery location where the output is to be written to.

BigQueryDestination

The BigQuery output destination configuration.

Fields
dataset_id	string Required. The ID of a BigQuery Dataset.
table_id_prefix	string Required. The prefix of exported BigQuery tables.
table_type	string Required. Describes the table type. The following values are supported: table: A BigQuery native table. view: A virtual table defined by a SQL query.

GcsDestination

The Google Cloud Storage output destination configuration.

Fields
output_uri_prefix	string Required. The output uri prefix for saving output data to json files. Some mapping examples are as follows: output_uri_prefix sample output(assuming the object is foo.json) ======================== ============================================= gs://bucket/ gs://bucket/foo.json gs://bucket/folder/ gs://bucket/folder/foo.json gs://bucket/folder/item_ gs://bucket/folder/item_foo.json

OutputResult

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

Fields
bigquery_result[]	BigQueryOutputResult The BigQuery location where the result is stored.
gcs_result[]	GcsOutputResult The Google Cloud Storage location where the result is stored.

PauseModelRequest

Request for pausing training of a model.

Fields
name	string Required. The name of the model to pause. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}

PredictRequest

Request message for Predict method.

Fields
placement	string Required. Full resource name of the format: {placement=projects/*/locations/global/catalogs/default_catalog/servingConfigs/*} or {placement=projects/*/locations/global/catalogs/default_catalog/placements/*}. We recommend using the servingConfigs resource. placements is a legacy resource. The ID of the Recommendations AI serving config or placement. Before you can request predictions from your model, you must create at least one serving config or placement for it. For more information, see Manage serving configs. The full list of available serving configs can be seen at https://console.cloud.google.com/ai/retail/catalogs/default_catalog/configs
user_event	UserEvent Required. Context about the user, what they are looking at and what action they took to trigger the predict request. Note that this user event detail won't be ingested to userEvent logs. Thus, a separate userEvent write request is required for event logging. Don't set UserEvent.visitor_id or UserInfo.user_id to the same fixed ID for different users. If you are trying to receive non-personalized recommendations (not recommended; this can negatively impact model performance), instead set UserEvent.visitor_id to a random unique ID and leave UserInfo.user_id unset.
page_size	int32 Maximum number of results to return. Set this property to the number of prediction results needed. If zero, the service will choose a reasonable default. The maximum allowed value is 100. Values above 100 will be coerced to 100.
page_token (deprecated)	string This item is deprecated! This field is not used; leave it unset.
filter	string Filter for restricting prediction results with a length limit of 5,000 characters. Accepts values for tags and the filterOutOfStockItems flag. Tag expressions. Restricts predictions to products that match all of the specified tags. Boolean operators OR and NOT are supported if the expression is enclosed in parentheses, and must be separated from the tag values by a space. -"tagA" is also supported and is equivalent to NOT "tagA". Tag values must be double quoted UTF-8 encoded strings with a size limit of 1,000 characters. Note: "Recently viewed" models don't support tag filtering at the moment. filterOutOfStockItems. Restricts predictions to products that do not have a stockState value of OUT_OF_STOCK. Examples: tag=("Red" OR "Blue") tag="New-Arrival" tag=(NOT "promotional") filterOutOfStockItems tag=(-"promotional") filterOutOfStockItems If your filter blocks all prediction results, the API will return no results. If instead you want empty result sets to return generic (unfiltered) popular products, set strictFiltering to False in PredictRequest.params. Note that the API will never return items with storageStatus of "EXPIRED" or "DELETED" regardless of filter choices. If filterSyntaxV2 is set to true under the params field, then attribute-based expressions are expected instead of the above described tag-based syntax. Examples: (colors: ANY("Red", "Blue")) AND NOT (categories: ANY("Phones")) (availability: ANY("IN_STOCK")) AND (colors: ANY("Red") OR categories: ANY("Phones")) For more information, see Filter recommendations.
validate_only	bool Use validate only mode for this prediction query. If set to true, a dummy model will be used that returns arbitrary products. Note that the validate only mode should only be used for testing the API, or if the model is not ready.
params	map<string, Value> Additional domain specific parameters for the predictions. Allowed values: returnProduct: Boolean. If set to true, the associated product object will be returned in the results.metadata field in the prediction response. returnScore: Boolean. If set to true, the prediction 'score' corresponding to each returned product will be set in the results.metadata field in the prediction response. The given 'score' indicates the probability of a product being clicked/purchased given the user's context and history. strictFiltering: Boolean. True by default. If set to false, the service will return generic (unfiltered) popular products instead of empty if your filter blocks all prediction results. priceRerankLevel: String. Default empty. If set to be non-empty, then it needs to be one of {'no-price-reranking', 'low-price-reranking', 'medium-price-reranking', 'high-price-reranking'}. This gives request-level control and adjusts prediction results based on product price. diversityLevel: String. Default empty. If set to be non-empty, then it needs to be one of {'no-diversity', 'low-diversity', 'medium-diversity', 'high-diversity', 'auto-diversity'}. This gives request-level control and adjusts prediction results based on product category. filterSyntaxV2: Boolean. False by default. If set to true, the filter field is interpreteted according to the new, attribute-based syntax.
labels	map<string, string> 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. See Google Cloud Document for more details.

PredictResponse

Response message for predict method.

Fields
results[]	PredictionResult A list of recommended products. The order represents the ranking (from the most relevant product to the least).
attribution_token	string A unique attribution token. This should be included in the UserEvent logs resulting from this recommendation, which enables accurate attribution of recommendation model performance.
missing_ids[]	string IDs of products in the request that were missing from the inventory.
validate_only	bool True if the validateOnly property was set in the request.

PredictionResult

PredictionResult represents the recommendation prediction results.

Fields
id	string ID of the recommended product
metadata	map<string, Value> Additional product metadata / annotations. Possible values: product: JSON representation of the product. Is set if returnProduct is set to true in PredictRequest.params. score: Prediction score in double value. Is set if returnScore is set to true in PredictRequest.params.

PriceInfo

The price information of a Product.

Fields
currency_code	string The 3-letter currency code defined in ISO 4217. If this field is an unrecognizable currency code, an INVALID_ARGUMENT error is returned. The Product.Type.VARIANT Products with the same Product.primary_product_id must share the same currency_code. Otherwise, a FAILED_PRECONDITION error is returned.
price	float Price of the product. Google Merchant Center property price. Schema.org property Offer.price.
original_price	float Price of the product without any discount. If zero, by default set to be the price. If set, original_price should be greater than or equal to price, otherwise an INVALID_ARGUMENT error is thrown.
cost	float The costs associated with the sale of a particular product. Used for gross profit reporting. Profit = price - cost Google Merchant Center property cost_of_goods_sold.
price_effective_time	Timestamp The timestamp when the price starts to be effective. This can be set as a future timestamp, and the price is only used for search after price_effective_time. If so, the original_price must be set and original_price is used before price_effective_time. Do not set if price is always effective because it will cause additional latency during search.
price_expire_time	Timestamp The timestamp when the price stops to be effective. The price is used for search before price_expire_time. If this field is set, the original_price must be set and original_price is used after price_expire_time. Do not set if price is always effective because it will cause additional latency during search.
price_range	PriceRange Output only. The price range of all the child Product.Type.VARIANT Products grouped together on the Product.Type.PRIMARY Product. Only populated for Product.Type.PRIMARY Products. Note: This field is OUTPUT_ONLY for ProductService.GetProduct. Do not set this field in API requests.

PriceRange

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

Fields
price	Interval The inclusive Product.pricing_info.price interval of all variant Product having the same Product.primary_product_id.
original_price	Interval The inclusive Product.pricing_info.original_price internal of all variant Product having the same Product.primary_product_id.

Product

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

Fields
name	string Immutable. Full resource name of the product, such as projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/product_id.
id	string Immutable. Product identifier, which is the final component of name. For example, this field is "id_1", if name is projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/id_1. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property id. Schema.org property Product.sku.
type	Type Immutable. The type of the product. Default to Catalog.product_level_config.ingestion_product_type if unset.
primary_product_id	string Variant group identifier. Must be an id, with the same parent branch with this product. Otherwise, an error is thrown. For Type.PRIMARY Products, this field can only be empty or set to the same value as id. For VARIANT Products, this field cannot be empty. A maximum of 2,000 products are allowed to share the same Type.PRIMARY Product. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property item_group_id. Schema.org property Product.inProductGroupWithID.
collection_member_ids[]	string The id of the collection members when type is Type.COLLECTION. Non-existent product ids are allowed. The type of the members must be either Type.PRIMARY or Type.VARIANT otherwise an INVALID_ARGUMENT error is thrown. Should not set it for other types. A maximum of 1000 values are allowed. Otherwise, an INVALID_ARGUMENT error is return.
gtin	string The Global Trade Item Number (GTIN) of the product. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. This field must be a Unigram. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property gtin. Schema.org property Product.isbn, Product.gtin8, Product.gtin12, Product.gtin13, or Product.gtin14. If the value is not a valid GTIN, an INVALID_ARGUMENT error is returned.
categories[]	string Product categories. This field is repeated for supporting one product belonging to several parallel categories. Strongly recommended using the full path for better search / recommendation quality. To represent full path of category, use '>' sign to separate different hierarchies. If '>' is part of the category name, replace it with other character(s). For example, if a shoes product belongs to both ["Shoes & Accessories" -> "Shoes"] and ["Sports & Fitness" -> "Athletic Clothing" -> "Shoes"], it could be represented as: "categories": [ "Shoes & Accessories > Shoes", "Sports & Fitness > Athletic Clothing > Shoes" ] Must be set for Type.PRIMARY Product otherwise an INVALID_ARGUMENT error is returned. At most 250 values are allowed per Product unless overridden through the Google Cloud console. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property google_product_category. Schema.org property Product.category.
title	string Required. Product title. This field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property title. Schema.org property Product.name.
brands[]	string The brands of the product. A maximum of 30 brands are allowed unless overridden through the Google Cloud console. Each brand must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property brand. Schema.org property Product.brand.
description	string Product description. This field must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property description. Schema.org property Product.description.
language_code	string Language of the title/description and other string attributes. Use language tags defined by BCP 47. For product prediction, this field is ignored and the model automatically detects the text language. The Product can include text in different languages, but duplicating Products to provide text in multiple languages can result in degraded model performance. For product search this