Method: projects.databases.documents.delete

Exclui um documento.

Solicitação HTTP

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

O URL usa a 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. Use o formato: projects/{projectId}/databases/{databaseId}/documents/{document_path}.

Parâmetros de consulta

Parâmetros
currentDocument

object (Precondition)

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

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Se a solicitação for concluída, o corpo da resposta estará vazio.

Escopos de autorização

Requer um dos seguintes escopos de OAuth:

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

Para saber mais, consulte a Visão geral da autenticação.