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}/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

有关详细信息,请参阅身份验证概述