Method: projects.databases.documents.patch

किसी दस्तावेज़ को अद्यतन या सम्मिलित करता है।

HTTP अनुरोध

PATCH https://firestore.googleapis.com/v1beta1/{document.name=projects/*/databases/*/documents/*/**}

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

पथ पैरामीटर

पैरामीटर
document.name

string

दस्तावेज़ का संसाधन नाम, उदाहरण के लिए projects/{projectId}/databases/{databaseId}/documents/{document_path}

क्वेरी पैरामीटर

पैरामीटर
updateMask

object ( DocumentMask )

अद्यतन करने के लिए फ़ील्ड. मास्क में किसी भी फ़ील्ड पथ में आरक्षित नाम नहीं हो सकता है।

यदि दस्तावेज़ सर्वर पर मौजूद है और मास्क में फ़ील्ड संदर्भित नहीं हैं, तो उन्हें अपरिवर्तित छोड़ दिया जाता है। मास्क में संदर्भित फ़ील्ड, लेकिन इनपुट दस्तावेज़ में मौजूद नहीं हैं, सर्वर पर दस्तावेज़ से हटा दिए जाते हैं।

mask

object ( DocumentMask )

लौटने के लिए खेत. यदि सेट नहीं है, तो सभी फ़ील्ड लौटाता है।

यदि दस्तावेज़ में कोई ऐसा फ़ील्ड है जो इस मास्क में मौजूद नहीं है, तो वह फ़ील्ड प्रतिक्रिया में वापस नहीं किया जाएगा।

currentDocument

object ( Precondition )

दस्तावेज़ पर एक वैकल्पिक पूर्व शर्त. यदि यह सेट है और लक्ष्य दस्तावेज़ द्वारा पूरा नहीं किया गया तो अनुरोध विफल हो जाएगा।

निकाय से अनुरोध करें

अनुरोध निकाय में Document का एक उदाहरण शामिल है।

प्रतिक्रिया निकाय

सफल होने पर, प्रतिक्रिया निकाय में Document का एक उदाहरण शामिल होता है।

प्राधिकरण के दायरे

निम्नलिखित OAuth स्कोप में से एक की आवश्यकता है:

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

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