Method: projects.databases.documents.createDocument

एक नया दस्तावेज़ बनाता है.

HTTP अनुरोध

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

यूआरएल जीआरपीसी ट्रांसकोडिंग सिंटैक्स का उपयोग करता है।

पथ पैरामीटर

पैरामीटर
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

अधिक जानकारी के लिए, प्रमाणीकरण अवलोकन देखें।