Method: projects.databases.documents.delete

ลบเอกสาร

คำขอ HTTP

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

URL ใช้ไวยากรณ์การแปลง 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

ดูข้อมูลเพิ่มเติมได้ที่ภาพรวมการตรวจสอบสิทธิ์