A base abstract class for CloudRetail requests.
CloudRetailServiceThe CloudRetail Service.
CloudRetailService.ScopeAvailable OAuth 2.0 scopes for use with the Vertex AI Search for commerce API.
CloudRetailService.ScopeConstantsAvailable OAuth 2.0 scope constants for use with the Vertex AI Search for commerce API.
ProjectsResourceThe "projects" collection of methods.
ProjectsResource.LocationsResourceThe "locations" collection of methods.
ProjectsResource.LocationsResource.CatalogsResourceThe "catalogs" collection of methods.
ProjectsResource.LocationsResource.CatalogsResource.AttributesConfigResourceThe "attributesConfig" collection of methods.
ProjectsResource.LocationsResource.CatalogsResource.AttributesConfigResource.AddCatalogAttributeRequestAdds the specified CatalogAttribute to the AttributesConfig. If the CatalogAttribute to add already exists, an ALREADY_EXISTS error is returned.
ProjectsResource.LocationsResource.CatalogsResource.AttributesConfigResource.RemoveCatalogAttributeRequestRemoves the specified CatalogAttribute from the AttributesConfig. If the CatalogAttribute to remove does not exist, a NOT_FOUND error is returned.
ProjectsResource.LocationsResource.CatalogsResource.AttributesConfigResource.ReplaceCatalogAttributeRequestReplaces 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.BranchesResourceThe "branches" collection of methods.
ProjectsResource.LocationsResource.CatalogsResource.BranchesResource.OperationsResourceThe "operations" collection of methods.
ProjectsResource.LocationsResource.CatalogsResource.BranchesResource.OperationsResource.GetRequestGets 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.ProductsResourceThe "products" collection of methods.
ProjectsResource.LocationsResource.CatalogsResource.BranchesResource.ProductsResource.AddFulfillmentPlacesRequestWe 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.AddLocalInventoriesRequestUpdates 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.CreateRequestCreates a Product.
ProjectsResource.LocationsResource.CatalogsResource.BranchesResource.ProductsResource.DeleteRequestDeletes a Product.
ProjectsResource.LocationsResource.CatalogsResource.BranchesResource.ProductsResource.GetRequestGets a Product.
ProjectsResource.LocationsResource.CatalogsResource.BranchesResource.ProductsResource.ImportRequestBulk 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.ListRequestGets a list of Products.
ProjectsResource.LocationsResource.CatalogsResource.BranchesResource.ProductsResource.PatchRequestUpdates a Product.
ProjectsResource.LocationsResource.CatalogsResource.BranchesResource.ProductsResource.PurgeRequestPermanently 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.RemoveFulfillmentPlacesRequestWe 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.RemoveLocalInventoriesRequestRemove 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.SetInventoryRequestUpdates 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.
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.CompletionDataResourceThe "completionData" collection of methods.
ProjectsResource.LocationsResource.CatalogsResource.CompletionDataResource.ImportRequestBulk 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.ControlsResourceThe "controls" collection of methods.
ProjectsResource.LocationsResource.CatalogsResource.ControlsResource.CreateRequestCreates a Control. If the Control to create already exists, an ALREADY_EXISTS error is returned.
ProjectsResource.LocationsResource.CatalogsResource.ControlsResource.DeleteRequestDeletes a Control. If the Control to delete does not exist, a NOT_FOUND error is returned.
ProjectsResource.LocationsResource.CatalogsResource.ControlsResource.GetRequestGets a Control.
ProjectsResource.LocationsResource.CatalogsResource.ControlsResource.ListRequestLists all Controls by their parent Catalog.
ProjectsResource.LocationsResource.CatalogsResource.ControlsResource.PatchRequestUpdates 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.ExportAnalyticsMetricsRequestExports analytics metrics. Operation.response
is of type ExportAnalyticsMetricsResponse
. Operation.metadata
is of type ExportMetadata
.
The "generativeQuestion" collection of methods.
ProjectsResource.LocationsResource.CatalogsResource.GenerativeQuestionResource.BatchUpdateRequestAllows management of multiple questions.
ProjectsResource.LocationsResource.CatalogsResource.GenerativeQuestionsResourceThe "generativeQuestions" collection of methods.
ProjectsResource.LocationsResource.CatalogsResource.GenerativeQuestionsResource.ListRequestReturns all questions for a given catalog.
ProjectsResource.LocationsResource.CatalogsResource.GetAttributesConfigRequestGets an AttributesConfig.
ProjectsResource.LocationsResource.CatalogsResource.GetCompletionConfigRequestGets a CompletionConfig.
ProjectsResource.LocationsResource.CatalogsResource.GetDefaultBranchRequestGet which branch is currently default branch set by CatalogService.SetDefaultBranch method under a specified parent catalog.
ProjectsResource.LocationsResource.CatalogsResource.GetGenerativeQuestionFeatureRequestManages overal generative question feature state -- enables toggling feature on and off.
ProjectsResource.LocationsResource.CatalogsResource.ListRequestLists all the Catalogs associated with the project.
ProjectsResource.LocationsResource.CatalogsResource.ModelsResourceThe "models" collection of methods.
ProjectsResource.LocationsResource.CatalogsResource.ModelsResource.CreateRequestCreates a new model.
ProjectsResource.LocationsResource.CatalogsResource.ModelsResource.DeleteRequestDeletes an existing model.
ProjectsResource.LocationsResource.CatalogsResource.ModelsResource.GetRequestGets a model.
ProjectsResource.LocationsResource.CatalogsResource.ModelsResource.ListRequestLists all the models linked to this event store.
ProjectsResource.LocationsResource.CatalogsResource.ModelsResource.PatchRequestUpdate 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.
Pauses the training of an existing model.
ProjectsResource.LocationsResource.CatalogsResource.ModelsResource.ResumeRequestResumes the training of an existing model.
ProjectsResource.LocationsResource.CatalogsResource.ModelsResource.TuneRequestTunes an existing model.
ProjectsResource.LocationsResource.CatalogsResource.OperationsResourceThe "operations" collection of methods.
ProjectsResource.LocationsResource.CatalogsResource.OperationsResource.GetRequestGets 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.ListRequestLists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED
.
Updates the Catalogs.
ProjectsResource.LocationsResource.CatalogsResource.PlacementsResourceThe "placements" collection of methods.
ProjectsResource.LocationsResource.CatalogsResource.PlacementsResource.PredictRequestMakes a recommendation prediction.
ProjectsResource.LocationsResource.CatalogsResource.PlacementsResource.SearchRequestPerforms 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.ServingConfigsResourceThe "servingConfigs" collection of methods.
ProjectsResource.LocationsResource.CatalogsResource.ServingConfigsResource.AddControlRequestEnables 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.CreateRequestCreates a ServingConfig. A maximum of 100 ServingConfigs are allowed in a Catalog, otherwise a FAILED_PRECONDITION error is returned.
ProjectsResource.LocationsResource.CatalogsResource.ServingConfigsResource.DeleteRequestDeletes a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.
ProjectsResource.LocationsResource.CatalogsResource.ServingConfigsResource.GetRequestGets a ServingConfig. Returns a NotFound error if the ServingConfig does not exist.
ProjectsResource.LocationsResource.CatalogsResource.ServingConfigsResource.ListRequestLists all ServingConfigs linked to this catalog.
ProjectsResource.LocationsResource.CatalogsResource.ServingConfigsResource.PatchRequestUpdates a ServingConfig.
ProjectsResource.LocationsResource.CatalogsResource.ServingConfigsResource.PredictRequestMakes a recommendation prediction.
ProjectsResource.LocationsResource.CatalogsResource.ServingConfigsResource.RemoveControlRequestDisables 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.SearchRequestPerforms 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.SetDefaultBranchRequestSet 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}.
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.UpdateCompletionConfigRequestUpdates the CompletionConfigs.
ProjectsResource.LocationsResource.CatalogsResource.UpdateGenerativeQuestionFeatureRequestManages overal generative question feature state -- enables toggling feature on and off.
ProjectsResource.LocationsResource.CatalogsResource.UpdateGenerativeQuestionRequestAllows management of individual questions.
ProjectsResource.LocationsResource.CatalogsResource.UserEventsResourceThe "userEvents" collection of methods.
ProjectsResource.LocationsResource.CatalogsResource.UserEventsResource.CollectRequestWrites 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.ImportRequestBulk 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
.
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.RejoinRequestStarts 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.
ProjectsResource.LocationsResource.CatalogsResource.UserEventsResource.WriteRequestWrites a single user event.
ProjectsResource.LocationsResource.OperationsResourceThe "operations" collection of methods.
ProjectsResource.LocationsResource.OperationsResource.GetRequestGets 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.OperationsResource.ListRequestLists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED
.
The "operations" collection of methods.
ProjectsResource.OperationsResource.GetRequestGets 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.OperationsResource.ListRequestLists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED
.
Data format for response.
CloudRetailBaseServiceRequest<TResponse>.XgafvEnumV1 error format.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4