Method: projects.enrollSolution

The method enrolls a solution of type Retail Search into a project.

The Recommendations AI solution type is enrolled by default when your project enables Retail API, so you don't need to call the enrollSolution method for recommendations.

HTTP request

POST https://retail.googleapis.com/v2alpha/{project=projects/*}:enrollSolution

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
project

string

Required. Full resource name of parent. Format: projects/{project_number_or_id}

Request body

The request body contains data with the following structure:

JSON representation
{
  "solution": enum (SolutionType)
}
Fields
solution

enum (SolutionType)

Required. Solution to enroll.

Response body

If successful, the response body contains an instance of Operation.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.