Google

Recommendations AI (Beta)

Note that we now highly recommend new customers to use Retail API, which incorporates the GA version of the Recommendations AI funtionalities. To enable…

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

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 https://console.cloud.google.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.

Endpoints 17

projects.locations.catalogs

  • GETLists all the catalog configurations associated with the project./v1beta1/:parent/catalogs?pageSize=0&pageToken=stringLists all the catalog configurations associated with the project.

projects.locations.catalogs.operations

  • GETGets the latest state of a long-running operation/v1beta1/: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/v1beta1/: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.eventStores.predictionApiKeyRegistrations

  • DELETEUnregister an apiKey from using for predict method./v1beta1/:nameUnregister an apiKey from using for predict method.
  • GETList the registered apiKeys for use with predict method./v1beta1/:parent/predictionApiKeyRegistrations?pageSize=0&pageToken=stringList the registered apiKeys for use with predict method.
  • POSTRegister an API key for use with predict method./v1beta1/:parent/predictionApiKeyRegistrationsRegister an API key for use with predict method.

projects.locations.catalogs.catalogItems

  • PATCHUpdates a catalog item/v1beta1/:name?updateMask=stringUpdates a catalog item. Partial updating is supported. Non-existing items will be created.
  • GETGets a list of catalog items./v1beta1/:parent/catalogItems?filter=string&pageSize=0&pageToken=stringGets a list of catalog items.
  • POSTCreates a catalog item./v1beta1/:parent/catalogItemsCreates a catalog item.
  • POSTBulk import of multiple catalog items/v1beta1/:parent/catalogItems:importBulk import of multiple catalog items. Request processing may be synchronous. No partial updating supported. Non-existing items will be created.…

projects.locations.catalogs.eventStores.placements

  • POSTMakes a recommendation prediction/v1beta1/:name:predictMakes a recommendation prediction. If using API Key based authentication, the API Key must be registered using the PredictionApiKeyRegistry service. Learn more.

projects.locations.catalogs.eventStores.userEvents

  • GETWrites a single user event from the browser/v1beta1/:parent/userEvents:collect?ets=string&uri=string&userEvent=stringWrites 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…
  • POSTBulk import of User events/v1beta1/: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…
  • GETGets a list of user events within a time range, with potential filtering/v1beta1/:parent/userEvents?filter=string&pageSize=0&pageToken=stringGets a list of user events within a time range, with potential filtering. The method does not list unjoined user events. Unjoined user event definition: when…
  • POSTDeletes permanently all user events specified by the filter provided/v1beta1/: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…
  • POSTTriggers a user event rejoin operation with latest catalog data/v1beta1/:parent/userEvents:rejoinTriggers a user event rejoin operation with latest catalog data. Events will not be annotated with detailed catalog information if catalog item is missing at…
  • POSTWrites a single user event./v1beta1/:parent/userEvents:writeWrites a single user event.

API details

Base URL
https://recommendationengine.googleapis.com
Authentication
OAuth 2.0 (authorization code flow) with 1 scope
An API key in the key query parameter
Operations
17 operations on 13 pathsPOST 8GET 7PATCH 1DELETE 1
Main resources
projects.locations.catalogs.eventStores.userEvents 6projects.locations.catalogs.catalogItems 4projects.locations.catalogs.eventStores.predictionApiKeyReg… 3projects.locations.catalogs.operations 2projects.locations.catalogs 1projects.locations.catalogs.eventStores.placements 1
Response formats
application/json
Description format
Google API Discovery, API version v1beta1

How to test the Recommendations AI (Beta) in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Recommendations AI (Beta) collection, without the publisher's secrets.
  3. 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.
  4. Send a requestPick an endpoint, for example “Lists all the catalog configurations associated with the project.” (GET /v1beta1/:parent/catalogs?pageSize=0&pageToken=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Recommendations AI (Beta)?

Note that we now highly recommend new customers to use Retail API, which incorporates the GA version of the Recommendations AI funtionalities. To enable… It is listed under AI & machine learning and has 17 endpoints.

Who publishes the Recommendations AI (Beta)?

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 Recommendations AI (Beta)?

Requests go to https://recommendationengine.googleapis.com. Endpoint paths are added to this base URL.

How do I authenticate with the Recommendations AI (Beta)?

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 Recommendations AI (Beta) have?

17 operations on 13 paths (8 POST, 7 GET, 1 PATCH, 1 DELETE). The largest groups are projects.locations.catalogs.eventStores.userEvents, projects.locations.catalogs.catalogItems, projects.locations.catalogs.eventStores.predictionApiKeyReg…, projects.locations.catalogs.operations.

Is forking the Recommendations AI (Beta) free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.