{% if 'partials' in metadata and metadata['partials']['title'] -%} {{ metadata['partials']['title'] }} {% else -%}
[{{ metadata['repo']['name_pretty'] }}: {{ metadata['repo']['language']|language_pretty }} Client](https://github.com/{{ metadata['repo']['repo'] }})
{%- endif %}
{{ metadata['repo']['release_level']|release_quality_badge }} [](https://www.npmjs.org/package/{{ metadata['name'] }})
{% if metadata['deprecated'] %}
| This library is deprecated. {{ metadata['deprecated'] }} |
| {% endif %} |
{% if 'partials' in metadata and metadata['partials']['introduction'] %} {{ metadata['partials']['introduction'] }} {% else %} {{ metadata['description'] }} {% endif %}
A comprehensive list of changes in each version may be found in [the CHANGELOG]({{ metadata['homepage'] }}/CHANGELOG.md).
{% if metadata['repo']['client_documentation'] %}* [{{ metadata['repo']['name_pretty'] }} {{ metadata['repo']['language']|language_pretty }} Client API Reference][client-docs]{% endif %} {% if metadata['repo']['product_documentation'] %}* [{{ metadata['repo']['name_pretty'] }} Documentation][product-docs]{% endif %}
- [github.com/{{ metadata['full_directory_path'] }}]({{ metadata['homepage'] }})
Read more about the client libraries for Cloud APIs, including the older Google APIs Client Libraries, in Client Libraries Explained.
Table of contents:
- Quickstart
{% if metadata['repo']['api_id'] %} * Before you begin{% endif %}
- Installing the client library {% if metadata['quickstart'] %} * Using the client library{% endif %} {% if metadata['samples']|length %}* Samples{% endif %}
- Versioning
- Contributing
- License
{% if metadata['repo']['api_id'] %}
- [Select or create a Cloud Platform project][projects].{% if metadata['repo']['requires_billing'] %}
- [Enable billing for your project][billing].{% endif %}
- [Enable the {{ metadata['repo']['name_pretty'] }} API][enable_api].
- [Set up authentication with a service account][auth] so you can access the API from your local workstation. {% endif %}
{{ metadata['lib_install_cmd'] }}{% if metadata['quickstart'] %}
{{ metadata['quickstart'] }}
{% endif %}{% if 'partials' in metadata and metadata['partials']['body'] %}{{ metadata['partials']['body'] }}{% endif %}
{% if metadata['samples']|length %}
Samples are in the [samples/](https://github.com/{{ metadata['repo']['repo'] }}/tree/{{ metadata['repo']['default_branch'] }}/samples) directory. Each sample's README.md has instructions for running its sample.
| Sample | Source Code | Try it |
|---|---|---|
| {% for sample in metadata['samples'] %} | {{ sample.title }} | [source code](https://github.com/{{ metadata['repo']['repo'] }}/blob/{{ metadata['repo']['default_branch'] }}/{{ sample.file }}) |
| {% endfor %} | ||
| {% endif %} | ||
| {% if metadata['repo']['client_documentation'] %} | ||
| The [{{ metadata['repo']['name_pretty'] }} {{ metadata['repo']['language'] | language_pretty }} Client API Reference][client-docs] documentation | |
| also contains samples. | ||
| {% endif %} |
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, {{ metadata['lib_install_cmd'] }}@legacy-8 installs client libraries
for versions compatible with Node.js 8.
This library follows Semantic Versioning.
{% if metadata['repo']['release_level'] == 'ga' %} 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. {% endif %} {% if metadata['repo']['release_level'] == 'stable' %} 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. {% endif %} {% if metadata['repo']['release_level'] == 'beta' %} This library is considered to be in beta. This means it is expected to be mostly stable while we work toward a general availability release; however, complete stability is not guaranteed. We will address issues and requests against beta libraries with a high priority. {% endif %} {% if metadata['repo']['release_level'] == 'alpha' %} This library is considered to be in alpha. This means it is still a work-in-progress and under active development. Any release is subject to backwards-incompatible changes at any time. {% endif %} {% if metadata['release_level'] == 'deprecated' %} This library is deprecated. This means that it is no longer being actively maintained and the only updates the library will receive will be for critical security issues. {% if metadata['deprecated'] %}{{ metadata['deprecated'] }}{% endif %} {% endif %} {% if metadata['repo']['release_level'] == 'preview' %} This library is considered to be in preview. This means it is still a work-in-progress and under active development. Any release is subject to backwards-incompatible changes at any time. {% endif %}
More Information: Google Cloud Platform Launch Stages
Contributions welcome! See the [Contributing Guide](https://github.com/{{ metadata['repo']['repo'] }}/blob/{{ metadata['repo']['default_branch'] }}/CONTRIBUTING.md).
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.
Apache Version 2.0
See [LICENSE](https://github.com/{{ metadata['repo']['repo'] }}/blob/{{ metadata['repo']['default_branch'] }}/LICENSE)
{% if metadata['repo']['client_documentation'] %}[client-docs]: {{ metadata['repo']['client_documentation'] }}{% endif %} {% if metadata['repo']['product_documentation'] %}[product-docs]: {{ metadata['repo']['product_documentation'] }}{% endif %} [shell_img]: https://gstatic.com/cloudssh/images/open-btn.png [projects]: https://console.cloud.google.com/project [billing]: https://support.google.com/cloud/answer/6293499#enable-billing {% if metadata['repo']['api_id'] %}[enable_api]: https://console.cloud.google.com/flows/enableapi?apiid={{ metadata['repo']['api_id'] }}{% endif %} [auth]: https://cloud.google.com/docs/authentication/getting-started
