Method: projects.databases.documents.delete

Borra un documento.

Solicitud HTTP

DELETE https://firestore.googleapis.com/v1/{name=projects/*/databases/*/documents/*/**}

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
name

string

Obligatorio. El nombre del recurso del documento que se borrará. En el formato: projects/{projectId}/databases/{databaseId}/documents/{document_path}.

Parámetros de consulta

Parámetros
currentDocument

object (Precondition)

Una condición previa opcional en el documento. La solicitud fallará si el documento de destino lo configura y no la cumple.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Si se ejecuta correctamente, el cuerpo de la respuesta está vacío.

Permisos de autorización

Se necesita uno de los siguientes alcances de OAuth:

  • https://www.googleapis.com/auth/datastore
  • https://www.googleapis.com/auth/cloud-platform

Para obtener más información, consulta Descripción general de la autenticación.