Google Cloud Support API: Node.js Client

release levelnpm version

Google Cloud Support API client for Node.js

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

Read more about the client libraries for Cloud APIs, including the olderGoogle APIs Client Libraries, inClient Libraries Explained.

Table of contents:

Quickstart

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 theAPI 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`. *  - `creator.email`: The email address of the case creator. *  Examples: *  - `state=CLOSED` *  - `state=OPEN AND creator.email="tester@example.com"` *  - `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 libraryconst {CaseServiceClient} = require('@google-cloud/support').v2;// Instantiates a clientconst supportClient = newCaseServiceClient();async function callListCases() {  // Construct request  const request = {    parent,  };  // Run request  const iterable = await supportClient.listCasesAsync(request);  for await (const response of iterable) {    console.log(response);  }}callListCases();

Samples

Samples are in thesamples/ directory. Each sample'sREADME.md 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

TheGoogle Cloud Support API Node.js Client API Reference documentationalso contains samples.

Supported Node.js Versions

Our client libraries follow theNode.js release schedule.Libraries are compatible with all currentactive andmaintenance versions ofNode.js.If you are using an end-of-life version of Node.js, we recommend that you updateas soon as possible to an actively supported LTS version.

Google's client libraries support legacy versions of Node.js runtimes on abest-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, andcan be installed through npmdist-tags.The dist-tags follow the naming conventionlegacy-(version).For example,npm install @google-cloud/support@legacy-8 installs client librariesfor versions compatible with Node.js 8.

Versioning

This library followsSemantic Versioning.

This library is considered to be inpreview. This means it is still awork-in-progress and under active development. Any release is subject tobackwards-incompatible changes at any time.

More Information:Google Cloud Platform Launch Stages

Contributing

Contributions welcome! See theContributing Guide.

Please note that thisREADME.md, thesamples/README.md,and a variety of configuration files in this repository (including.nycrc andtsconfig.json)are generated from a central template. To edit one of these files, make an editto its templates indirectory.

License

Apache Version 2.0

SeeLICENSE

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-10-30 UTC.