Google Cloud Support API: Node.js Client

release level npm version

Google Cloud Support 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:


Before you begin

  1. Select or create a Cloud Platform project.
  2. Enable billing for your project.
  3. Enable the Google Cloud Support API API.
  4. 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/support

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. The fully qualified name of parent resource to list cases under.
// const parent = 'abc123'
 *  An expression written in filter language. If non-empty, the query returns
 *  the cases that match the filter. Else, the query doesn't filter the cases.
 *  Filter expressions use the following fields with the operators equals (`=`)
 *  and `AND`:
 *  - `state`: The accepted values are `OPEN` or `CLOSED`.
 *  - `priority`: The accepted values are `P0`, `P1`, `P2`, `P3`, or `P4`. You
 *  can specify multiple values for priority using the `OR` operator. For
 *  example, `priority=P1 OR priority=P2`.
 *  - ``: The email address of the case creator.
 *  Examples:
 *  - `state=CLOSED`
 *  - `state=OPEN AND""`
 *  - `state=OPEN AND (priority=P0 OR priority=P1)`
// const filter = 'abc123'
 *  The maximum number of cases fetched with each request. Defaults to 10.
// const pageSize = 1234
 *  A token identifying the page of results to return. If unspecified, the
 *  first page is retrieved.
// const pageToken = 'abc123'

// Imports the Support library
const {CaseServiceClient} = require('@google-cloud/support').v2;

// Instantiates a client
const supportClient = new CaseServiceClient();

async function callListCases() {
  // Construct request
  const request = {

  // Run request
  const iterable = await supportClient.listCasesAsync(request);
  for await (const response of iterable) {



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

SampleSource CodeTry it
Case_attachment_service.list_attachmentssource codeOpen in Cloud Shell
Case_service.close_casesource codeOpen in Cloud Shell
Case_service.create_casesource codeOpen in Cloud Shell
Case_service.escalate_casesource codeOpen in Cloud Shell
Case_service.get_casesource codeOpen in Cloud Shell
Case_service.list_casessource codeOpen in Cloud Shell
Case_service.search_case_classificationssource codeOpen in Cloud Shell
Case_service.search_casessource codeOpen in Cloud Shell
Case_service.update_casesource codeOpen in Cloud Shell
Comment_service.create_commentsource codeOpen in Cloud Shell
Comment_service.list_commentssource codeOpen in Cloud Shell
Quickstartsource codeOpen in Cloud Shell

The Google Cloud Support 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/support@legacy-8 installs client libraries for versions compatible with Node.js 8.


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


Contributions welcome! See the Contributing Guide.

Please note that this, the samples/, 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.


Apache Version 2.0