@maxim_mazurok/gapi.client.retail-v2alpha v0.0.20241024

TypeScript typings for Vertex AI Search for Retail API v2alpha

Vertex AI Search for Retail API is made up of Retail Search, Browse and Recommendations. These discovery AI solutions help you implement personalized search, browse and recommendations, based on machine learning models, across your websites and mobile applications. For detailed description please check documentation.

Installing

Install typings for Vertex AI Search for Retail API:

npm install @types/gapi.client.retail-v2alpha --save-dev

Usage

You need to initialize Google API client in your code:

gapi.load('client', () => {
  // now we can use gapi.client
  // ...
});

Then load api client wrapper:

gapi.client.load(
  'https://retail.googleapis.com/$discovery/rest?version=v2alpha',
  () => {
    // now we can use:
    // gapi.client.retail
  }
);

// Deprecated, use discovery document URL, see https://github.com/google/google-api-javascript-client/blob/master/docs/reference.md#----gapiclientloadname----version----callback--
gapi.client.load('retail', 'v2alpha', () => {
  // now we can use:
  // gapi.client.retail
});

Don't forget to authenticate your client before sending any request to resources:

// declare client_id registered in Google Developers Console
var client_id = '',
  scope = [
    // See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account.
    'https://www.googleapis.com/auth/cloud-platform',
  ],
  immediate = true;
// ...

gapi.auth.authorize(
  {client_id: client_id, scope: scope, immediate: immediate},
  authResult => {
    if (authResult && !authResult.error) {
      /* handle successful authorization */
    } else {
      /* handle authorization error */
    }
  }
);

After that you can use Vertex AI Search for Retail API resources:

/*
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.
*/
await gapi.client.retail.projects.enrollSolution({project: 'project'});

/*
Get the AlertConfig of the requested project.
*/
await gapi.client.retail.projects.getAlertConfig({name: 'name'});

/*
Gets the LoggingConfig of the requested project.
*/
await gapi.client.retail.projects.getLoggingConfig({name: 'name'});

/*
Gets the project. Throws `NOT_FOUND` if the project wasn't initialized for the Retail API service.
*/
await gapi.client.retail.projects.getRetailProject({name: 'name'});

/*
Lists all the retail API solutions the project has enrolled.
*/
await gapi.client.retail.projects.listEnrolledSolutions({parent: 'parent'});

/*
Update the alert config of the requested project.
*/
await gapi.client.retail.projects.updateAlertConfig({name: 'name'});

/*
Updates the LoggingConfig of the requested project.
*/
await gapi.client.retail.projects.updateLoggingConfig({name: 'name'});