# [Google Cloud Storage: Node.js Client](https://github.com/googleapis/nodejs-storage) [](https://cloud.google.com/terms/launch-stages) [](https://circleci.com/gh/googleapis/nodejs-storage) [](https://ci.appveyor.com/project/googleapis/nodejs-storage) [](https://codecov.io/gh/googleapis/nodejs-storage) > Node.js idiomatic client for [Cloud Storage][product-docs]. [Cloud Storage](https://cloud.google.com/storage/docs) allows world-wide storage and retrieval of any amount of data at any time. You can use Google Cloud Storage for a range of scenarios including serving website content, storing data for archival and disaster recovery, or distributing large data objects to users via direct download. * [Cloud Storage Node.js Client API Reference][client-docs] * [github.com/googleapis/nodejs-storage](https://github.com/googleapis/nodejs-storage) * [Cloud Storage Documentation][product-docs] Read more about the client libraries for Cloud APIs, including the older Google APIs Client Libraries, in [Client Libraries Explained][explained]. [explained]: https://cloud.google.com/apis/docs/client-libraries-explained **Table of contents:** * [Quickstart](#quickstart) * [Before you begin](#before-you-begin) * [Installing the client library](#installing-the-client-library) * [Using the client library](#using-the-client-library) * [Samples](#samples) * [Versioning](#versioning) * [Contributing](#contributing) * [License](#license) ## Quickstart ### Before you begin 1. Select or create a Cloud Platform project. [Go to the projects page][projects] 1. Enable billing for your project. [Enable billing][billing] 1. Enable the Google Cloud Storage API. [Enable the API][enable_api] 1. [Set up authentication with a service account][auth] so you can access the API from your local workstation. [projects]: https://console.cloud.google.com/project [billing]: https://support.google.com/cloud/answer/6293499#enable-billing [enable_api]: https://console.cloud.google.com/flows/enableapi?apiid=storage-api.googleapis.com [auth]: https://cloud.google.com/docs/authentication/getting-started ### Installing the client library npm install --save @google-cloud/storage ### Using the client library ```javascript // Imports the Google Cloud client library const Storage = require('@google-cloud/storage'); // Your Google Cloud Platform project ID const projectId = 'YOUR_PROJECT_ID'; // Creates a client const storage = new Storage({ projectId: projectId, }); // The name for the new bucket const bucketName = 'my-new-bucket'; // Creates the new bucket storage .createBucket(bucketName) .then(() => { console.log(`Bucket ${bucketName} created.`); }) .catch(err => { console.error('ERROR:', err); }); ``` ## Samples Samples are in the [`samples/`](https://github.com/googleapis/nodejs-storage/tree/master/samples) directory. The samples' `README.md` has instructions for running the samples. | Sample | Source Code | Try it | | --------------------------- | --------------------------------- | ------ | | ACL (Access Control Lists) | [source code](https://github.com/googleapis/nodejs-storage/blob/master/samples/acl.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-storage&page=editor&open_in_editor=samples/acl.js,samples/README.md) | | Buckets | [source code](https://github.com/googleapis/nodejs-storage/blob/master/samples/buckets.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-storage&page=editor&open_in_editor=samples/buckets.js,samples/README.md) | | Encryption | [source code](https://github.com/googleapis/nodejs-storage/blob/master/samples/encryption.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-storage&page=editor&open_in_editor=samples/encryption.js,samples/README.md) | | Files | [source code](https://github.com/googleapis/nodejs-storage/blob/master/samples/files.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-storage&page=editor&open_in_editor=samples/files.js,samples/README.md) | | Notifications | [source code](https://github.com/googleapis/nodejs-storage/blob/master/samples/notifications.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-storage&page=editor&open_in_editor=samples/notifications.js,samples/README.md) | | Requester Pays | [source code](https://github.com/googleapis/nodejs-storage/blob/master/samples/requesterPays.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-storage&page=editor&open_in_editor=samples/requesterPays.js,samples/README.md) | The [Cloud Storage Node.js Client API Reference][client-docs] documentation also contains samples. ## Versioning This library follows [Semantic Versioning](http://semver.org/). 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][launch_stages] [launch_stages]: https://cloud.google.com/terms/launch-stages ## Contributing Contributions welcome! See the [Contributing Guide](https://github.com/googleapis/nodejs-storage/blob/master/.github/CONTRIBUTING.md). ## License Apache Version 2.0 See [LICENSE](https://github.com/googleapis/nodejs-storage/blob/master/LICENSE) [client-docs]: https://cloud.google.com/nodejs/docs/reference/storage/latest/ [product-docs]: https://cloud.google.com/storage/docs [shell_img]: //gstatic.com/cloudssh/images/open-btn.png