Cloud Channel API: Node.js Client

release level npm version

Channel 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 Cloud Channel 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/channel

Using the client library

// Reads the secrets from a `oauth2.keys.json` file, which should be downloaded
// from the Google Developers Console and saved in the same directory with the
// sample app.

// This sample app only calls read-only methods from the Channel API. Include
// additional scopes if calling methods that modify the configuration.
const SCOPES = [''];

async function listCustomers(authClient, accountNumber) {
  // Imports the Google Cloud client library
  const {CloudChannelServiceClient} = require('@google-cloud/channel');

  // Instantiates a client using OAuth2 credentials.
  const sslCreds = grpc.credentials.createSsl();
  const credentials = grpc.credentials.combineChannelCredentials(

  // Instantiates a client
  const client = new CloudChannelServiceClient({
    sslCreds: credentials,

  // Calls listCustomers() method
  const customers = await client.listCustomers({
    parent: `accounts/${accountNumber}`,

 * Create a new OAuth2Client, and go through the OAuth2 content
 * workflow.  Return the full client to the callback.
function getAuthenticatedClient(keys) {
  return new Promise((resolve, reject) => {
    // Create an oAuth client to authorize the API call. Secrets are kept in a
    // `keys.json` file, which should be downloaded from the Google Developers
    // Console.
    const oAuth2Client = new OAuth2Client(
      // The first redirect URL from the `oauth2.keys.json` file will be used
      // to generate the OAuth2 callback URL. Update the line below or edit
      // the redirect URL in the Google Developers Console if needed.
      // This sample app expects the callback URL to be
      // 'http://localhost:3000/oauth2callback'

    // Generate the url that will be used for the consent dialog.
    const authorizeUrl = oAuth2Client.generateAuthUrl({
      access_type: 'offline',
      scope: SCOPES.join(' '),

    // Open an http server to accept the oauth callback. In this example, the
    // only request to our webserver is to /oauth2callback?code=<code>
    const server = http
      .createServer(async (req, res) => {
        try {
          if (req.url.indexOf('/oauth2callback') > -1) {
            // Acquire the code from the querystring, and close the web
            // server.
            const qs = new url.URL(req.url, 'http://localhost:3000')
            const code = qs.get('code');
            console.log(`Code is ${code}`);
            res.end('Authentication successful! Please return to the console.');

            // Now that we have the code, use that to acquire tokens.
            const r = await oAuth2Client.getToken(code);
            // Make sure to set the credentials on the OAuth2 client.
  'Tokens acquired.');
        } catch (e) {
      .listen(3000, () => {
        // Open the browser to the authorize url to start the workflow.
        // This line will not work if you are running the code in the
        // environment where a browser is not available. In this case,
        // copy the URL and open it manually in a browser.`Opening the browser with URL: ${authorizeUrl}`);
        open(authorizeUrl, {wait: false}).then(cp => cp.unref());

async function main(accountNumber, keys) {
  // TODO: uncomment with your account number
  // const accountNumber = '1234'

  // TODO: uncomment this line with your oAuth2 file
  //const keys = require('./oauth2.keys.json');

  getAuthenticatedClient(keys).then(authClient =>
    listCustomers(authClient, accountNumber)


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

SampleSource CodeTry it
Cloud_channel_reports_service.fetch_report_resultssource codeOpen in Cloud Shell
Cloud_channel_reports_service.list_reportssource codeOpen in Cloud Shell
Cloud_channel_reports_service.run_report_jobsource codeOpen in Cloud Shell
Cloud_channel_service.activate_entitlementsource codeOpen in Cloud Shell
Cloud_channel_service.cancel_entitlementsource codeOpen in Cloud Shell
Cloud_channel_service.change_offersource codeOpen in Cloud Shell
Cloud_channel_service.change_parameterssource codeOpen in Cloud Shell
Cloud_channel_service.change_renewal_settingssource codeOpen in Cloud Shell
Cloud_channel_service.check_cloud_identity_accounts_existsource codeOpen in Cloud Shell
Cloud_channel_service.create_channel_partner_linksource codeOpen in Cloud Shell
Cloud_channel_service.create_channel_partner_repricing_configsource codeOpen in Cloud Shell
Cloud_channel_service.create_customersource codeOpen in Cloud Shell
Cloud_channel_service.create_customer_repricing_configsource codeOpen in Cloud Shell
Cloud_channel_service.create_entitlementsource codeOpen in Cloud Shell
Cloud_channel_service.delete_channel_partner_repricing_configsource codeOpen in Cloud Shell
Cloud_channel_service.delete_customersource codeOpen in Cloud Shell
Cloud_channel_service.delete_customer_repricing_configsource codeOpen in Cloud Shell
Cloud_channel_service.get_channel_partner_linksource codeOpen in Cloud Shell
Cloud_channel_service.get_channel_partner_repricing_configsource codeOpen in Cloud Shell
Cloud_channel_service.get_customersource codeOpen in Cloud Shell
Cloud_channel_service.get_customer_repricing_configsource codeOpen in Cloud Shell
Cloud_channel_service.get_entitlementsource codeOpen in Cloud Shell
Cloud_channel_service.import_customersource codeOpen in Cloud Shell
Cloud_channel_service.list_channel_partner_linkssource codeOpen in Cloud Shell
Cloud_channel_service.list_channel_partner_repricing_configssource codeOpen in Cloud Shell
Cloud_channel_service.list_customer_repricing_configssource codeOpen in Cloud Shell
Cloud_channel_service.list_customerssource codeOpen in Cloud Shell
Cloud_channel_service.list_entitlement_changessource codeOpen in Cloud Shell
Cloud_channel_service.list_entitlementssource codeOpen in Cloud Shell
Cloud_channel_service.list_offerssource codeOpen in Cloud Shell
Cloud_channel_service.list_productssource codeOpen in Cloud Shell
Cloud_channel_service.list_purchasable_offerssource codeOpen in Cloud Shell
Cloud_channel_service.list_purchasable_skussource codeOpen in Cloud Shell
Cloud_channel_service.list_sku_group_billable_skussource codeOpen in Cloud Shell
Cloud_channel_service.list_sku_groupssource codeOpen in Cloud Shell
Cloud_channel_service.list_skussource codeOpen in Cloud Shell
Cloud_channel_service.list_subscriberssource codeOpen in Cloud Shell
Cloud_channel_service.list_transferable_offerssource codeOpen in Cloud Shell
Cloud_channel_service.list_transferable_skussource codeOpen in Cloud Shell
Cloud_channel_service.lookup_offersource codeOpen in Cloud Shell
Cloud_channel_service.provision_cloud_identitysource codeOpen in Cloud Shell
Cloud_channel_service.query_eligible_billing_accountssource codeOpen in Cloud Shell
Cloud_channel_service.register_subscribersource codeOpen in Cloud Shell
Cloud_channel_service.start_paid_servicesource codeOpen in Cloud Shell
Cloud_channel_service.suspend_entitlementsource codeOpen in Cloud Shell
Cloud_channel_service.transfer_entitlementssource codeOpen in Cloud Shell
Cloud_channel_service.transfer_entitlements_to_googlesource codeOpen in Cloud Shell
Cloud_channel_service.unregister_subscribersource codeOpen in Cloud Shell
Cloud_channel_service.update_channel_partner_linksource codeOpen in Cloud Shell
Cloud_channel_service.update_channel_partner_repricing_configsource codeOpen in Cloud Shell
Cloud_channel_service.update_customersource codeOpen in Cloud Shell
Cloud_channel_service.update_customer_repricing_configsource codeOpen in Cloud Shell
Quickstartsource codeOpen in Cloud Shell

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


This library follows Semantic Versioning.

This library is considered to be stable. The code surface will not change in backwards-incompatible ways unless absolutely necessary (e.g. because of critical security issues) or with an extensive deprecation period. Issues and requests against stable libraries are addressed with the highest priority.

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