Cloud Storage client libraries (original) (raw)
This page shows how to get started with the Cloud Client Libraries for the Google Cloud Storage API. Client libraries make it easier to access Google Cloud APIs from a supported language. Although you can use Google Cloud APIs directly by making raw requests to the server, client libraries provide simplifications that significantly reduce the amount of code you need to write.
Read more about the Cloud Client Libraries and the older Google API Client Libraries inClient libraries explained.
Install the client library
C++
For more information about installing the C++ library, see Setting up a C++ development environment.
C#
If you are using Visual Studio 2017 or higher, open nuget package manager window and type the following:
Install-Package Google.Cloud.Storage.V1
If you are using .NET Core command-line interface tools to install your dependencies, run the following command:
dotnet add package Google.Cloud.Storage.V1
For more information, see Setting Up a C# Development Environment.
Go
go get cloud.google.com/go/storage
For more information, see Setting Up a Go Development Environment.
Java
If you are using Maven, add the following to your pom.xml file. For more information about BOMs, see The Google Cloud Platform Libraries BOM.
If you are using Gradle, add the following to your dependencies:
If you are using sbt, add the following to your dependencies:
If you're using Visual Studio Code, IntelliJ, or Eclipse, you can add client libraries to your project using the following IDE plugins:
The plugins provide additional functionality, such as key management for service accounts. Refer to each plugin's documentation for details.
For more information, see Setting Up a Java Development Environment.
Node.js
npm install @google-cloud/storage
For more information, see Setting Up a Node.js Development Environment.
PHP
composer require google/cloud-storage
For more information, see Using PHP on Google Cloud.
Python
pip install --upgrade google-cloud-storage
For more information, see Setting Up a Python Development Environment.
Ruby
gem install google-cloud-storage
For more information, see Setting Up a Ruby Development Environment.
Set up authentication
To authenticate calls to Google Cloud APIs, client libraries supportApplication Default Credentials (ADC); the libraries look for credentials in a set of defined locations and use those credentials to authenticate requests to the API. With ADC, you can make credentials available to your application in a variety of environments, such as local development or production, without needing to modify your application code.
For production environments, the way you set up ADC depends on the service and context. For more information, see Set up Application Default Credentials.
For a local development environment, you can set up ADC with the credentials that are associated with your Google Account:
- After installing the Google Cloud CLI,initialize it by running the following command:
gcloud init
If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity. - If you're using a local shell, then create local authentication credentials for your user account:
gcloud auth application-default login
You don't need to do this if you're using Cloud Shell.
If an authentication error is returned, and you are using an external identity provider (IdP), confirm that you have signed in to the gcloud CLI with your federated identity.
A sign-in screen appears. After you sign in, your credentials are stored in the local credential file used by ADC.
Use the client library
The following example shows how to use the client library.
C++
C#
Go
Java
Node.js
PHP
Python
Ruby
Using the client library with Cloud Shell Editor
Go
For step-by-step guidance on running a client library in Cloud Shell Editor:
- Click Guide me.
- You see a panel Learn. Click Start to follow the tutorial.
Java
For step-by-step guidance on running a client library in Cloud Shell Editor:
- Click Guide me.
- You see a panel Learn. Click Start to follow the tutorial.
Node.js
For step-by-step guidance on running a client library in Cloud Shell Editor:
- Click Guide me.
- You see a panel Learn. Click Start to follow the tutorial.
Python
For step-by-step guidance on running a client library in Cloud Shell Editor:
- Click Guide me.
- You see a panel Learn. Click Start to follow the tutorial.
More Examples
For more examples of using client libraries with Cloud Storage, see the following guides:
Additional resources
Try it for yourself
If you're new to Google Cloud, create an account to evaluate how Cloud Storage performs in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.