Method: projects.databases.documents.patch

दस्तावेज़ को अपडेट करता है या डालता है.

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

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

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

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

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

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