Method: projects.databases.documents.createDocument

建立新文件。

HTTP 要求

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

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
parent

string

執行個體類型,父項資源。例如 projects/{projectId}/databases/{databaseId}/documentsprojects/{projectId}/databases/{databaseId}/documents/chatrooms/{chatroom_id}

collectionId

string

執行個體類型,要清單的集合 ID (相對於 parent)。例如:chatrooms

查詢參數

參數
documentId

string

要用於這份文件的用戶端指派文件 ID。

選用設定。如未指定,服務會指派 ID。

mask

object (DocumentMask)

要傳回的欄位。如未設定,則會傳回所有欄位。

如果文件的某個欄位不在這個遮罩中,則不會在回應中傳回該欄位。

要求主體

要求主體包含 Document 的執行個體。

回應主體

如果成功,回應主體會包含 Document 的執行個體。

授權範圍

需要下列其中一種 OAuth 範圍:

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

詳情請參閱驗證總覽