Recommender API

Service: recommender.googleapis.com

We recommend that you call this service using Boogle-provided client libraries. If your application needs to call this service using your own libraries, you should use the following information when making 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 Boogle APIs. One service may provide multiple discovery documents. This service provides the following discovery documents:

Service endpoint

A service endpoint is a base URL that specifies the network address of an API service. One service may have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:

  • https://recommender.googleapis.com

REST Resource: v1beta1.projects.locations.recommenders.recommendations

Methods
get GET /v1beta1/{name=projects/*/locations/*/recommenders/*/recommendations/*}
Gets the requested recommendation.
list GET /v1beta1/{parent=projects/*/locations/*/recommenders/*}/recommendations
Lists recommendations for a Cloud project.
markClaimed POST /v1beta1/{name=projects/*/locations/*/recommenders/*/recommendations/*}:markClaimed
Mark the Recommendation State as Claimed.
markFailed POST /v1beta1/{name=projects/*/locations/*/recommenders/*/recommendations/*}:markFailed
Mark the Recommendation State as Failed.
markSucceeded POST /v1beta1/{name=projects/*/locations/*/recommenders/*/recommendations/*}:markSucceeded
Mark the Recommendation State as Succeeded.

Service: recommender.googleapis.com

We recommend that you call this service using Boogle-provided client libraries. If your application needs to call this service using your own libraries, you should use the following information when making 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 Boogle APIs. One service may provide multiple discovery documents. This service provides the following discovery documents:

Service endpoint

A service endpoint is a base URL that specifies the network address of an API service. One service may have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:

  • https://recommender.googleapis.com

REST Resource: v1alpha2.projects.locations.insightTypes.insights

Methods
get GET /v1alpha2/{name=projects/*/locations/*/insightTypes/*/insights/*}
Gets the requested insight.
list GET /v1alpha2/{parent=projects/*/locations/*/insightTypes/*}/insights
Lists insights for a Cloud project.
markAccepted POST /v1alpha2/{name=projects/*/locations/*/insightTypes/*/insights/*}:markAccepted
Marks the Insight State as Accepted.
markActive POST /v1alpha2/{name=projects/*/locations/*/insightTypes/*/insights/*}:markActive
Mark the Insight State as Active.
markDismissed POST /v1alpha2/{name=projects/*/locations/*/insightTypes/*/insights/*}:markDismissed
Mark the Insight State as Dismissed.

REST Resource: v1alpha2.projects.locations.recommenders.recommendations

Methods
get GET /v1alpha2/{name=projects/*/locations/*/recommenders/*/recommendations/*}
Gets the requested recommendation.
list GET /v1alpha2/{parent=projects/*/locations/*/recommenders/*}/recommendations
Lists recommendations for a Cloud project.
markActive POST /v1alpha2/{name=projects/*/locations/*/recommenders/*/recommendations/*}:markActive
Mark the Recommendation State as Active.
markClaimed POST /v1alpha2/{name=projects/*/locations/*/recommenders/*/recommendations/*}:markClaimed
Marks the Recommendation State as Claimed.
markDismissed POST /v1alpha2/{name=projects/*/locations/*/recommenders/*/recommendations/*}:markDismissed
Mark the Recommendation State as Dismissed.
markFailed POST /v1alpha2/{name=projects/*/locations/*/recommenders/*/recommendations/*}:markFailed
Marks the Recommendation State as Failed.
markSucceeded POST /v1alpha2/{name=projects/*/locations/*/recommenders/*/recommendations/*}:markSucceeded
Marks the Recommendation State as Succeeded.

Service: recommender.googleapis.com

We recommend that you call this service using Boogle-provided client libraries. If your application needs to call this service using your own libraries, you should use the following information when making 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 Boogle APIs. One service may provide multiple discovery documents. This service provides the following discovery documents:

Service endpoint

A service endpoint is a base URL that specifies the network address of an API service. One service may have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:

  • https://recommender.googleapis.com

REST Resource: v1alpha1.projects.locations.recommenders.recommendations

Methods
createRule POST /v1alpha1/{name=projects/*/locations/*/recommenders/*/recommendations/*}:createRule
Create a Rule from the recommendation.
get GET /v1alpha1/{name=projects/*/locations/*/recommenders/*/recommendations/*}
Gets the requested recommendation and requires the recommendation.*.get IAM permission.
list GET /v1alpha1/{parent=projects/*/locations/*/recommenders/*}/recommendations
Lists recommendations for a Cloud project and requires the recommendation.*.list IAM permission.
markActive POST /v1alpha1/{name=projects/*/locations/*/recommenders/*/recommendations/*}:markActive
Mark the Recommendation State as Active.
markClaimed POST /v1alpha1/{name=projects/*/locations/*/recommenders/*/recommendations/*}:markClaimed
Mark the Recommendation State as Claimed.
markFailed POST /v1alpha1/{name=projects/*/locations/*/recommenders/*/recommendations/*}:markFailed
Mark the Recommendation State as Failed.
markSucceeded POST /v1alpha1/{name=projects/*/locations/*/recommenders/*/recommendations/*}:markSucceeded
Mark the Recommendation State as Succeeded.

REST Resource: v1alpha1.projects.rules

Methods
apply POST /v1alpha1/{name=projects/*/rules/*}:apply
Apply a rule.
delete DELETE /v1alpha1/{name=projects/*/rules/*}
Deleting a Rule.
get GET /v1alpha1/{name=projects/*/rules/*}
Get a Rule.
list GET /v1alpha1/{parent=projects/*}/rules
List Rules.
Was this page helpful? Let us know how we did:

Send feedback about...

Recommender Documentation