Method: projects.databases.documents.createDocument

สร้างเอกสารใหม่

คำขอ HTTP

POST https://firestore.googleapis.com/v1beta1/{parent=projects/*/databases/*/documents/**}/{collectionId}

URL ใช้ไวยากรณ์การแปลง gRPC

พารามิเตอร์เส้นทาง

พารามิเตอร์
parent

string

ต้องระบุ ทรัพยากรระดับบนสุด เช่น projects/{projectId}/databases/{databaseId}/documents หรือ projects/{projectId}/databases/{databaseId}/documents/chatrooms/{chatroom_id}

collectionId

string

ต้องระบุ รหัสคอลเล็กชันที่สัมพันธ์กับ parent กับรายการ เช่น chatrooms

พารามิเตอร์การค้นหา

พารามิเตอร์
documentId

string

รหัสเอกสารที่ลูกค้ากำหนดที่จะใช้กับเอกสารนี้

ไม่บังคับ หากไม่ได้ระบุ บริการจะกำหนดรหัสให้

mask

object (DocumentMask)

ช่องที่จะแสดงผล หากไม่ได้ตั้งค่า ระบบจะแสดงฟิลด์ทั้งหมด

หากเอกสารมีช่องที่ไม่ได้อยู่ในมาสก์นี้ ระบบจะไม่แสดงช่องนั้นในคำตอบ

เนื้อหาของคำขอ

เนื้อความของคำขอมีอินสแตนซ์ของ Document

เนื้อหาการตอบกลับ

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีอินสแตนซ์ Document

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth อย่างใดอย่างหนึ่งต่อไปนี้

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

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