tree: 195e366c720599cdc8ddd21e9b0cc7a70a2c3ad6 [path history] [tgz]
  1. .github/
  2. analytics/
  3. asset/
  4. automl/
  5. bigquery/
  6. bigtable/
  7. billing/
  8. civil/
  9. cloudbuild/
  10. cloudtasks/
  11. cmd/
  12. compute/
  13. container/
  14. containeranalysis/
  15. datacatalog/
  16. dataproc/
  17. datastore/
  18. debugger/
  19. dialogflow/
  20. dlp/
  21. errorreporting/
  22. expr/
  23. firestore/
  24. functions/
  25. gaming/
  26. grafeas/
  27. httpreplay/
  28. iam/
  29. internal/
  30. iot/
  31. kms/
  32. language/
  33. logging/
  34. longrunning/
  35. memcache/
  36. monitoring/
  37. notebooks/
  38. osconfig/
  39. oslogin/
  40. phishingprotection/
  41. policytroubleshooter/
  42. profiler/
  43. pubsub/
  44. pubsublite/
  45. recaptchaenterprise/
  46. recommender/
  47. redis/
  48. rpcreplay/
  49. scheduler/
  50. secretmanager/
  51. securitycenter/
  52. servicedirectory/
  53. spanner/
  54. speech/
  55. storage/
  56. talent/
  57. texttospeech/
  58. trace/
  59. translate/
  60. videointelligence/
  61. vision/
  62. webrisk/
  63. .gitignore
  64. CHANGES.md
  65. CODE_OF_CONDUCT.md
  66. CONTRIBUTING.md
  67. doc.go
  68. examples_test.go
  69. go.mod
  70. go.sum
  71. LICENSE
  72. license_test.go
  73. README.md
  74. RELEASING.md
  75. tools.go
README.md

Google Cloud Client Libraries for Go

GoDoc

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 APIStatusPackage
Assetstablecloud.google.com/go/asset/apiv1
Automlstablecloud.google.com/go/automl/apiv1
BigQuerystablecloud.google.com/go/bigquery
Bigtablestablecloud.google.com/go/bigtable
Cloudbuildstablecloud.google.com/go/cloudbuild/apiv1
Cloudtasksstablecloud.google.com/go/cloudtasks/apiv2
Containerstablecloud.google.com/go/container/apiv1
ContainerAnalysisbetacloud.google.com/go/containeranalysis/apiv1
Dataprocstablecloud.google.com/go/dataproc/apiv1
Datastorestablecloud.google.com/go/datastore
Debuggerstablecloud.google.com/go/debugger/apiv2
Dialogflowstablecloud.google.com/go/dialogflow/apiv2
Data Loss Preventionstablecloud.google.com/go/dlp/apiv2
ErrorReportingalphacloud.google.com/go/errorreporting
Firestorestablecloud.google.com/go/firestore
IAMstablecloud.google.com/go/iam
IoTstablecloud.google.com/go/iot/apiv1
IRMalphacloud.google.com/go/irm/apiv1alpha2
KMSstablecloud.google.com/go/kms/apiv1
Natural Languagestablecloud.google.com/go/language/apiv1
Loggingstablecloud.google.com/go/logging
Memorystorealphacloud.google.com/go/redis/apiv1
Monitoringstablecloud.google.com/go/monitoring/apiv3
OS Loginstablecloud.google.com/go/oslogin/apiv1
Pub/Substablecloud.google.com/go/pubsub
Phishing Protectionalphacloud.google.com/go/phishingprotection/apiv1beta1
reCAPTCHA Enterprisealphacloud.google.com/go/recaptchaenterprise/apiv1beta1
Recommenderbetacloud.google.com/go/recommender/apiv1beta1
Schedulerstablecloud.google.com/go/scheduler/apiv1
Securitycenterstablecloud.google.com/go/securitycenter/apiv1
Spannerstablecloud.google.com/go/spanner
Speechstablecloud.google.com/go/speech/apiv1
Storagestablecloud.google.com/go/storage
Talentalphacloud.google.com/go/talent/apiv4beta1
Text To Speechstablecloud.google.com/go/texttospeech/apiv1
Tracestablecloud.google.com/go/trace/apiv2
Translatestablecloud.google.com/go/translate
Video Intelligencebetacloud.google.com/go/videointelligence/apiv1beta2
Visionstablecloud.google.com/go/vision/apiv1
Webriskalphacloud.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 pkg.go.dev/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.

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.