Skip to main content
Documentation
Get Started
Get Started with Google Cloud
Product List
Cloud Customer Care
Featured Products
Agent Platform
Apigee API Management
BigQuery
Compute Engine
Cloud CDN
Cloud Run
Cloud Storage
Cloud SQL
Gemini Enterprise
Google Kubernetes Engine
Looker
Cross-product Tools
Access and resources management
Costs and usage management
Infrastructure as code
SDK, languages, frameworks, and tools
Technology Areas
AI and ML
Application development
Application hosting
Compute
Data analytics and pipelines
Databases
Distributed, hybrid, and multicloud
Industry solutions
Migration
Networking
Observability and monitoring
Security
Storage
/
Console
English
中文 – 简体
Google Cloud SDK
Ruby
Client libraries
Start free
Overview
Guides
Reference
Samples
Documentation
More
Overview
Guides
Reference
Samples
Console
Overview
Library reference docs
activerecord-spanner-adapter
gapic
gapic-common
google-analytics-admin
google-analytics-admin-v1alpha
google-analytics-data
google-analytics-data-v1alpha
google-analytics-data-v1beta
google-apps-chat
google-apps-chat-v1
google-apps-events-subscriptions
google-apps-events-subscriptions-v1
google-apps-events-subscriptions-v1beta
google-apps-meet
google-apps-meet-v2
google-apps-meet-v2beta
google-area120-tables
google-area120-tables-v1alpha1
google-cloud-access_approval
google-cloud-access_approval-v1
google-cloud-advisory_notifications
google-cloud-advisory_notifications-v1
google-cloud-agent_registry
google-cloud-agent_registry-v1
google-cloud-ai_platform
google-cloud-ai_platform-v1
google-cloud-alloy_db
google-cloud-alloy_db-v1
google-cloud-alloy_db-v1alpha
google-cloud-alloy_db-v1beta
google-cloud-api_gateway
google-cloud-api_gateway-v1
google-cloud-api_hub
google-cloud-api_hub-v1
google-cloud-api_keys
google-cloud-api_keys-v2
google-cloud-api_registry
google-cloud-api_registry-v1beta
google-cloud-apigee_connect
google-cloud-apigee_connect-v1
google-cloud-apigee_registry
google-cloud-apigee_registry-v1
google-cloud-app_engine
google-cloud-app_engine-v1
google-cloud-app_hub
google-cloud-app_hub-v1
google-cloud-app_optimize
google-cloud-app_optimize-v1beta
google-cloud-artifact_registry
google-cloud-artifact_registry-v1
google-cloud-artifact_registry-v1beta2
google-cloud-asset
google-cloud-asset-v1
google-cloud-assured_workloads
google-cloud-assured_workloads-v1
google-cloud-assured_workloads-v1beta1
google-cloud-audit_manager
google-cloud-audit_manager-v1
google-cloud-automl
google-cloud-automl-v1
google-cloud-automl-v1beta1
google-cloud-backupdr
google-cloud-backupdr-v1
google-cloud-bare_metal_solution
google-cloud-bare_metal_solution-v2
google-cloud-batch
google-cloud-batch-v1
google-cloud-beyond_corp
google-cloud-beyond_corp-app_connections-v1
google-cloud-beyond_corp-app_connectors-v1
google-cloud-beyond_corp-app_gateways-v1
google-cloud-beyond_corp-client_connector_services-v1
google-cloud-beyond_corp-client_gateways-v1
google-cloud-bigquery
google-cloud-bigquery-analytics_hub
google-cloud-bigquery-analytics_hub-v1
google-cloud-bigquery-connection
google-cloud-bigquery-connection-v1
google-cloud-bigquery-data_exchange
google-cloud-bigquery-data_exchange-v1beta1
google-cloud-bigquery-data_policies
google-cloud-bigquery-data_policies-v1
google-cloud-bigquery-data_policies-v1beta1
google-cloud-bigquery-data_transfer
google-cloud-bigquery-data_transfer-v1
google-cloud-bigquery-migration
google-cloud-bigquery-migration-v2
google-cloud-bigquery-reservation
google-cloud-bigquery-reservation-v1
google-cloud-bigquery-storage
google-cloud-bigquery-storage-v1
google-cloud-bigtable
google-cloud-bigtable-admin-v2
google-cloud-bigtable-v2
google-cloud-billing
google-cloud-billing-budgets
google-cloud-billing-budgets-v1
google-cloud-billing-budgets-v1beta1
google-cloud-billing-v1
google-cloud-binary_authorization
google-cloud-binary_authorization-v1
google-cloud-binary_authorization-v1beta1
google-cloud-build
google-cloud-build-v1
google-cloud-build-v2
google-cloud-capacity_planner
google-cloud-capacity_planner-v1beta
google-cloud-certificate_manager
google-cloud-certificate_manager-v1
google-cloud-ces
google-cloud-ces-v1
google-cloud-ces-v1beta
google-cloud-channel
google-cloud-channel-v1
google-cloud-chronicle
google-cloud-chronicle-v1
google-cloud-cloud_controls_partner
google-cloud-cloud_controls_partner-v1
google-cloud-cloud_controls_partner-v1beta
google-cloud-cloud_dms
google-cloud-cloud_dms-v1
google-cloud-cloud_quotas
google-cloud-cloud_quotas-v1
google-cloud-cloud_quotas-v1beta
google-cloud-cloud_security_compliance
google-cloud-cloud_security_compliance-v1
google-cloud-commerce-consumer-procurement
google-cloud-commerce-consumer-procurement-v1
google-cloud-compute
google-cloud-compute-v1
google-cloud-confidential_computing
google-cloud-confidential_computing-v1
google-cloud-config-v1
google-cloud-config_delivery
google-cloud-config_delivery-v1
google-cloud-config_service
google-cloud-config_service-v1
google-cloud-connectors
google-cloud-connectors-v1
google-cloud-contact_center_insights
google-cloud-contact_center_insights-v1
google-cloud-container
google-cloud-container-v1
google-cloud-container-v1beta1
google-cloud-container_analysis
google-cloud-container_analysis-v1
google-cloud-core
google-cloud-data_catalog
google-cloud-data_catalog-lineage
google-cloud-data_catalog-lineage-config_management
google-cloud-data_catalog-lineage-v1
google-cloud-data_catalog-v1
google-cloud-data_catalog-v1beta1
google-cloud-data_fusion
google-cloud-data_fusion-v1
google-cloud-data_labeling
google-cloud-data_labeling-v1beta1
google-cloud-database_center
google-cloud-database_center-v1beta
google-cloud-dataflow
google-cloud-dataflow-v1beta3
google-cloud-dataform
google-cloud-dataform-v1
google-cloud-dataform-v1beta1
google-cloud-dataplex
google-cloud-dataplex-v1
google-cloud-dataproc
google-cloud-dataproc-v1
google-cloud-dataproc-v1beta2
google-cloud-dataqna
google-cloud-dataqna-v1alpha
google-cloud-datastore
google-cloud-datastore-admin
google-cloud-datastore-admin-v1
google-cloud-datastore-v1
google-cloud-datastream
google-cloud-datastream-v1
google-cloud-datastream-v1alpha1
google-cloud-debugger
google-cloud-debugger-v2
google-cloud-deploy
google-cloud-deploy-v1
google-cloud-developer_connect
google-cloud-developer_connect-v1
google-cloud-device_streaming
google-cloud-device_streaming-v1
google-cloud-dialogflow
google-cloud-dialogflow-cx
google-cloud-dialogflow-cx-v3
google-cloud-dialogflow-v2
google-cloud-discovery_engine
google-cloud-discovery_engine-v1
google-cloud-discovery_engine-v1beta
google-cloud-dlp
google-cloud-dlp-v2
google-cloud-dns
google-cloud-document_ai
google-cloud-document_ai-v1
google-cloud-document_ai-v1beta3
google-cloud-domains
google-cloud-domains-v1
google-cloud-domains-v1beta1
google-cloud-edge_container
google-cloud-edge_container-v1
google-cloud-edge_network
google-cloud-edge_network-v1
google-cloud-env
google-cloud-error_reporting
google-cloud-error_reporting-v1beta1
google-cloud-errors
google-cloud-essential_contacts
google-cloud-essential_contacts-v1
google-cloud-eventarc
google-cloud-eventarc-publishing
google-cloud-eventarc-publishing-v1
google-cloud-eventarc-v1
google-cloud-filestore
google-cloud-filestore-v1
google-cloud-financial_services
google-cloud-financial_services-v1
google-cloud-firestore
google-cloud-firestore-admin
google-cloud-firestore-admin-v1
Overview
Getting started
Authenticating the library
Google
Google::Api
Google::Api::BatchingConfigProto
Google::Api::BatchingDescriptorProto
Google::Api::BatchingSettingsProto
Google::Api::ClientLibraryDestination
Google::Api::ClientLibraryOrganization
Google::Api::ClientLibrarySettings
Google::Api::CommonLanguageSettings
Google::Api::CppSettings
Google::Api::DotnetSettings
Google::Api::DotnetSettings::RenamedResourcesEntry
Google::Api::DotnetSettings::RenamedServicesEntry
Google::Api::FieldBehavior
Google::Api::FlowControlLimitExceededBehaviorProto
Google::Api::GoSettings
Google::Api::GoSettings::RenamedServicesEntry
Google::Api::JavaSettings
Google::Api::JavaSettings::ServiceClassNamesEntry
Google::Api::LaunchStage
Google::Api::MethodSettings
Google::Api::MethodSettings::LongRunning
Google::Api::NodeSettings
Google::Api::PhpSettings
Google::Api::Publishing
Google::Api::PythonSettings
Google::Api::PythonSettings::ExperimentalFeatures
Google::Api::ResourceDescriptor
Google::Api::ResourceDescriptor::History
Google::Api::ResourceDescriptor::Style
Google::Api::ResourceReference
Google::Api::RoutingParameter
Google::Api::RoutingRule
Google::Api::RubySettings
Google::Api::SelectiveGapicGeneration
Google::Cloud
Google::Cloud::Firestore
Google::Cloud::Firestore::Admin
Google::Cloud::Firestore::Admin::V1
Google::Cloud::Firestore::Admin::V1::Backup
Google::Cloud::Firestore::Admin::V1::Backup::State
Google::Cloud::Firestore::Admin::V1::Backup::Stats
Google::Cloud::Firestore::Admin::V1::BackupSchedule
Google::Cloud::Firestore::Admin::V1::BulkDeleteDocumentsMetadata
Google::Cloud::Firestore::Admin::V1::BulkDeleteDocumentsRequest
Google::Cloud::Firestore::Admin::V1::BulkDeleteDocumentsResponse
Google::Cloud::Firestore::Admin::V1::CloneDatabaseMetadata
Google::Cloud::Firestore::Admin::V1::CloneDatabaseRequest
Google::Cloud::Firestore::Admin::V1::CloneDatabaseRequest::TagsEntry
Google::Cloud::Firestore::Admin::V1::CreateBackupScheduleRequest
Google::Cloud::Firestore::Admin::V1::CreateDatabaseMetadata
Google::Cloud::Firestore::Admin::V1::CreateDatabaseRequest
Google::Cloud::Firestore::Admin::V1::CreateIndexRequest
Google::Cloud::Firestore::Admin::V1::CreateUserCredsRequest
Google::Cloud::Firestore::Admin::V1::DailyRecurrence
Google::Cloud::Firestore::Admin::V1::Database
Google::Cloud::Firestore::Admin::V1::Database::AppEngineIntegrationMode
Google::Cloud::Firestore::Admin::V1::Database::CmekConfig
Google::Cloud::Firestore::Admin::V1::Database::ConcurrencyMode
Google::Cloud::Firestore::Admin::V1::Database::DataAccessMode
Google::Cloud::Firestore::Admin::V1::Database::DatabaseEdition
Google::Cloud::Firestore::Admin::V1::Database::DatabaseType
Google::Cloud::Firestore::Admin::V1::Database::DeleteProtectionState
Google::Cloud::Firestore::Admin::V1::Database::EncryptionConfig
Google::Cloud::Firestore::Admin::V1::Database::EncryptionConfig::CustomerManagedEncryptionOptions
Google::Cloud::Firestore::Admin::V1::Database::EncryptionConfig::GoogleDefaultEncryptionOptions
Google::Cloud::Firestore::Admin::V1::Database::EncryptionConfig::SourceEncryptionOptions
Google::Cloud::Firestore::Admin::V1::Database::PointInTimeRecoveryEnablement
Google::Cloud::Firestore::Admin::V1::Database::SourceInfo
Google::Cloud::Firestore::Admin::V1::Database::SourceInfo::BackupSource
Google::Cloud::Firestore::Admin::V1::Database::TagsEntry
Google::Cloud::Firestore::Admin::V1::DeleteBackupRequest
Google::Cloud::Firestore::Admin::V1::DeleteBackupScheduleRequest
Google::Cloud::Firestore::Admin::V1::DeleteDatabaseMetadata
Google::Cloud::Firestore::Admin::V1::DeleteDatabaseRequest
Google::Cloud::Firestore::Admin::V1::DeleteIndexRequest
Google::Cloud::Firestore::Admin::V1::DeleteUserCredsRequest
Google::Cloud::Firestore::Admin::V1::DisableUserCredsRequest
Google::Cloud::Firestore::Admin::V1::EnableUserCredsRequest
Google::Cloud::Firestore::Admin::V1::ExportDocumentsMetadata
Google::Cloud::Firestore::Admin::V1::ExportDocumentsRequest
Google::Cloud::Firestore::Admin::V1::ExportDocumentsResponse
Google::Cloud::Firestore::Admin::V1::Field
Google::Cloud::Firestore::Admin::V1::Field::IndexConfig
Google::Cloud::Firestore::Admin::V1::Field::TtlConfig
Google::Cloud::Firestore::Admin::V1::Field::TtlConfig::State
Google::Cloud::Firestore::Admin::V1::FieldOperationMetadata
Google::Cloud::Firestore::Admin::V1::FieldOperationMetadata::IndexConfigDelta
Google::Cloud::Firestore::Admin::V1::FieldOperationMetadata::IndexConfigDelta::ChangeType
Google::Cloud::Firestore::Admin::V1::FieldOperationMetadata::TtlConfigDelta
Google::Cloud::Firestore::Admin::V1::FieldOperationMetadata::TtlConfigDelta::ChangeType
Google::Cloud::Firestore::Admin::V1::FirestoreAdmin
Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client
Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client::Configuration
Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client::Configuration::Rpcs
Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Credentials
Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Operations
Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Operations::Configuration
Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Operations::Configuration::Rpcs
Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Paths
Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Rest
Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Rest::Client
Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Rest::Client::Configuration
Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Rest::Client::Configuration::Rpcs
Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Rest::Operations
Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Rest::Operations::Configuration
Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Rest::Operations::Configuration::Rpcs
Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Rest::ServiceStub
Google::Cloud::Firestore::Admin::V1::GetBackupRequest
Google::Cloud::Firestore::Admin::V1::GetBackupScheduleRequest
Google::Cloud::Firestore::Admin::V1::GetDatabaseRequest
Google::Cloud::Firestore::Admin::V1::GetFieldRequest
Google::Cloud::Firestore::Admin::V1::GetIndexRequest
Google::Cloud::Firestore::Admin::V1::GetUserCredsRequest
Google::Cloud::Firestore::Admin::V1::ImportDocumentsMetadata
Google::Cloud::Firestore::Admin::V1::ImportDocumentsRequest
Google::Cloud::Firestore::Admin::V1::Index
Google::Cloud::Firestore::Admin::V1::Index::ApiScope
Google::Cloud::Firestore::Admin::V1::Index::Density
Google::Cloud::Firestore::Admin::V1::Index::IndexField
Google::Cloud::Firestore::Admin::V1::Index::IndexField::ArrayConfig
Google::Cloud::Firestore::Admin::V1::Index::IndexField::Order
Google::Cloud::Firestore::Admin::V1::Index::IndexField::SearchConfig