Method: projects.databases.documents.createDocument

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

एचटीटीपी अनुरोध

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

यह यूआरएल gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल करता है.

पाथ के पैरामीटर

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

ज़्यादा जानकारी के लिए, पुष्टि करने से जुड़ी खास जानकारी देखें.