TypeScript typings for AI Commerce Search API v2

The AI Commerce Search 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 AI Commerce Search API:

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

TypeScript 6.0+

TypeScript 6.0 changed types to default to []. You must now explicitly list type packages in tsconfig.json:

{
  "compilerOptions": {
    "types": ["gapi", "gapi.auth2", "gapi.client", "gapi.client.retail-v2"]
  }
}

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=v2',
  () => {
    // 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', 'v2', () => {
  // 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 AI Commerce Search API resources:

For provenance information see Provenance section on NPM