@maxim_mazurok/gapi.client.discoveryengine-v1
v0.0.20241119
Published
TypeScript typings for Discovery Engine API v1
Downloads
4,925
Readme
TypeScript typings for Discovery Engine API v1
Discovery Engine API. For detailed description please check documentation.
Installing
Install typings for Discovery Engine API:
npm install @types/gapi.client.discoveryengine-v1 --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://discoveryengine.googleapis.com/$discovery/rest?version=v1',
() => {
// now we can use:
// gapi.client.discoveryengine
}
);
// 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('discoveryengine', 'v1', () => {
// now we can use:
// gapi.client.discoveryengine
});
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 Discovery Engine API resources:
/*
Provisions the project resource. During the process, related systems will get prepared and initialized. Caller must read the [Terms for data use](https://cloud.google.com/retail/data-use-terms), and optionally specify in request to provide consent to that service terms.
*/
await gapi.client.discoveryengine.projects.provision({name: 'name'});