Package google.cloud.retail.v2alpha

Index

• CatalogService (interface)
• CompletionService (interface)
• ControlService (interface)
• MerchantCenterAccountLinkService (interface)
• ModelService (interface)
• PredictionService (interface)
• ProductService (interface)
• SearchService (interface)
• ServingConfigService (interface)
• UserEventService (interface)
• AddCatalogAttributeRequest (message)
• AddControlRequest (message)
• AddFulfillmentPlacesMetadata (message)
• AddFulfillmentPlacesRequest (message)
• AddFulfillmentPlacesResponse (message)
• AddLocalInventoriesMetadata (message)
• AddLocalInventoriesRequest (message)
• AddLocalInventoriesResponse (message)
• AttributeConfigLevel (enum)
• AttributesConfig (message)
• Audience (message)
• BatchRemoveCatalogAttributesRequest (message)
• BatchRemoveCatalogAttributesResponse (message)
• BigQueryOutputResult (message)
• BigQuerySource (message)
• Catalog (message)
• CatalogAttribute (message)
• CatalogAttribute.AttributeType (enum)
• CatalogAttribute.DynamicFacetableOption (enum)
• CatalogAttribute.ExactSearchableOption (enum)
• 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)
• 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)
• ExperimentInfo (message)
• ExperimentInfo.ServingConfigExperiment (message)
• ExportErrorsConfig (message)
• ExportMetadata (message)
• ExportProductsResponse (message)
• ExportUserEventsResponse (message)
• FulfillmentInfo (message)
• GcsOutputResult (message)
• GcsSource (message)
• GetAttributesConfigRequest (message)
• GetCompletionConfigRequest (message)
• GetControlRequest (message)
• GetDefaultBranchRequest (message)
• GetDefaultBranchResponse (message)
• GetModelRequest (message)
• GetProductRequest (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)
• ListCatalogsRequest (message)
• ListCatalogsResponse (message)
• ListControlsRequest (message)
• ListControlsResponse (message)
• ListMerchantCenterAccountLinksRequest (message)
• ListMerchantCenterAccountLinksResponse (message)
• ListModelsRequest (message)
• ListModelsResponse (message)
• ListProductsRequest (message)
• ListProductsResponse (message)
• ListServingConfigsRequest (message)
• ListServingConfigsResponse (message)
• LocalInventory (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)
• OutputResult (message)
• PauseModelRequest (message)
• PredictRequest (message)
• PredictResponse (message)
• PredictResponse.PredictionResult (message)
• PriceInfo (message)
• PriceInfo.PriceRange (message)
• Product (message)
• Product.Availability (enum)
• Product.Type (enum)
• ProductDetail (message)
• ProductInlineSource (message)
• ProductInputConfig (message)
• ProductLevelConfig (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.IgnoreAction (message)
• Rule.OnewaySynonymsAction (message)
• Rule.RedirectAction (message)
• Rule.ReplacementAction (message)
• Rule.TwowaySynonymsAction (message)
• SearchRequest (message)
• SearchRequest.BoostSpec (message)
• SearchRequest.BoostSpec.ConditionBoostSpec (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)
• SearchResponse (message)
• SearchResponse.Facet (message)
• SearchResponse.Facet.FacetValue (message)
• SearchResponse.QueryExpansionInfo (message)
• SearchResponse.SearchResult (message)
• SearchSolutionUseCase (enum)
• ServingConfig (message)
• ServingConfig.DiversityType (enum)
• SetDefaultBranchRequest (message)
• SetInventoryMetadata (message)
• SetInventoryRequest (message)
• SetInventoryResponse (message)
• SolutionType (enum)
• TransformedUserEventsMetadata (message)
• TuneModelMetadata (message)
• TuneModelRequest (message)
• TuneModelResponse (message)
• UpdateAttributesConfigRequest (message)
• UpdateCatalogRequest (message)
• UpdateCompletionConfigRequest (message)
• UpdateControlRequest (message)
• UpdateModelRequest (message)
• UpdateProductRequest (message)
• UpdateServingConfigRequest (message)
• UserEvent (message)
• UserEventImportSummary (message)
• UserEventInlineSource (message)
• UserEventInputConfig (message)
• UserInfo (message)
• WriteUserEventRequest (message)

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.

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.

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.

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.

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.

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

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