AI Commerce Search API
The AI Commerce Search API is made up of Retail Search, Browse and Recommendations. These discovery AI solutions help you implement personalized search,…
AI & machine learning#openapi#analytics#media
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
The AI Commerce Search API is made up of Retail Search, Browse and Recommendations. These discovery AI solutions help you implement personalized search, browse and recommendations, based on machine learning models, across your websites and mobile applications.
Endpoints 48
projects.locations.catalogs
- GETCompletes the specified prefix with keyword suggestions
/v2/:catalog:completeQuery?dataset=string&deviceType=string&enableAttributeSuggestions=true&entity=string&languageCodes=string&maxSuggestions=0&query=string&visitorId=stringCompletes the specified prefix with keyword suggestions. This feature is only available for users who have Retail Search enabled. Enable Retail Search on… - POSTExports analytics metrics
/v2/:catalog:exportAnalyticsMetricsExports analytics metrics. Operation.response is of type ExportAnalyticsMetricsResponse. Operation.metadata is of type ExportMetadata. - GETReturns the conversational search customization config for a given catalog.
/v2/:name/conversationalSearchCustomizationConfigReturns the conversational search customization config for a given catalog. - GETGet which branch is currently default branch set by CatalogService.SetDefaultBranch method under a specified parent…
/v2/:catalog:getDefaultBranchGet which branch is currently default branch set by CatalogService.SetDefaultBranch method under a specified parent catalog. - GETManages overal generative question feature state -- enables toggling feature on and off.
/v2/:catalog/generativeQuestionFeatureManages overal generative question feature state -- enables toggling feature on and off. - PATCHManages overal generative question feature state -- enables toggling feature on and off.
/v2/:catalog/generativeQuestionFeature?updateMask=stringManages overal generative question feature state -- enables toggling feature on and off. - GETLists all the Catalogs associated with the project.
/v2/:parent/catalogs?pageSize=0&pageToken=stringLists all the Catalogs associated with the project. - POSTSet a specified branch id as default branch
/v2/:catalog:setDefaultBranchSet a specified branch id as default branch. API methods such as SearchService.Search, ProductService.GetProduct, ProductService.ListProducts will treat… - PATCHUpdates the conversational search customization config for a given catalog.
/v2/:catalog/conversationalSearchCustomizationConfig?updateMask=stringUpdates the conversational search customization config for a given catalog. - PATCHAllows management of individual questions.
/v2/:catalog/generativeQuestion?updateMask=stringAllows management of individual questions.
projects.operations
- GETGets the latest state of a long-running operation
/v2/:nameGets 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. - GETLists operations that match the specified filter in the request
/v2/:name/operations?filter=string&pageSize=0&pageToken=string&returnPartialSuccess=trueLists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.
projects.locations.catalogs.servingConfigs
- DELETEDeletes a ServingConfig
/v2/:nameDeletes a ServingConfig. Returns a NotFound error if the ServingConfig does not exist. - PATCHUpdates a ServingConfig.
/v2/:name?updateMask=stringUpdates a ServingConfig. - POSTPerforms a conversational search
/v2/:placement:conversationalSearchPerforms a conversational search. This feature is only available for users who have Conversational Search enabled. - POSTMakes a recommendation prediction.
/v2/:placement:predictMakes a recommendation prediction. - POSTPerforms a search
/v2/:placement:searchPerforms a search. This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature. - POSTEnables a Control on the specified ServingConfig
/v2/:servingConfig:addControlEnables 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… - GETLists all ServingConfigs linked to this catalog.
/v2/:parent/servingConfigs?pageSize=0&pageToken=stringLists all ServingConfigs linked to this catalog. - POSTCreates a ServingConfig
/v2/:parent/servingConfigs?servingConfigId=stringCreates a ServingConfig. A maximum of 100 ServingConfigs are allowed in a Catalog, otherwise a FAILED_PRECONDITION error is returned. - POSTDisables a Control on the specified ServingConfig
/v2/:servingConfig:removeControlDisables 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…
projects.locations.catalogs.attributesConfig
- POSTAdds the specified CatalogAttribute to the AttributesConfig
/v2/:attributesConfig:addCatalogAttributeAdds the specified CatalogAttribute to the AttributesConfig. If the CatalogAttribute to add already exists, an ALREADY_EXISTS error is returned. - POSTRemoves the specified CatalogAttribute from the AttributesConfig
/v2/:attributesConfig:removeCatalogAttributeRemoves the specified CatalogAttribute from the AttributesConfig. If the CatalogAttribute to remove does not exist, a NOT_FOUND error is returned. - POSTReplaces the specified CatalogAttribute in the AttributesConfig by updating the catalog attribute with the same…
/v2/:attributesConfig:replaceCatalogAttributeReplaces the specified CatalogAttribute in the AttributesConfig by updating the catalog attribute with the same CatalogAttribute.key. If the CatalogAttribute…
projects.locations.catalogs.branches.products
- POSTWe recommend that you use the ProductService.AddLocalInventories method instead of the…
/v2/:product:addFulfillmentPlacesWe recommend that you use the ProductService.AddLocalInventories method instead of the ProductService.AddFulfillmentPlaces method.… - POSTUpdates local inventory information for a Product at a list of places, while respecting the last update timestamps of…
/v2/:product:addLocalInventoriesUpdates local inventory information for a Product at a list of places, while respecting the last update timestamps of each inventory field. This process is… - GETGets a list of Products.
/v2/:parent/products?filter=string&pageSize=0&pageToken=string&readMask=stringGets a list of Products. - POSTCreates a Product.
/v2/:parent/products?productId=stringCreates a Product. - POSTBulk import of multiple Products
/v2/:parent/products:importBulk 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… - POSTPermanently deletes all selected Products under a branch
/v2/:parent/products:purgePermanently deletes all selected Products under a branch. This process is asynchronous. If the request is valid, the removal will be enqueued and processed… - POSTWe recommend that you use the ProductService.RemoveLocalInventories method instead of the…
/v2/:product:removeFulfillmentPlacesWe recommend that you use the ProductService.RemoveLocalInventories method instead of the ProductService.RemoveFulfillmentPlaces method.… - POSTRemove local inventory information for a Product at a list of places at a removal timestamp
/v2/:product:removeLocalInventoriesRemove 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… - POSTUpdates inventory information for a Product while respecting the last update timestamps of each inventory field
/v2/:name:setInventoryUpdates inventory information for a Product while respecting the last update timestamps of each inventory field. This process is asynchronous and does not…
projects.locations.catalogs.completionData
- POSTBulk import of processed completion dataset
/v2/:parent/completionData:importBulk import of processed completion dataset. Request processing is asynchronous. Partial updating is not supported. The operation is successfully finished…
projects.locations.catalogs.controls
- GETLists all Controls by their parent Catalog.
/v2/:parent/controls?filter=string&pageSize=0&pageToken=stringLists all Controls by their parent Catalog. - POSTCreates a Control
/v2/:parent/controls?controlId=stringCreates a Control. If the Control to create already exists, an ALREADY_EXISTS error is returned.
projects.locations.catalogs.generativeQuestion
- POSTAllows management of multiple questions.
/v2/:parent/generativeQuestion:batchUpdateAllows management of multiple questions.
projects.locations.catalogs.generativeQuestions
- GETReturns all questions for a given catalog.
/v2/:parent/generativeQuestionsReturns all questions for a given catalog.
projects.locations.catalogs.models
- GETLists all the models linked to this event store.
/v2/:parent/models?pageSize=0&pageToken=stringLists all the models linked to this event store. - POSTCreates a new model.
/v2/:parent/models?dryRun=trueCreates a new model. - POSTPauses the training of an existing model.
/v2/:name:pausePauses the training of an existing model. - POSTResumes the training of an existing model.
/v2/:name:resumeResumes the training of an existing model. - POSTTunes an existing model.
/v2/:name:tuneTunes an existing model.
projects.locations.catalogs.userEvents
- POSTWrites a single user event from the browser
/v2/:parent/userEvents:collectWrites 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… - POSTBulk import of User events
/v2/:parent/userEvents:importBulk import of User events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user… - POSTDeletes permanently all user events specified by the filter provided
/v2/:parent/userEvents:purgeDeletes permanently all user events specified by the filter provided. Depending on the number of events specified by the filter, this operation could take… - POSTStarts a user-event rejoin operation with latest product catalog
/v2/:parent/userEvents:rejoinStarts a user-event rejoin operation with latest product catalog. Events are not annotated with detailed product information for products that are missing… - POSTWrites a single user event.
/v2/:parent/userEvents:write?writeAsync=trueWrites a single user event.
API details
- Base URL
https://retail.googleapis.com- Authentication
- OAuth 2.0 (authorization code flow) with 1 scope
An API key in the key query parameter - Operations
- 48 operations on 41 pathsPOST 31GET 12PATCH 4DELETE 1
- Main resources
- projects.locations.catalogs 10projects.locations.catalogs.branches.products 9projects.locations.catalogs.servingConfigs 9projects.locations.catalogs.models 5projects.locations.catalogs.userEvents 5projects.locations.catalogs.attributesConfig 3projects.locations.catalogs.controls 2projects.operations 2projects.locations.catalogs.completionData 1projects.locations.catalogs.generativeQuestion 1
- Response formats
application/json- Description format
- Google API Discovery, API version
v2 - Links
- Documentation · OpenAPI document
- Listed from
- Google API Discovery document (googleapis/discovery-artifact-manager) (Apache-2.0)
How to test the AI Commerce Search API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the AI Commerce Search API collection, without the publisher's secrets.
- Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Completes the specified prefix with keyword suggestions” (GET /v2/:catalog:completeQuery?dataset=string&deviceType=string&enableAttributeSuggestions=true&entity=string&languageCodes=string&maxSuggestions=0&query=string&visitorId=string), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the AI Commerce Search API?
The AI Commerce Search API is made up of Retail Search, Browse and Recommendations. These discovery AI solutions help you implement personalized search,… It is listed under AI & machine learning and has 48 endpoints.
Who publishes the AI Commerce Search API?
It is listed from Google's public API description (an OpenAPI document), not published by Google on Swastik Codes. Anyone who controls googleapis.com can claim the profile by adding a DNS TXT record.
What is the base URL of the AI Commerce Search API?
Requests go to https://retail.googleapis.com. Endpoint paths are added to this base URL.
How do I authenticate with the AI Commerce Search API?
It accepts 2 methods: OAuth 2.0 (authorization code flow) with 1 scope; an API key in the key query parameter.
How many endpoints does the AI Commerce Search API have?
48 operations on 41 paths (31 POST, 12 GET, 4 PATCH, 1 DELETE). The largest groups are projects.locations.catalogs, projects.locations.catalogs.branches.products, projects.locations.catalogs.servingConfigs, projects.locations.catalogs.models.
Is forking the AI Commerce Search API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.