Method: projects.databases.documents.patch

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

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

PATCH https://firestore.googleapis.com/v1/{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

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