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に対する相対的なコレクション ID。例: chatrooms

クエリパラメータ

パラメーター
documentId

string

このドキュメントに使用するクライアント割り当てのドキュメント ID。

オプション。指定しない場合、サービスによって ID が割り当てられます。

mask

object ( DocumentMask )

返されるフィールド。設定されていない場合は、すべてのフィールドを返します。

このマスクに存在しないフィールドがドキュメントにある場合、そのフィールドは応答で返されません。

リクエストボディ

リクエスト本文にはDocumentのインスタンスが含まれます。

レスポンスボディ

成功した場合、応答本文にはDocumentのインスタンスが含まれます。

認可範囲

次の OAuth スコープのいずれかが必要です。

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

詳細については、 「認証の概要」を参照してください。