Note that we now highly recommend new customers to use Retail API, which incorporates the GA version of the Recommendations AI funtionalities. To enable Retail API, please visit http://console.cloud.go888ogle.com.fqhub.com/apis/library/retail.googleapis.com. The Recommendations AI service enables customers to build end-to-end personalized recommendation systems without requiring a high level of expertise in machine learning, recommendation system, or Google Cloud.
- REST Resource: v1beta1.projects.locations.catalogs
- REST Resource: v1beta1.projects.locations.catalogs.catalogItems
- REST Resource: v1beta1.projects.locations.catalogs.eventStores.operations
- REST Resource: v1beta1.projects.locations.catalogs.eventStores.placements
- REST Resource: v1beta1.projects.locations.catalogs.eventStores.predictionApiKeyRegistrations
- REST Resource: v1beta1.projects.locations.catalogs.eventStores.userEvents
- REST Resource: v1beta1.projects.locations.catalogs.operations
Service: recommendationengine.googleapis.com
To call this service, we recommend that you use the Google-provided client libraries. If your application needs to use your own libraries to call this service, use the following information when you make the API requests.
Discovery document
A Discovery Document is a machine-readable specification for describing and consuming REST APIs. It is used to build client libraries, IDE plugins, and other tools that interact with Google APIs. One service may provide multiple discovery documents. This service provides the following discovery document:
Service endpoint
A service endpoint is a base URL that specifies the network address of an API service. One service might have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:
http://recommendationengine.googleapis.com
REST Resource: v1beta1.projects.locations.catalogs
Methods | |
---|---|
list |
GET /v1beta1/{parent=projects/*/locations/*}/catalogs Lists all the catalog configurations associated with the project. |
patch |
PATCH /v1beta1/{catalog.name=projects/*/locations/*/catalogs/*} Updates the catalog configuration. |
REST Resource: v1beta1.projects.locations.catalogs.catalogItems
Methods | |
---|---|
create |
POST /v1beta1/{parent=projects/*/locations/*/catalogs/*}/catalogItems Creates a catalog item. |
delete |
DELETE /v1beta1/{name=projects/*/locations/*/catalogs/*/catalogItems/**} Deletes a catalog item. |
get |
GET /v1beta1/{name=projects/*/locations/*/catalogs/*/catalogItems/**} Gets a specific catalog item. |
import |
POST /v1beta1/{parent=projects/*/locations/*/catalogs/*}/catalogItems:import Bulk import of multiple catalog items. |
list |
GET /v1beta1/{parent=projects/*/locations/*/catalogs/*}/catalogItems Gets a list of catalog items. |
patch |
PATCH /v1beta1/{name=projects/*/locations/*/catalogs/*/catalogItems/**} Updates a catalog item. |
REST Resource: v1beta1.projects.locations.catalogs.eventStores.operations
Methods | |
---|---|
get |
GET /v1beta1/{name=projects/*/locations/*/catalogs/*/eventStores/*/operations/*} Gets the latest state of a long-running operation. |
list |
GET /v1beta1/{name=projects/*/locations/*/catalogs/*/eventStores/*}/operations Lists operations that match the specified filter in the request. |
REST Resource: v1beta1.projects.locations.catalogs.eventStores.placements
Methods | |
---|---|
predict |
POST /v1beta1/{name=projects/*/locations/*/catalogs/*/eventStores/*/placements/*}:predict Makes a recommendation prediction. |
REST Resource: v1beta1.projects.locations.catalogs.eventStores.predictionApiKeyRegistrations
Methods | |
---|---|
create |
POST /v1beta1/{parent=projects/*/locations/*/catalogs/*/eventStores/*}/predictionApiKeyRegistrations Register an API key for use with predict method. |
delete |
DELETE /v1beta1/{name=projects/*/locations/*/catalogs/*/eventStores/*/predictionApiKeyRegistrations/*} Unregister an apiKey from using for predict method. |
list |
GET /v1beta1/{parent=projects/*/locations/*/catalogs/*/eventStores/*}/predictionApiKeyRegistrations List the registered apiKeys for use with predict method. |
REST Resource: v1beta1.projects.locations.catalogs.eventStores.userEvents
Methods | |
---|---|
collect |
GET /v1beta1/{parent=projects/*/locations/*/catalogs/*/eventStores/*}/userEvents:collect Writes a single user event from the browser. |
import |
POST /v1beta1/{parent=projects/*/locations/*/catalogs/*/eventStores/*}/userEvents:import Bulk import of User events. |
list |
GET /v1beta1/{parent=projects/*/locations/*/catalogs/*/eventStores/*}/userEvents Gets a list of user events within a time range, with potential filtering. |
purge |
POST /v1beta1/{parent=projects/*/locations/*/catalogs/*/eventStores/*}/userEvents:purge Deletes permanently all user events specified by the filter provided. |
rejoin |
POST /v1beta1/{parent=projects/*/locations/*/catalogs/*/eventStores/*}/userEvents:rejoin Triggers a user event rejoin operation with latest catalog data. |
write |
POST /v1beta1/{parent=projects/*/locations/*/catalogs/*/eventStores/*}/userEvents:write Writes a single user event. |
REST Resource: v1beta1.projects.locations.catalogs.operations
Methods | |
---|---|
get |
GET /v1beta1/{name=projects/*/locations/*/catalogs/*/operations/*} Gets the latest state of a long-running operation. |
list |
GET /v1beta1/{name=projects/*/locations/*/catalogs/*}/operations Lists operations that match the specified filter in the request. |