Repository files navigation

Go packages forGoogle Cloud Platform services.

go get cloud.google.com/go/firestore@latest# Replace firestore with the package you want to use.

NOTE: Some of these packages are under development, and may occasionallymake backwards-incompatible changes.

For an updated list of all of our released APIs please see ourreference docs.

Our libraries are compatible with the two most recent major Goreleases, the samepolicy the Goprogramming language follows. This means the currently supported versions are:

• Go 1.24
• Go 1.25

By default, each client library will useApplication Default Credentials(ADC) to automatically configure the credentials used in calling the API endpoint.When using the libraries in a Google Cloud Platform environment such as ComputeEngine, Kubernetes Engine, or App Engine, no additional authentication steps arenecessary. SeeAuthentication methods at GoogleandAuthenticate for using client librariesfor more information.

client,err:=storage.NewClient(ctx)

For applications running elsewhere, such as your local development environment,you can use thegcloud auth application-default login command from theGoogle Cloud CLI to set user credentials inyour local filesystem. Application Default Credentials will automatically detectthese credentials. SeeSet up ADC for a local developmentenvironmentfor more information.

Alternately, you may need to provide an explicit path to your credentials. To authenticateusing aservice accountkey file, either set theGOOGLE_APPLICATION_CREDENTIALS environment variable to the pathto your key file, or programmatically passoption.WithCredentialsFileto theNewClient function of the desired package. For example:

client,err:=storage.NewClient(ctx,option.WithCredentialsFile("path/to/keyfile.json"))

You can exert even more control over authentication by using thecredentials package tocreate anauth.Credentials.Then passoption.WithAuthCredentialsto theNewClient function:

creds,err:=credentials.DetectDefault(&credentials.DetectOptions{...})...client,err:=storage.NewClient(ctx,option.WithAuthCredentials(creds))

Contributions are welcome. Please, see theCONTRIBUTINGdocument for details.

Please note that this project is released with a Contributor Code of Conduct.By participating in this project you agree to abide by its terms.SeeContributor Code of Conductfor more information.

• Go on Google Cloud
• Getting started with Go on Google Cloud
• App Engine Quickstart
• Cloud Functions Quickstart
• Cloud Run Quickstart