Method: projects.databases.documents.delete

删除文档。

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数
name

string

必需。要删除的文档的资源名称。格式为：projects/{projectId}/databases/{databaseId}/documents/{document_path}。

查询参数

参数
currentDocument

object (Precondition)

文档的可选前提条件。如果已设置此属性，但目标文档未满足此要求，则请求将失败。

请求正文

请求正文必须为空。

响应正文

如果成功，则响应正文为空。

授权范围

需要以下 OAuth 范围之一：

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

如需了解详情，请参阅身份验证概览。