Method: projects.databases.documents.createDocument

新しいドキュメントを作成します。

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
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

詳細については、認証の概要をご覧ください。