Google Cloud Client Libraries for Go

Go packages for Google Cloud Platform services.

import "cloud.google.com/go"

To install the packages on your system, do not clone the repo. Instead:

1. Change to your project directory:

   cd /my/cloud/project
   

2. Get the package you want to use. Some products have their own module, so it's
   best to go get the package(s) you want to use:

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

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

NOTE: Github repo is a mirror of https://code.googlesource.com/gocloud.

Supported APIs

Google API, Status, Package
------------------------------------------------, --------------, -----------------------------------------------------------
Asset, alpha, cloud.google.com/go/asset/v1beta
Automl, stable, cloud.google.com/go/automl/apiv1
BigQuery, stable, cloud.google.com/go/bigquery
Bigtable, stable, cloud.google.com/go/bigtable
Cloudbuild, stable, cloud.google.com/go/cloudbuild/apiv1
Cloudtasks, stable, cloud.google.com/go/cloudtasks/apiv2
Container, stable, cloud.google.com/go/container/apiv1
ContainerAnalysis, beta, cloud.google.com/go/containeranalysis/apiv1
Dataproc, stable, cloud.google.com/go/dataproc/apiv1
Datastore, stable, cloud.google.com/go/datastore
Debugger, stable, cloud.google.com/go/debugger/apiv2
Dialogflow, stable, cloud.google.com/go/dialogflow/apiv2
Data Loss Prevention, stable, cloud.google.com/go/dlp/apiv2
ErrorReporting, alpha, cloud.google.com/go/errorreporting
Firestore, stable, cloud.google.com/go/firestore
IAM, stable, cloud.google.com/go/iam
IoT, stable, cloud.google.com/go/iot/apiv1
IRM, alpha, cloud.google.com/go/irm/apiv1alpha2
KMS, stable, cloud.google.com/go/kms/apiv1
Natural Language, stable, cloud.google.com/go/language/apiv1
Logging, stable, cloud.google.com/go/logging
Memorystore, alpha, cloud.google.com/go/redis/apiv1
Monitoring, alpha, cloud.google.com/go/monitoring/apiv3
OS Login, alpha, cloud.google.com/go/oslogin/apiv1
Pub/Sub, stable, cloud.google.com/go/pubsub
Phishing Protection, alpha, cloud.google.com/go/phishingprotection/apiv1beta1
reCAPTCHA Enterprise, alpha, cloud.google.com/go/recaptchaenterprise/apiv1beta1
Recommender, beta, cloud.google.com/go/recommender/apiv1beta1
Scheduler, stable, cloud.google.com/go/scheduler/apiv1
Securitycenter, alpha, cloud.google.com/go/securitycenter/apiv1
Spanner, stable, cloud.google.com/go/spanner
Speech, stable, cloud.google.com/go/speech/apiv1
Storage, stable, cloud.google.com/go/storage
Talent, alpha, cloud.google.com/go/talent/apiv4beta1
Text To Speech, alpha, cloud.google.com/go/texttospeech/apiv1
Trace, alpha, cloud.google.com/go/trace/apiv2
Translate, stable, cloud.google.com/go/translate
Video Intelligence, alpha, cloud.google.com/go/videointelligence/apiv1beta1
Vision, stable, cloud.google.com/go/vision/apiv1
Webrisk, alpha, cloud.google.com/go/webrisk/apiv1beta1

Alpha status: the API is still being actively developed. As a
result, it might change in backward-incompatible ways and is not recommended
for production use.

Beta status: the API is largely complete, but still has outstanding
features and bugs to be addressed. There may be minor backwards-incompatible
changes where necessary.

Stable status: the API is mature and ready for production use. We will
continue addressing bugs and feature requests.

Documentation and examples are available at godoc.org/cloud.google.com/go

Go Versions Supported

We support the two most recent major versions of Go. If Google App Engine uses
an older version, we support that as well.

Authorization

By default, each API will use Google Application Default Credentials
for authorization credentials used in calling the API endpoints. This will allow your
application to run in many environments without requiring explicit configuration.

client, err := storage.NewClient(ctx)

To authorize using a
JSON key file,
pass
option.WithCredentialsFile
to the NewClient function of the desired package. For example:

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

You can exert more control over authorization by using the
golang.org/x/oauth2 package to
create an oauth2.TokenSource. Then pass
option.WithTokenSource
to the NewClient function:
snip:# (auth-ts)

tokenSource := ...
client, err := storage.NewClient(ctx, option.WithTokenSource(tokenSource))

Contributing

Contributions are welcome. Please, see the
CONTRIBUTING
document for details. We're using Gerrit for our code reviews. Please don't open pull
requests against this repo, new pull requests will be automatically closed.

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.
See Contributor Code of Conduct
for more information.