Important: Recommendations AI has migrated to the Retail API, which is now generally available.

The Recommendations AI API (service endpoint https://recommendationengine.googleapis.com) and this documentation set remain available, but they will no longer be updated. We recommend migrating your recommendations to the Retail API (service endpoint https://retail.googleapis.com). See the new documentation:

Method: projects.locations.catalogs.eventStores.predictionApiKeyRegistrations.list

List the registered apiKeys for use with predict method.

HTTP request

GET https://recommendationengine.googleapis.com/v1beta1/{parent=projects/*/locations/*/catalogs/*/eventStores/*}/predictionApiKeyRegistrations

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The parent placement resource name such as "projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store"

Authorization requires the following IAM permission on the specified resource parent:

  • automlrecommendations.apiKeys.list

Query parameters

Parameters
pageSize

integer

Optional. Maximum number of results to return per page. If unset, the service will choose a reasonable default.

pageToken

string

Optional. The previous ListPredictionApiKeyRegistration.nextPageToken.

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

Response message for the predictionApiKeyRegistrations.list.

JSON representation
{
  "predictionApiKeyRegistrations": [
    {
      object (PredictionApiKeyRegistration)
    }
  ],
  "nextPageToken": string
}
Fields
predictionApiKeyRegistrations[]

object (PredictionApiKeyRegistration)

The list of registered API keys.

nextPageToken

string

If empty, the list is complete. If nonempty, pass the token to the next request's ListPredictionApiKeysRegistrationsRequest.pageToken.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.