Method: projects.databases.documents.delete

Exclui um documento.

Solicitação HTTP

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

A URL usa sintaxe de transcodificação gRPC .

Parâmetros de caminho

Parâmetros
name

string

Obrigatório. O nome do recurso do Documento a ser excluído. No formato: projects/{projectId}/databases/{databaseId}/documents/{document_path} .

Parâmetros de consulta

Parâmetros
currentDocument

object ( Precondition )

Uma pré-condição opcional no documento. A solicitação falhará se isso for definido e não for atendido pelo documento de destino.

Solicitar corpo

O corpo da solicitação deve estar vazio.

Corpo de resposta

Se for bem-sucedido, o corpo da resposta estará vazio.

Escopos de autorização

Requer um dos seguintes escopos OAuth:

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

Para obter mais informações, consulte Visão geral da autenticação .