Skip to main content
Google Cloud Documentation
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
  • Python
  • Client libraries
Start free
Overview Guides Reference Samples
Google Cloud Documentation
  • Documentation
    • More
    • Overview
    • Guides
    • Reference
    • Samples
  • Console
  • Overview
  • Library reference docs
  • BigQuery DataFrames
  • google-cloud-access-approval
  • google-cloud-advisorynotifications
  • google-cloud-agentidentity
  • google-cloud-agentidentitycredentials
  • google-cloud-agentplatform
  • google-cloud-agentregistry
  • google-cloud-aiplatform
  • google-cloud-alloydb
  • google-cloud-alloydb-connectors
  • google-cloud-api-gateway
  • google-cloud-api-keys
  • google-cloud-apigee-connect
  • google-cloud-apigee-registry
  • google-cloud-apigee-registry
  • google-cloud-apihub
  • google-cloud-apiregistry
  • google-cloud-appengine-admin
  • google-cloud-appengine-logging
  • google-cloud-apphub
  • google-cloud-appoptimize
  • google-cloud-artifact-registry
  • google-cloud-asset
  • google-cloud-assured-workloads
  • google-cloud-audit-log
  • google-cloud-auditmanager
  • google-cloud-automl
  • google-cloud-backupdr
  • google-cloud-bare-metal-solution
  • google-cloud-batch
  • google-cloud-beyondcorp-appconnections
  • google-cloud-beyondcorp-appconnectors
  • google-cloud-beyondcorp-appgateways
  • google-cloud-beyondcorp-clientconnectorservices
  • google-cloud-beyondcorp-clientgateways
  • google-cloud-biglake
  • google-cloud-biglake-hive
  • google-cloud-bigquery
  • google-cloud-bigquery-biglake
  • google-cloud-bigquery-connection
  • google-cloud-bigquery-data-exchange
  • google-cloud-bigquery-datapolicies
  • google-cloud-bigquery-datatransfer
  • google-cloud-bigquery-logging
  • google-cloud-bigquery-migration
  • google-cloud-bigquery-reservation
  • google-cloud-bigquery-storage
  • google-cloud-bigtable
  • google-cloud-billing
  • google-cloud-billing-budgets
  • google-cloud-binary-authorization
  • google-cloud-build
  • google-cloud-capacityplanner
  • google-cloud-certificate-manager
  • google-cloud-ces
  • google-cloud-channel
  • google-cloud-chronicle
  • google-cloud-cloudcontrolspartner
  • google-cloud-cloudsecuritycompliance
  • google-cloud-commerce-consumer-procurement
  • google-cloud-commerceproducer
  • google-cloud-common
  • google-cloud-compute
  • google-cloud-compute-v1beta
  • google-cloud-confidentialcomputing
  • google-cloud-config
  • google-cloud-configdelivery
  • google-cloud-contact-center-insights
  • google-cloud-container
  • google-cloud-containeranalysis
  • google-cloud-contentwarehouse
  • google-cloud-core
  • google-cloud-data-fusion
  • google-cloud-data-qna
  • google-cloud-databasecenter
  • google-cloud-datacatalog
  • google-cloud-datacatalog-lineage
  • google-cloud-datacatalog-lineage-configmanagement
  • google-cloud-dataflow-client
  • google-cloud-dataform
  • google-cloud-datalabeling
  • google-cloud-dataplex
  • google-cloud-dataproc
  • google-cloud-dataproc-metastore
  • google-cloud-datastore
  • google-cloud-datastream
  • google-cloud-debugger-client
  • google-cloud-deploy
  • google-cloud-developerconnect
  • google-cloud-devicestreaming
  • google-cloud-dialogflow
  • google-cloud-dialogflow-cx
  • google-cloud-discoveryengine
  • google-cloud-dlp
  • google-cloud-dms
  • google-cloud-dns
  • google-cloud-documentai
  • google-cloud-documentai-toolbox
  • google-cloud-domains
  • google-cloud-edgecontainer
  • google-cloud-edgenetwork
  • google-cloud-enterpriseknowledgegraph
  • google-cloud-error-reporting
  • google-cloud-essential-contacts
  • google-cloud-eventarc
  • google-cloud-eventarc-publishing
  • google-cloud-filestore
  • google-cloud-financialservices
  • google-cloud-firestore
    • Overview
    • firestore APIs
      • API overview
      • Classes
      • Methods
      • Properties and Attributes
    • Changelog
    • Multiprocessing
    • Firestore Admin V1
      • client
        • Overview
        • FirestoreAdminClient
    • Firestore Bundle
      • bundle
        • Overview
        • FirestoreBundle
    • Firestore V1
      • aggregation
        • Overview
        • AggregationQuery
      • async_aggregation
        • Overview
        • AsyncAggregationQuery
      • async_batch
        • Overview
        • AsyncWriteBatch
      • async_client
        • Overview
        • AsyncClient
      • async_collection
        • Overview
        • AsyncCollectionReference
      • async_document
        • Overview
        • AsyncDocumentReference
      • async_query
        • Overview
        • AsyncCollectionGroup
        • AsyncQuery
      • async_transaction
        • Overview
        • AsyncTransaction
      • base_aggregation
        • Overview
        • AggregationResult
        • AvgAggregation
        • BaseAggregation
        • BaseAggregationQuery
        • CountAggregation
        • SumAggregation
      • base_batch
        • Overview
        • BaseBatch
        • BaseWriteBatch
      • base_client
        • Overview
        • BaseClient
      • base_collection
        • Overview
        • BaseCollectionReference
      • base_document
        • Overview
        • BaseDocumentReference
        • DocumentSnapshot
      • base_query
        • Overview
        • And
        • BaseCollectionGroup
        • BaseCompositeFilter
        • BaseFilter
        • BaseQuery
        • FieldFilter
        • Or
        • QueryPartition
      • base_transaction
        • Overview
        • BaseTransaction
      • batch
        • Overview
        • WriteBatch
      • client
        • Overview
        • Client
      • collection
        • Overview
        • CollectionReference
      • document
        • Overview
        • DocumentReference
      • field_path
        • Overview
        • FieldPath
      • query
        • Overview
        • CollectionGroup
        • Query
      • transaction
        • Overview
        • Transaction
      • transforms
        • Overview
        • ArrayRemove
        • ArrayUnion
        • Increment
        • Maximum
        • Minimum
        • Sentinel
      • types
        • Overview
        • AggregationResult
          • Overview
          • AggregateFieldsEntry
        • ArrayValue
        • BatchGetDocumentsRequest
        • BatchGetDocumentsResponse
        • BatchWriteRequest
          • Overview
          • LabelsEntry
        • BatchWriteResponse
        • BeginTransactionRequest
        • BeginTransactionResponse
        • BitSequence
        • BloomFilter
        • CommitRequest
        • CommitResponse
        • CreateDocumentRequest
        • Cursor
        • DeleteDocumentRequest
        • Document
          • Overview
          • FieldsEntry
        • DocumentChange
        • DocumentDelete
        • DocumentMask
        • DocumentRemove
        • DocumentTransform
          • Overview
          • FieldTransform
            • Overview
            • ServerValue
        • ExecutePipelineRequest
        • ExecutePipelineResponse
        • ExecutionStats
        • ExistenceFilter
        • ExplainMetrics
        • ExplainOptions
        • ExplainStats
        • Function
          • Overview
          • OptionsEntry
        • GetDocumentRequest
        • ListCollectionIdsRequest
        • ListCollectionIdsResponse
        • ListDocumentsRequest
        • ListDocumentsResponse
        • ListenRequest
          • Overview
          • LabelsEntry
        • ListenResponse
        • MapValue
          • Overview
          • FieldsEntry
        • PartitionQueryRequest
        • PartitionQueryResponse
        • Pipeline
          • Overview
          • Stage
            • Overview
            • OptionsEntry
        • PlanSummary
        • Precondition
        • RequestOptions
        • RollbackRequest
        • RunAggregationQueryRequest
        • RunAggregationQueryResponse
        • RunQueryRequest
        • RunQueryResponse
        • StructuredAggregationQuery
          • Overview
          • Aggregation
            • Overview
            • Avg
            • Count
            • Sum
        • StructuredPipeline
          • Overview
          • OptionsEntry
        • StructuredQuery
          • Overview
          • CollectionSelector
          • CompositeFilter
            • Overview
            • Operator
          • Direction
          • FieldFilter
            • Overview
            • Operator
          • FieldReference
          • Filter
          • FindNearest
            • Overview
            • DistanceMeasure
          • Order
          • Projection
          • UnaryFilter
            • Overview
            • Operator
        • Target
          • Overview
          • DocumentsTarget
          • QueryTarget
        • TargetChange
          • Overview
          • TargetChangeType
        • TransactionOptions
          • Overview
          • ConcurrencyMode
          • ReadOnly
          • ReadWrite
        • UpdateDocumentRequest
        • Value
        • Write
        • WriteRequest
          • Overview
          • LabelsEntry
        • WriteResponse
        • WriteResult
      • BulkWriter
  • google-cloud-ftp
  • google-cloud-functions
  • google-cloud-game-servers
  • google-cloud-gdchardwaremanagement
  • google-cloud-geminidataanalytics
  • google-cloud-gke-backup
  • google-cloud-gke-connect-gateway
  • google-cloud-gke-hub
  • google-cloud-gke-multicloud
  • google-cloud-gkerecommender
  • google-cloud-gsuiteaddons
  • google-cloud-hypercomputecluster
  • google-cloud-iam
  • google-cloud-iam-logging
  • google-cloud-iamconnectorcredentials
  • google-cloud-iap
  • google-cloud-ids
  • google-cloud-iot
  • google-cloud-kms
  • google-cloud-kms-inventory
  • google-cloud-language
  • google-cloud-licensemanager
  • google-cloud-life-sciences
  • google-cloud-locationfinder
  • google-cloud-logging
  • google-cloud-lustre
  • google-cloud-maintenance-api
  • google-cloud-managed-identities
  • google-cloud-managedkafka
  • google-cloud-managedkafka-schemaregistry
  • google-cloud-media-translation
  • google-cloud-memcache
  • google-cloud-memorystore
  • google-cloud-migrationcenter
  • google-cloud-modelarmor
  • google-cloud-monitoring
  • google-cloud-monitoring-dashboards
  • google-cloud-monitoring-metrics-scopes
  • google-cloud-netapp
  • google-cloud-network-connectivity
  • google-cloud-network-management
  • google-cloud-network-security
  • google-cloud-network-services
  • google-cloud-notebooks
  • google-cloud-optimization
  • google-cloud-oracledatabase
  • google-cloud-orchestration-airflow
  • google-cloud-org-policy
  • google-cloud-os-config
  • google-cloud-os-login
  • google-cloud-parallelstore