Google Cloud Game Servers: Node.js Client

release level npm version codecov

Game service 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 Game Servers 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/game-servers

Using the client library

const {RealmsServiceClient} = require('@google-cloud/game-servers');

async function quickstart() {
  const client = new RealmsServiceClient();

  // TODO(developer): uncomment the following section, and add values
  // const projectId = 'YOUR_PROJECT_ID';
  // const location = 'us-central1;
  // const realmId = 'DESIRED_REALM_ID';

  const request = {
    parent: `projects/${projectId}/locations/${location}`,
    realm: {
      // Must use a valid support time zone.
      // See
      timeZone: 'US/Pacific',
      description: 'My Game Server realm',

  const [operation] = await client.createRealm(request);
  const results = await operation.promise();
  const [realm] = results;

  console.log('Realm created:');

  console.log(`\tRealm name: ${}`);
  console.log(`\tRealm description: ${realm.description}`);
  console.log(`\tRealm time zone: ${realm.timeZone}`);


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

SampleSource CodeTry it
Create_clustersource codeOpen in Cloud Shell
Create_configsource codeOpen in Cloud Shell
Create_deploymentsource codeOpen in Cloud Shell
Create_realmsource codeOpen in Cloud Shell
Delete_clustersource codeOpen in Cloud Shell
Delete_configsource codeOpen in Cloud Shell
Delete_deploymentsource codeOpen in Cloud Shell
Delete_realmsource codeOpen in Cloud Shell
Get_clustersource codeOpen in Cloud Shell
Get_configsource codeOpen in Cloud Shell
Get_deploymentsource codeOpen in Cloud Shell
Get_realmsource codeOpen in Cloud Shell
Get_rolloutsource codeOpen in Cloud Shell
List_clusterssource codeOpen in Cloud Shell
List_configssource codeOpen in Cloud Shell
List_deploymentssource codeOpen in Cloud Shell
List_realmssource codeOpen in Cloud Shell
Create Game Server Realmsource codeOpen in Cloud Shell
Update_clustersource codeOpen in Cloud Shell
Update_deploymentsource codeOpen in Cloud Shell
Update_realmsource codeOpen in Cloud Shell
Update_rollout_defaultsource codeOpen in Cloud Shell
Update_rollout_overridesource codeOpen in Cloud Shell
Update_rollout_remove_defaultsource codeOpen in Cloud Shell
Update_rollout_remove_overridesource codeOpen in Cloud Shell

The Google Cloud Game Servers 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.

Client libraries targeting some end-of-life versions of Node.js are available, and can be installed via npm dist-tags. The dist-tags follow the naming convention legacy-(version).

Legacy Node.js versions are supported as a best effort:

  • Legacy versions will not be tested in continuous integration.
  • Some security patches may not be able to be backported.
  • Dependencies will not be kept up-to-date, and features will not be backported.

Legacy tags available

  • legacy-8: install client libraries from this dist-tag for versions compatible with Node.js 8.


This library follows Semantic Versioning.

This library is considered to be General Availability (GA). This means it is 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 GA 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