Cloud Firestore API (firestore:v1)

2024-06-21

1 new method

Additions

    Methods
  • firestore.projects.databases.bulkDeleteDocuments

      Path: v1/{+name}:bulkDeleteDocuments

      Flat Path: v1/projects/{projectsId}/databases/{databasesId}:bulkDeleteDocuments

      HTTP Method: POST

      Parameters:

        name

          Description: Required. Database to operate. Should be of the form: `projects/{project_id}/databases/{database_id}`.

          Pattern: ^projects/[^/]+/databases/[^/]+$

          Location: path

          Required: Yes

          Type: string

      Parameter Order: name

      Scopes:

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/datastore
    • Description: Bulk deletes a subset of documents from Google Cloud Firestore. Documents created or updated after the underlying system starts to process the request will not be deleted. The bulk delete occurs in the background and its progress can be monitored and managed via the Operation resource that is created. For more details on bulk delete behavior, refer to: https://cloud.google.com/firestore/docs/manage-data/bulk-delete