api: google.golang.org/api Index | Files | Directories

package api

import "google.golang.org/api"

Package api is the root of the packages used to access Google Cloud Services. See https://godoc.org/google.golang.org/api for a full list of sub-packages.

Within api there exist numerous clients which connect to Google APIs, and various utility packages.

Client Options

All clients in sub-packages are configurable via client options. These options are described here: https://godoc.org/google.golang.org/api/option.

Authentication and Authorization

All the clients in sub-packages support authentication via Google Application Default Credentials (see https://cloud.google.com/docs/authentication/production), or by providing a JSON key file for a Service Account. See the authentication examples in https://godoc.org/google.golang.org/api/transport for more details.

Versioning and Stability

Due to the auto-generated nature of this collection of libraries, complete APIs or specific versions can appear or go away without notice. As a result, you should always locally vendor any API(s) that your code relies upon.

Google APIs follow semver as specified by https://cloud.google.com/apis/design/versioning. The code generator and the code it produces - the libraries in the google.golang.org/api/... subpackages - are beta.

Note that versioning and stability is strictly not communicated through Go modules. Go modules are used only for dependency management.

Integers

Many parameters are specified using ints. However, underlying APIs might operate on a finer granularity, expecting int64, int32, uint64, or uint32, all of whom have different maximum values. Subsequently, specifying an int parameter in one of these clients may result in an error from the API because the value is too large.

To see the exact type of int that the API expects, you can inspect the API's discovery doc. A global catalogue pointing to the discovery doc of APIs can be found at https://www.googleapis.com/discovery/v1/apis.

Index

Package Files

doc.go

Directories

PathSynopsis
abusiveexperiencereport/v1Package abusiveexperiencereport provides access to the Abusive Experience Report API.
acceleratedmobilepageurl/v1Package acceleratedmobilepageurl provides access to the Accelerated Mobile Pages (AMP) URL API.
accesscontextmanager/v1Package accesscontextmanager provides access to the Access Context Manager API.
accesscontextmanager/v1betaPackage accesscontextmanager provides access to the Access Context Manager API.
adexchangebuyer2/v2beta1Package adexchangebuyer2 provides access to the Ad Exchange Buyer API II.
adexchangebuyer/v1.2Package adexchangebuyer provides access to the Ad Exchange Buyer API.
adexchangebuyer/v1.3Package adexchangebuyer provides access to the Ad Exchange Buyer API.
adexchangebuyer/v1.4Package adexchangebuyer provides access to the Ad Exchange Buyer API.
adexchangeseller/v1Package adexchangeseller provides access to the Ad Exchange Seller API.
adexchangeseller/v1.1Package adexchangeseller provides access to the Ad Exchange Seller API.
adexchangeseller/v2.0Package adexchangeseller provides access to the Ad Exchange Seller API.
adexperiencereport/v1Package adexperiencereport provides access to the Ad Experience Report API.
admin/datatransfer/v1Package admin provides access to the Admin Data Transfer API.
admin/directory/v1Package admin provides access to the Admin Directory API.
admin/reports/v1Package admin provides access to the Admin Reports API.
adsensehost/v4.1Package adsensehost provides access to the AdSense Host API.
adsense/v1.3Package adsense provides access to the AdSense Management API.
adsense/v1.4Package adsense provides access to the AdSense Management API.
alertcenter/v1beta1Package alertcenter provides access to the G Suite Alert Center API.
analyticsreporting/v4Package analyticsreporting provides access to the Analytics Reporting API.
analytics/v2.4Package analytics provides access to the Google Analytics API.
analytics/v3Package analytics provides access to the Google Analytics API.
androidenterprise/v1Package androidenterprise provides access to the Google Play EMM API.
androidmanagement/v1Package androidmanagement provides access to the Android Management API.
androidpublisher/v1Package androidpublisher provides access to the Google Play Developer API.
androidpublisher/v1.1Package androidpublisher provides access to the Google Play Developer API.
androidpublisher/v2Package androidpublisher provides access to the Google Play Developer API.
androidpublisher/v3Package androidpublisher provides access to the Google Play Developer API.
appengine/v1Package appengine provides access to the App Engine Admin API.
appengine/v1alphaPackage appengine provides access to the App Engine Admin API.
appengine/v1betaPackage appengine provides access to the App Engine Admin API.
appengine/v1beta4Package appengine provides access to the App Engine Admin API.
appengine/v1beta5Package appengine provides access to the App Engine Admin API.
appsactivity/v1Package appsactivity provides access to the Drive Activity API.
appstate/v1Package appstate provides access to the Google App State API.
bigquerydatatransfer/v1Package bigquerydatatransfer provides access to the BigQuery Data Transfer API.
bigquery/v2Package bigquery provides access to the BigQuery API.
binaryauthorization/v1beta1Package binaryauthorization provides access to the Binary Authorization API.
blogger/v2Package blogger provides access to the Blogger API.
blogger/v3Package blogger provides access to the Blogger API.
books/v1Package books provides access to the Books API.
calendar/v3Package calendar provides access to the Calendar API.
chat/v1Package chat provides access to the Hangouts Chat API.
civicinfo/v2Package civicinfo provides access to the Google Civic Information API.
classroom/v1Package classroom provides access to the Google Classroom API.
cloudbilling/v1Package cloudbilling provides access to the Cloud Billing API.
cloudbuild/v1Package cloudbuild provides access to the Cloud Build API.
cloudbuild/v1alpha1Package cloudbuild provides access to the Cloud Build API.
clouddebugger/v2Package clouddebugger provides access to the Stackdriver Debugger API.
clouderrorreporting/v1beta1Package clouderrorreporting provides access to the Stackdriver Error Reporting API.
cloudfunctions/v1Package cloudfunctions provides access to the Cloud Functions API.
cloudfunctions/v1beta2Package cloudfunctions provides access to the Cloud Functions API.
cloudiot/v1Package cloudiot provides access to the Cloud IoT API.
cloudkms/v1Package cloudkms provides access to the Cloud Key Management Service (KMS) API.
cloudresourcemanager/v1Package cloudresourcemanager provides access to the Cloud Resource Manager API.
cloudresourcemanager/v1beta1Package cloudresourcemanager provides access to the Cloud Resource Manager API.
cloudresourcemanager/v2Package cloudresourcemanager provides access to the Cloud Resource Manager API.
cloudresourcemanager/v2beta1Package cloudresourcemanager provides access to the Cloud Resource Manager API.
cloudscheduler/v1Package cloudscheduler provides access to the Cloud Scheduler API.
cloudscheduler/v1beta1Package cloudscheduler provides access to the Cloud Scheduler API.
cloudsearch/v1Package cloudsearch provides access to the Cloud Search API.
cloudshell/v1Package cloudshell provides access to the Cloud Shell API.
cloudshell/v1alpha1Package cloudshell provides access to the Cloud Shell API.
cloudtasks/v2Package cloudtasks provides access to the Cloud Tasks API.
cloudtasks/v2beta2Package cloudtasks provides access to the Cloud Tasks API.
cloudtasks/v2beta3Package cloudtasks provides access to the Cloud Tasks API.
cloudtrace/v1Package cloudtrace provides access to the Stackdriver Trace API.
cloudtrace/v2Package cloudtrace provides access to the Stackdriver Trace API.
composer/v1Package composer provides access to the Cloud Composer API.
composer/v1beta1Package composer provides access to the Cloud Composer API.
compute/v0.alphaPackage compute provides access to the Compute Engine API.
compute/v0.betaPackage compute provides access to the Compute Engine API.
compute/v1Package compute provides access to the Compute Engine API.
consumersurveys/v2Package consumersurveys provides access to the Consumer Surveys API.
container/v1Package container provides access to the Kubernetes Engine API.
container/v1beta1Package container provides access to the Kubernetes Engine API.
content/v2Package content provides access to the Content API for Shopping.
content/v2.1Package content provides access to the Content API for Shopping.
content/v2sandboxPackage content provides access to the Content API for Shopping.
customsearch/v1Package customsearch provides access to the CustomSearch API.
dataflow/v1b3Package dataflow provides access to the Dataflow API.
dataproc/v1Package dataproc provides access to the Cloud Dataproc API.
dataproc/v1beta2Package dataproc provides access to the Cloud Dataproc API.
datastore/v1Package datastore provides access to the Cloud Datastore API.
datastore/v1beta1Package datastore provides access to the Cloud Datastore API.
datastore/v1beta3Package datastore provides access to the Cloud Datastore API.
deploymentmanager/v0.alphaPackage deploymentmanager provides access to the Google Cloud Deployment Manager Alpha API.
deploymentmanager/v2Package deploymentmanager provides access to the Google Cloud Deployment Manager API.
deploymentmanager/v2betaPackage deploymentmanager provides access to the Google Cloud Deployment Manager API V2Beta Methods.
dfareporting/v2.7Package dfareporting provides access to the DCM/DFA Reporting And Trafficking API.
dfareporting/v2.8Package dfareporting provides access to the DCM/DFA Reporting And Trafficking API.
dfareporting/v3.0Package dfareporting provides access to the DCM/DFA Reporting And Trafficking API.
dfareporting/v3.1Package dfareporting provides access to the DCM/DFA Reporting And Trafficking API.
dfareporting/v3.2Package dfareporting provides access to the DCM/DFA Reporting And Trafficking API.
dfareporting/v3.3Package dfareporting provides access to the DCM/DFA Reporting And Trafficking API.
dialogflow/v2Package dialogflow provides access to the Dialogflow API.
dialogflow/v2beta1Package dialogflow provides access to the Dialogflow API.
discovery/v1Package discovery provides access to the API Discovery Service.
dlp/v2Package dlp provides access to the Cloud Data Loss Prevention (DLP) API.
dns/v1Package dns provides access to the Google Cloud DNS API.
dns/v1beta2Package dns provides access to the Google Cloud DNS API.
dns/v2beta1Package dns provides access to the Google Cloud DNS API.
docs/v1Package docs provides access to the Google Docs API.
doubleclickbidmanager/v1Package doubleclickbidmanager provides access to the DoubleClick Bid Manager API.
doubleclicksearch/v2Package doubleclicksearch provides access to the DoubleClick Search API.
driveactivity/v2Package driveactivity provides access to the Drive Activity API.
drive/v2Package drive provides access to the Drive API.
drive/v3Package drive provides access to the Drive API.
examples
file/v1Package file provides access to the Cloud Filestore API.
file/v1beta1Package file provides access to the Cloud Filestore API.
firebasedynamiclinks/v1Package firebasedynamiclinks provides access to the Firebase Dynamic Links API.
firebasehosting/v1beta1Package firebasehosting provides access to the Firebase Hosting API.
firebaseremoteconfig/v1Package firebaseremoteconfig provides access to the Firebase Remote Config API.
firebaserules/v1Package firebaserules provides access to the Firebase Rules API.
firestore/v1Package firestore provides access to the Cloud Firestore API.
firestore/v1beta1Package firestore provides access to the Cloud Firestore API.
firestore/v1beta2Package firestore provides access to the Cloud Firestore API.
fitness/v1Package fitness provides access to the Fitness.
fusiontables/v1Package fusiontables provides access to the Fusion Tables API.
fusiontables/v2Package fusiontables provides access to the Fusion Tables API.
gamesconfiguration/v1configurationPackage gamesconfiguration provides access to the Google Play Game Services Publishing API.
gamesmanagement/v1managementPackage gamesmanagement provides access to the Google Play Game Services Management API.
games/v1Package games provides access to the Google Play Game Services API.
genomics/v1Package genomics provides access to the Genomics API.
genomics/v1alpha2Package genomics provides access to the Genomics API.
genomics/v2alpha1Package genomics provides access to the Genomics API.
gensupportPackage gensupport is an internal implementation detail used by code generated by the google-api-go-generator tool.
gmail/v1Package gmail provides access to the Gmail API.
googleapiPackage googleapi contains the common code shared by all Google API libraries.
google-api-go-generator
google-api-go-generator/internal/discoPackage disco represents Google API discovery documents.
googleapi/internal/uritemplatesPackage uritemplates is a level 3 implementation of RFC 6570 (URI Template, http://tools.ietf.org/html/rfc6570).
googleapi/transportPackage transport contains HTTP transports used to make authenticated API requests.
groupsmigration/v1Package groupsmigration provides access to the Groups Migration API.
groupssettings/v1Package groupssettings provides access to the Groups Settings API.
healthcare/v1alphaPackage healthcare provides access to the Cloud Healthcare API.
healthcare/v1alpha2Package healthcare provides access to the Cloud Healthcare API.
healthcare/v1beta1Package healthcare provides access to the Cloud Healthcare API.
iamcredentials/v1Package iamcredentials provides access to the IAM Service Account Credentials API.
iam/v1Package iam provides access to the Identity and Access Management (IAM) API.
iap/v1Package iap provides access to the Cloud Identity-Aware Proxy API.
iap/v1beta1Package iap provides access to the Cloud Identity-Aware Proxy API.
identitytoolkit/v3Package identitytoolkit provides access to the Google Identity Toolkit API.
indexing/v3Package indexing provides access to the Indexing API.
internalPackage internal supports the options and transport packages.
iteratorPackage iterator provides support for standard Google API iterators.
iterator/testingPackage testing provides support functions for testing iterators conforming to the standard pattern.
jobs/v2Package jobs provides access to the Cloud Talent Solution API.
jobs/v3Package jobs provides access to the Cloud Talent Solution API.
jobs/v3p1beta1Package jobs provides access to the Cloud Talent Solution API.
kgsearch/v1Package kgsearch provides access to the Knowledge Graph Search API.
language/v1Package language provides access to the Cloud Natural Language API.
language/v1beta1Package language provides access to the Cloud Natural Language API.
language/v1beta2Package language provides access to the Cloud Natural Language API.
licensing/v1Package licensing provides access to the Enterprise License Manager API.
logging/v2Package logging provides access to the Stackdriver Logging API.
logging/v2beta1Package logging provides access to the Stackdriver Logging API.
manufacturers/v1Package manufacturers provides access to the Manufacturer Center API.
mirror/v1Package mirror provides access to the Google Mirror API.
ml/v1Package ml provides access to the Cloud Machine Learning Engine.
monitoring/v1Package monitoring provides access to the Stackdriver Monitoring API.
monitoring/v3Package monitoring provides access to the Stackdriver Monitoring API.
oauth2/v1Package oauth2 provides access to the Google OAuth2 API.
oauth2/v2Package oauth2 provides access to the Google OAuth2 API.
optionPackage option contains options for Google API clients.
oslogin/v1Package oslogin provides access to the Cloud OS Login API.
oslogin/v1alphaPackage oslogin provides access to the Cloud OS Login API.
oslogin/v1betaPackage oslogin provides access to the Cloud OS Login API.
pagespeedonline/v1Package pagespeedonline provides access to the PageSpeed Insights API.
pagespeedonline/v2Package pagespeedonline provides access to the PageSpeed Insights API.
pagespeedonline/v4Package pagespeedonline provides access to the PageSpeed Insights API.
pagespeedonline/v5Package pagespeedonline provides access to the PageSpeed Insights API.
partners/v2Package partners provides access to the Google Partners API.
people/v1Package people provides access to the People API.
playmoviespartner/v1Package playmoviespartner provides access to the Google Play Movies Partner API.
plusdomains/v1Package plusdomains provides access to the Google+ Domains API.
plus/v1Package plus provides access to the Google+ API.
poly/v1Package poly provides access to the Poly API.
prediction/v1.2Package prediction provides access to the Prediction API.
prediction/v1.3Package prediction provides access to the Prediction API.
prediction/v1.4Package prediction provides access to the Prediction API.
prediction/v1.5Package prediction provides access to the Prediction API.
prediction/v1.6Package prediction provides access to the Prediction API.
proximitybeacon/v1beta1Package proximitybeacon provides access to the Proximity Beacon API.
pubsub/v1Package pubsub provides access to the Cloud Pub/Sub API.
pubsub/v1beta1aPackage pubsub provides access to the Cloud Pub/Sub API.
pubsub/v1beta2Package pubsub provides access to the Cloud Pub/Sub API.
qpxexpress/v1Package qpxexpress provides access to the QPX Express API.
redis/v1Package redis provides access to the Google Cloud Memorystore for Redis API.
redis/v1beta1Package redis provides access to the Google Cloud Memorystore for Redis API.
remotebuildexecution/v1Package remotebuildexecution provides access to the Remote Build Execution API.
remotebuildexecution/v1alphaPackage remotebuildexecution provides access to the Remote Build Execution API.
remotebuildexecution/v2Package remotebuildexecution provides access to the Remote Build Execution API.
replicapoolupdater/v1beta1Package replicapoolupdater provides access to the Google Compute Engine Instance Group Updater API.
replicapool/v1beta1Package replicapool provides access to the Replica Pool API.
reseller/v1Package reseller provides access to the Enterprise Apps Reseller API.
runtimeconfig/v1Package runtimeconfig provides access to the Cloud Runtime Configuration API.
runtimeconfig/v1beta1Package runtimeconfig provides access to the Cloud Runtime Configuration API.
run/v1Package run provides access to the Cloud Run API.
run/v1alpha1Package run provides access to the Cloud Run API.
safebrowsing/v4Package safebrowsing provides access to the Safe Browsing API.
script/v1Package script provides access to the Apps Script API.
searchconsole/v1Package searchconsole provides access to the Google Search Console URL Testing Tools API.
serviceconsumermanagement/v1Package serviceconsumermanagement provides access to the Service Consumer Management API.
servicecontrol/v1Package servicecontrol provides access to the Service Control API.
servicemanagement/v1Package servicemanagement provides access to the Service Management API.
servicenetworking/v1Package servicenetworking provides access to the Service Networking API.
servicenetworking/v1betaPackage servicenetworking provides access to the Service Networking API.
serviceusage/v1Package serviceusage provides access to the Service Usage API.
serviceusage/v1beta1Package serviceusage provides access to the Service Usage API.
serviceuser/v1Package serviceuser provides access to the Service User API.
sheets/v4Package sheets provides access to the Google Sheets API.
siteverification/v1Package siteverification provides access to the Google Site Verification API.
slides/v1Package slides provides access to the Google Slides API.
sourcerepo/v1Package sourcerepo provides access to the Cloud Source Repositories API.
spanner/v1Package spanner provides access to the Cloud Spanner API.
spectrum/v1explorerPackage spectrum provides access to the Google Spectrum Database API.
speech/v1Package speech provides access to the Cloud Speech-to-Text API.
speech/v1beta1Package speech provides access to the Cloud Speech API.
speech/v1p1beta1Package speech provides access to the Cloud Speech-to-Text API.
sqladmin/v1beta4Package sqladmin provides access to the Cloud SQL Admin API.
storagetransfer/v1Package storagetransfer provides access to the Storage Transfer API.
storage/v1Package storage provides access to the Cloud Storage JSON API.
storage/v1beta1Package storage provides access to the Cloud Storage JSON API.
storage/v1beta2Package storage provides access to the Cloud Storage JSON API.
support/bundlerPackage bundler supports bundling (batching) of items.
surveys/v2Package surveys provides access to the Surveys API.
tagmanager/v1Package tagmanager provides access to the Tag Manager API.
tagmanager/v2Package tagmanager provides access to the Tag Manager API.
tasks/v1Package tasks provides access to the Tasks API.
testing/v1Package testing provides access to the Cloud Testing API.
texttospeech/v1Package texttospeech provides access to the Cloud Text-to-Speech API.
texttospeech/v1beta1Package texttospeech provides access to the Cloud Text-to-Speech API.
toolresults/v1beta3Package toolresults provides access to the Cloud Tool Results API.
tpu/v1Package tpu provides access to the Cloud TPU API.
tpu/v1alpha1Package tpu provides access to the Cloud TPU API.
tracing/v2Package tracing provides access to the Google Tracing API.
translate/v2Package translate provides access to the Google Cloud Translation API.
transportPackage transport provides utility methods for creating authenticated transports to Google's HTTP and gRPC APIs.
transport/bytestreamPackage bytestream provides a client for any service that exposes a ByteStream API.
transport/bytestream/internal
transport/grpcPackage grpc supports network connections to GRPC servers.
transport/httpPackage http supports network connections to HTTP servers.
transport/http/internal/propagationPackage propagation implements X-Cloud-Trace-Context header propagation used by Google Cloud products.
urlshortener/v1Package urlshortener provides access to the URL Shortener API.
vault/v1Package vault provides access to the G Suite Vault API.
videointelligence/v1Package videointelligence provides access to the Cloud Video Intelligence API.
videointelligence/v1beta2Package videointelligence provides access to the Cloud Video Intelligence API.
videointelligence/v1p1beta1Package videointelligence provides access to the Cloud Video Intelligence API.
videointelligence/v1p2beta1Package videointelligence provides access to the Cloud Video Intelligence API.
videointelligence/v1p3beta1Package videointelligence provides access to the Cloud Video Intelligence API.
vision/v1Package vision provides access to the Cloud Vision API.
vision/v1p1beta1Package vision provides access to the Cloud Vision API.
vision/v1p2beta1Package vision provides access to the Cloud Vision API.
webfonts/v1Package webfonts provides access to the Google Fonts Developer API.
webmasters/v3Package webmasters provides access to the Search Console API.
youtubeanalytics/v1Package youtubeanalytics provides access to the YouTube Analytics API.
youtubeanalytics/v1beta1Package youtubeanalytics provides access to the YouTube Analytics API.
youtubeanalytics/v2Package youtubeanalytics provides access to the YouTube Analytics API.
youtubereporting/v1Package youtubereporting provides access to the YouTube Reporting API.
youtube/v3Package youtube provides access to the YouTube Data API.

Updated 2019-06-16. Refresh now. Tools for package owners.