Google Workspace Add-ons API: Node.js Client

Google Workspace Add-ons API client for Node.js

A comprehensive list of changes in each version may be found in the CHANGELOG .

Read more about the client libraries for Cloud APIs, including the older Google APIs Client Libraries, in Client Libraries Explained .

Table of contents:

Quickstart
Samples
Versioning
Contributing
License

Quickstart

Before you begin

Select or create a Cloud Platform project .
Enable billing for your project .
Enable the Google Workspace Add-ons API API .
Set up authentication with a service account so you can access the API from your local workstation.

Installing the client library

 npm install @google-cloud/gsuiteaddons

Using the client library

 /**
 * This snippet has been automatically generated and should be regarded as a code template only.
 * It will require modifications to work.
 * It may require correct/in-range values for request initialization.
 * TODO(developer): Uncomment these variables before running the sample.
 */
/**
 *  Required. Name of the project in which to create the deployment.
 *  Example: `projects/my_project`.
 */
// const parent = 'abc123'
/**
 *  The maximum number of deployments to return. The service may return fewer
 *  than this value.
 *  If unspecified, at most 1000 deployments will be returned.
 *  The maximum value is 1000; values above 1000 will be coerced to 1000.
 */
// const pageSize = 1234
/**
 *  A page token, received from a previous `ListDeployments` call.
 *  Provide this to retrieve the subsequent page.
 *  When paginating, all other parameters provided to `ListDeployments` must
 *  match the call that provided the page token.
 */
// const pageToken = 'abc123'

// Imports the Gsuiteaddons library
const {GSuiteAddOnsClient} = require(' @google-cloud/gsuiteaddons 
').v1;

// Instantiates a client
const gsuiteaddonsClient = new GSuiteAddOnsClient 
();

async function callListDeployments() {
  // Construct request
  const request = {
    parent,
  };

  // Run request
  const iterable = await gsuiteaddonsClient. listDeploymentsAsync 
(request);
  for await (const response of iterable) {
    console.log(response);
  }
}

callListDeployments();

Samples

Samples are in the samples/ directory. Each sample's README.md has instructions for running its sample.

Sample	Source Code	Try it
G_suite_add_ons.create_deployment	source code
G_suite_add_ons.delete_deployment	source code
G_suite_add_ons.get_authorization	source code
G_suite_add_ons.get_deployment	source code
G_suite_add_ons.get_install_status	source code
G_suite_add_ons.install_deployment	source code
G_suite_add_ons.list_deployments	source code
G_suite_add_ons.replace_deployment	source code
G_suite_add_ons.uninstall_deployment	source code
Quickstart	source code
Quickstart	source code

The Google Workspace Add-ons API Node.js Client API Reference documentation also contains samples.

Supported Node.js Versions

Our client libraries follow the Node.js release schedule . Libraries are compatible with all current active and maintenance versions of Node.js. If you are using an end-of-life version of Node.js, we recommend that you update as soon as possible to an actively supported LTS version.

Google's client libraries support legacy versions of Node.js runtimes on a best-efforts basis with the following warnings:

Legacy versions are not tested in continuous integration.
Some security patches and features cannot be backported.
Dependencies cannot be kept up-to-date.

Client libraries targeting some end-of-life versions of Node.js are available, and can be installed through npm dist-tags . The dist-tags follow the naming convention legacy-(version) . For example, npm install @google-cloud/gsuiteaddons@legacy-8 installs client libraries for versions compatible with Node.js 8.

Versioning

This library follows Semantic Versioning .

This library is considered to be in preview. This means it is still a work-in-progress and under active development. Any release is subject to backwards-incompatible changes at any time.

More Information: Google Cloud Platform Launch Stages

Contributing

Contributions welcome! See the Contributing Guide .

Please note that this README.md , the samples/README.md , and a variety of configuration files in this repository (including .nycrc and tsconfig.json ) are generated from a central template. To edit one of these files, make an edit to its templates in directory .

License

Apache Version 2.0

See LICENSE