Skip to content
OpenParablePublic APIs

Recommendations AI (Beta) API

by googleapis.com

OAuthHTTPSAnalytics
Open documentation ↗

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.

Recommendations AI (Beta) is an analytics API from googleapis.com. Requests are authenticated with OAuth. It is served over HTTPS. Its OpenAPI description documents 17 endpoints.

At a glance

Authentication
OAuth
HTTPS
Yes
CORS
Unknown
Category
Analytics
Base URL
https://recommendationengine.googleapis.com/
Version
v1beta1
Endpoints
17
OpenAPI
Specification ↗
Spec updated
2023-04-21

Make a first request

Replace the placeholders; the documentation says exactly where credentials go.

cURL
curl -X GET "https://recommendationengine.googleapis.com/v1beta1/NAME" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer YOUR_TOKEN"
JavaScript
const response = await fetch("https://recommendationengine.googleapis.com/v1beta1/NAME", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "Authorization": "Bearer YOUR_TOKEN",
  },
});
const data = await response.json();
console.log(data);
Python
import requests

response = requests.request(
    "GET",
    "https://recommendationengine.googleapis.com/v1beta1/NAME",
    headers={
    "Accept": "application/json",
    "Authorization": "Bearer YOUR_TOKEN",
    },
    timeout=30,
)
print(response.json())

Endpoints

MethodPathWhat it does
GET/v1beta1/{name}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.
PATCH/v1beta1/{name}Updates a catalog item. Partial updating is supported. Non-existing items will be created.
DELETE/v1beta1/{name}Unregister an apiKey from using for predict method.
GET/v1beta1/{name}/operationsLists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
POST/v1beta1/{name}:predictMakes a recommendation prediction. If using API Key based authentication, the API Key must be registered using the PredictionApiKeyRegistry service. [Learn more
GET/v1beta1/{parent}/catalogItemsGets a list of catalog items.
POST/v1beta1/{parent}/catalogItemsCreates a catalog item.
POST/v1beta1/{parent}/catalogItems:importBulk import of multiple catalog items. Request processing may be synchronous. No partial updating supported. Non-existing items will be created. Operation.respo
GET/v1beta1/{parent}/catalogsLists all the catalog configurations associated with the project.
GET/v1beta1/{parent}/predictionApiKeyRegistrationsList the registered apiKeys for use with predict method.
POST/v1beta1/{parent}/predictionApiKeyRegistrationsRegister an API key for use with predict method.
GET/v1beta1/{parent}/userEventsGets 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 a
GET/v1beta1/{parent}/userEvents:collectWrites 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 b
POST/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 even
POST/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 hours
POST/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 th
POST/v1beta1/{parent}/userEvents:writeWrites a single user event.

Questions

Does the Recommendations AI (Beta) API need an API key?

Yes. The Recommendations AI (Beta) API uses OAuth authentication; the documentation explains how to get credentials.

Does the Recommendations AI (Beta) API support HTTPS?

Yes, the Recommendations AI (Beta) API is served over HTTPS.

How many endpoints does the Recommendations AI (Beta) API have?

Its OpenAPI description lists 17 endpoints in version v1beta1. All of them are shown on this page.

What are alternatives to the Recommendations AI (Beta) API?

Other Analytics APIs include Google Play Integrity API, versionhistory.googleapis.com API, Doc Converter, Perspective Comment Analyzer API, Safe Browsing API.

Compare alternatives →

Google Play Integrity API

Analytics

The Play Integrity API helps you check that you're interacting with your genuine app on a genuine Android device powered by Google Play services. The Play Integrity API has replaced SafetyNet Attestation and Android Device Verification.

OAuth1 endpoints

versionhistory.googleapis.com API

Analytics

Version History API - Prod

No auth4 endpoints

Doc Converter

Analytics

This api converts file formats of OpenXml and OpenOffice documents formats to vector files (e.g., svg)

No auth1 endpoints

Perspective Comment Analyzer API

Analytics

The Perspective Comment Analyzer API provides information about the potential impact of a comment on a conversation (e.g. it can provide a score for the "toxicity" of a comment). Users can leverage the "SuggestCommentScore" method to submit corrections to improve Perspective over time. Users can set the "doNotStore" flag to ensure that all submitted comments are automatically deleted after scores are returned.

OAuth2 endpoints

Safe Browsing API

Analytics

Enables client applications to check web resources (most commonly URLs) against Google-generated lists of unsafe web resources. The Safe Browsing APIs are for non-commercial use only. If you need to use APIs to detect malicious URLs for commercial purposes – meaning “for sale or revenue-generating purposes” – please refer to the Web Risk API.

No auth7 endpoints

Web Fonts Developer API

Analytics

The Google Web Fonts Developer API lets you retrieve information about web fonts served by Google.

No auth1 endpoints

Listed from APIs.guru (CC0).