Namespace Google.Apis.CloudRetail.v2beta

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.

ProjectsResource.LocationsResource.CatalogsResource.BranchesResource

The "branches" collection of methods.

ProjectsResource.LocationsResource.CatalogsResource.BranchesResource.OperationsResource

The "operations" collection of methods.

ProjectsResource.LocationsResource.CatalogsResource.BranchesResource.OperationsResource.GetRequest

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

ProjectsResource.LocationsResource.CatalogsResource.BranchesResource.ProductsResource

The "products" collection of methods.

ProjectsResource.LocationsResource.CatalogsResource.BranchesResource.ProductsResource.AddFulfillmentPlacesRequest

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.

ProjectsResource.LocationsResource.CatalogsResource.BranchesResource.ProductsResource.AddLocalInventoriesRequest

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.

ProjectsResource.LocationsResource.CatalogsResource.BranchesResource.ProductsResource.CreateRequest

Creates a Product.

ProjectsResource.LocationsResource.CatalogsResource.BranchesResource.ProductsResource.DeleteRequest

Deletes a Product.

ProjectsResource.LocationsResource.CatalogsResource.BranchesResource.ProductsResource.ExportRequest

Exports multiple Products.

ProjectsResource.LocationsResource.CatalogsResource.BranchesResource.ProductsResource.GetRequest

Gets a Product.

ProjectsResource.LocationsResource.CatalogsResource.BranchesResource.ProductsResource.ImportRequest

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.

ProjectsResource.LocationsResource.CatalogsResource.BranchesResource.ProductsResource.ListRequest

Gets a list of Products.

ProjectsResource.LocationsResource.CatalogsResource.BranchesResource.ProductsResource.PatchRequest

Updates a Product.

ProjectsResource.LocationsResource.CatalogsResource.BranchesResource.ProductsResource.PurgeRequest

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.

ProjectsResource.LocationsResource.CatalogsResource.BranchesResource.ProductsResource.RemoveFulfillmentPlacesRequest

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.

ProjectsResource.LocationsResource.CatalogsResource.BranchesResource.ProductsResource.RemoveLocalInventoriesRequest

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.

ProjectsResource.LocationsResource.CatalogsResource.BranchesResource.ProductsResource.SetInventoryRequest

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.

ProjectsResource.LocationsResource.CatalogsResource.CompleteQueryRequest

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.

ProjectsResource.LocationsResource.CatalogsResource.CompletionDataResource

The "completionData" collection of methods.

ProjectsResource.LocationsResource.CatalogsResource.CompletionDataResource.ImportRequest

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.

ProjectsResource.LocationsResource.CatalogsResource.ControlsResource

The "controls" collection of methods.

ProjectsResource.LocationsResource.CatalogsResource.ControlsResource.CreateRequest

Creates a Control. If the Control to create already exists, an ALREADY_EXISTS error is returned.

ProjectsResource.LocationsResource.CatalogsResource.ControlsResource.DeleteRequest

Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error is returned.

ProjectsResource.LocationsResource.CatalogsResource.ControlsResource.GetRequest

Gets a Control.

ProjectsResource.LocationsResource.CatalogsResource.ControlsResource.ListRequest

Lists all Controls by their parent Catalog.

ProjectsResource.LocationsResource.CatalogsResource.ControlsResource.PatchRequest

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.

ProjectsResource.LocationsResource.CatalogsResource.ExportAnalyticsMetricsRequest

Exports analytics metrics. Operation.response is of type ExportAnalyticsMetricsResponse. Operation.metadata is of type ExportMetadata.

ProjectsResource.LocationsResource.CatalogsResource.GenerativeQuestionResource

The "generativeQuestion" collection of methods.

ProjectsResource.LocationsResource.CatalogsResource.GenerativeQuestionResource.BatchUpdateRequest

Allows management of multiple questions.

ProjectsResource.LocationsResource.CatalogsResource.GenerativeQuestionsResource

The "generativeQuestions" collection of methods.

ProjectsResource.LocationsResource.CatalogsResource.GenerativeQuestionsResource.ListRequest

Returns all questions for a given catalog.

ProjectsResource.LocationsResource.CatalogsResource.GetAttributesConfigRequest

Gets an AttributesConfig.

ProjectsResource.LocationsResource.CatalogsResource.GetCompletionConfigRequest

Gets a CompletionConfig.

ProjectsResource.LocationsResource.CatalogsResource.GetDefaultBranchRequest

Get which branch is currently default branch set by CatalogService.SetDefaultBranch method under a specified parent catalog.

ProjectsResource.LocationsResource.CatalogsResource.GetGenerativeQuestionFeatureRequest

Manages overal generative question feature state -- enables toggling feature on and off.

ProjectsResource.LocationsResource.CatalogsResource.ListRequest

Lists all the Catalogs associated with the project.

ProjectsResource.LocationsResource.CatalogsResource.ModelsResource

The "models" collection of methods.

ProjectsResource.LocationsResource.CatalogsResource.ModelsResource.CreateRequest

Creates a new model.

ProjectsResource.LocationsResource.CatalogsResource.ModelsResource.DeleteRequest

Deletes an existing model.

ProjectsResource.LocationsResource.CatalogsResource.ModelsResource.GetRequest

Gets a model.

ProjectsResource.LocationsResource.CatalogsResource.ModelsResource.ListRequest

Lists all the models linked to this event store.

ProjectsResource.LocationsResource.CatalogsResource.ModelsResource.PatchRequest

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.

ProjectsResource.LocationsResource.CatalogsResource.ModelsResource.PauseRequest

Pauses the training of an existing model.

ProjectsResource.LocationsResource.CatalogsResource.ModelsResource.ResumeRequest

Resumes the training of an existing model.

ProjectsResource.LocationsResource.CatalogsResource.ModelsResource.TuneRequest

Tunes an existing model.

ProjectsResource.LocationsResource.CatalogsResource.OperationsResource

The "operations" collection of methods.

ProjectsResource.LocationsResource.CatalogsResource.OperationsResource.GetRequest

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

ProjectsResource.LocationsResource.CatalogsResource.OperationsResource.ListRequest

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

ProjectsResource.LocationsResource.CatalogsResource.PatchRequest

Updates the Catalogs.

ProjectsResource.LocationsResource.CatalogsResource.PlacementsResource

The "placements" collection of methods.

ProjectsResource.LocationsResource.CatalogsResource.PlacementsResource.PredictRequest

Makes a recommendation prediction.

ProjectsResource.LocationsResource.CatalogsResource.PlacementsResource.SearchRequest

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.

ProjectsResource.LocationsResource.CatalogsResource.ServingConfigsResource

The "servingConfigs" collection of methods.

ProjectsResource.LocationsResource.CatalogsResource.ServingConfigsResource.AddControlRequest

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.

ProjectsResource.LocationsResource.CatalogsResource.ServingConfigsResource.CreateRequest

Creates a ServingConfig. A maximum of 100 ServingConfigs are allowed in a Catalog, otherwise a FAILED_PRECONDITION error is returned.

ProjectsResource.LocationsResource.CatalogsResource.ServingConfigsResource.DeleteRequest

Deletes a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.

ProjectsResource.LocationsResource.CatalogsResource.ServingConfigsResource.GetRequest

Gets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.

ProjectsResource.LocationsResource.CatalogsResource.ServingConfigsResource.ListRequest

Lists all ServingConfigs linked to this catalog.

ProjectsResource.LocationsResource.CatalogsResource.ServingConfigsResource.PatchRequest

Updates a ServingConfig.

ProjectsResource.LocationsResource.CatalogsResource.ServingConfigsResource.PredictRequest

Makes a recommendation prediction.

ProjectsResource.LocationsResource.CatalogsResource.ServingConfigsResource.RemoveControlRequest

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.

ProjectsResource.LocationsResource.CatalogsResource.ServingConfigsResource.SearchRequest

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.

ProjectsResource.LocationsResource.CatalogsResource.SetDefaultBranchRequest

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

ProjectsResource.LocationsResource.CatalogsResource.UpdateAttributesConfigRequest

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.

ProjectsResource.LocationsResource.CatalogsResource.UpdateCompletionConfigRequest

Updates the CompletionConfigs.

ProjectsResource.LocationsResource.CatalogsResource.UpdateGenerativeQuestionFeatureRequest

Manages overal generative question feature state -- enables toggling feature on and off.

ProjectsResource.LocationsResource.CatalogsResource.UpdateGenerativeQuestionRequest

Allows management of individual questions.

ProjectsResource.LocationsResource.CatalogsResource.UserEventsResource

The "userEvents" collection of methods.

ProjectsResource.LocationsResource.CatalogsResource.UserEventsResource.CollectRequest

Writes a single user event from the browser. For larger user event payload over 16 KB, the POST method should be used instead, otherwise a 400 Bad Request error is returned. This method is used only by the Retail API JavaScript pixel and Google Tag Manager. Users should not call this method directly.

ProjectsResource.LocationsResource.CatalogsResource.UserEventsResource.ExportRequest

Exports user events. Operation.response is of type ExportResponse. Operation.metadata is of type ExportMetadata.

ProjectsResource.LocationsResource.CatalogsResource.UserEventsResource.ImportRequest

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.

ProjectsResource.LocationsResource.CatalogsResource.UserEventsResource.PurgeRequest

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.

ProjectsResource.LocationsResource.CatalogsResource.UserEventsResource.RejoinRequest

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.

Namespace Google.Apis.CloudRetail.v2beta

Classes

Enums