googleapis
Google APIs Proto Files: Node.js Client
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:
Quickstart
Installing the client library
npm install google-proto-filesUsing 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');
console.log(files);
// node_modules/google-proto-files/google/logging/v2
// Get a path to the entry proto file for a specific API version
console.log(protos.pubsub.v1);
// 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');
console.log(service1);
// Load protos synchronously
const root2 = protos.loadSync('./cloudcats.proto');
const service2 = root2.lookup('example.MyService');
console.log(service2);
}
quickstart();
Samples
Samples are in the samples/ directory. Each sample's README.md has instructions for running its sample.
| Sample | Source Code | Try it |
|---|---|---|
| Quickstart | source code |  |
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. 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-proto-files@legacy-8 installs client libraries
for versions compatible with Node.js 8.
Versioning
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
Contributing
Contributions welcome! See the Contributing Guide.
Please note that this README.md, the samples/README.md,
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.
License
Apache Version 2.0
See LICENSE