Vertex AI Search for Retail API (retail:v2alpha)

Additions

Methods


• ▼ ▲ retail.projects.retailProject.acceptTerms

  Parameters:

  project

  Description: Required. Full resource name of the project. Format: `projects/{project_number_or_id}/retailProject`

  Required: Yes

  Location: path

  Type: string

  Pattern: ^projects/[^/]+/retailProject$

  Flat Path: v2alpha/projects/{projectsId}/retailProject:acceptTerms

  Description: Accepts service terms for this project. By making requests to this API, you agree to the terms of service linked below. https://cloud.google.com/retail/data-use-terms

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

  Path: v2alpha/{+project}:acceptTerms

  Parameter Order: project

  HTTP Method: POST

• ▼ ▲ retail.projects.getRetailProject

  Parameter Order: name

  Parameters:

  name

  Pattern: ^projects/[^/]+/retailProject$

  Location: path

  Description: Required. Full resource name of the project. Format: `projects/{project_number_or_id}/retailProject`

  Type: string

  Required: Yes

  HTTP Method: GET

  Flat Path: v2alpha/projects/{projectsId}/retailProject

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

  Path: v2alpha/{+name}

  Description: Gets the project. Throws NOT_FOUND if the project wasn't initialized for Retail API Service.

• ▼ ▲ retail.projects.listEnrolledSolutions

  Path: v2alpha/{+parent}:enrolledSolutions

  Description: Lists all the retail API solutions the project has enrolled.

  Flat Path: v2alpha/projects/{projectsId}:enrolledSolutions

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

  Parameters:

  parent

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

  Location: path

  Pattern: ^projects/[^/]+$

  Required: Yes

  Type: string

  Parameter Order: parent

  HTTP Method: GET

• ▼ ▲ retail.projects.enrollSolution

  HTTP Method: POST

  Parameter Order: project

  Parameters:

  project

  Type: string

  Required: Yes

  Pattern: ^projects/[^/]+$

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

  Location: path

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

  Description: Enrolls retail API solution for the project. Recommendation solution is enrolled by default when your project enables Retail API. You don't need to call this API for the recommendation solution.

  Flat Path: v2alpha/projects/{projectsId}:enrollSolution

  Path: v2alpha/{+project}:enrollSolution