TypeScript icon, indicating that this package has built-in type declarations

    2.4.0 • Public • Published

    Google Cloud Platform logo

    Google APIs Proto Files: Node.js Client

    release level npm version codecov

    All of the Google API's protocol buffer files

    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:


    Installing the client library

    npm install google-proto-files

    Using the client library

    const protos = require('google-proto-files');
    async function quickstart() {
      // Get a directory path by executing as a function
      const files = protos.getProtoPath('logging', 'v2');
      // node_modules/google-proto-files/google/logging/v2
      // Get a path to the entry proto file for a specific API version
      // node_modules/google-proto-files/google/pubsub/v1/pubsub.proto
      // Load a proto which depends on google common protos.
      const root1 = await protos.load('./cloudcats.proto');
      const service1 = root1.lookup('example.MyService');
      // Load protos synchronously
      const root2 = protos.loadSync('./cloudcats.proto');
      const service2 = root2.lookup('example.MyService');


    Samples are in the samples/ directory. The samples' has instructions for running the samples.

    Sample Source Code Try it
    Quickstart source code Open in Cloud Shell

    The Google APIs Proto Files 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 targetting 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 template in this directory.


    Apache Version 2.0



    npm i google-proto-files

    DownloadsWeekly Downloads






    Unpacked Size

    18.4 MB

    Total Files


    Last publish


    • avatar