Method: projects.databases.documents.get

एक ही दस्तावेज़ मिलता है.

HTTP अनुरोध

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

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

पथ पैरामीटर

पैरामीटर
name

string

आवश्यक। प्राप्त करने के लिए दस्तावेज़ का संसाधन नाम. प्रारूप में: projects/{projectId}/databases/{databaseId}/documents/{document_path}

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

पैरामीटर
mask

object ( DocumentMask )

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

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

यूनियन पैरामीटर consistency_selector । इस लेन-देन के लिए स्थिरता मोड. यदि सेट नहीं किया गया है, तो डिफॉल्ट मजबूत स्थिरता पर निर्भर करता है। consistency_selector निम्नलिखित में से केवल एक हो सकता है:
transaction

string ( bytes format)

लेन-देन में दस्तावेज़ को पढ़ता है।

एक बेस64-एन्कोडेड स्ट्रिंग।

readTime

string ( Timestamp format)

दिए गए समय पर दस्तावेज़ का संस्करण पढ़ता है।

यह पिछले एक घंटे के भीतर एक माइक्रोसेकंड सटीक टाइमस्टैम्प होना चाहिए, या यदि पॉइंट-इन-टाइम रिकवरी सक्षम है, तो यह पिछले 7 दिनों के भीतर एक पूरे मिनट का टाइमस्टैम्प भी हो सकता है।

RFC3339 UTC "ज़ुलु" प्रारूप में एक टाइमस्टैम्प, नैनोसेकंड रिज़ॉल्यूशन और नौ भिन्नात्मक अंकों तक। उदाहरण: "2014-10-02T15:01:23Z" और "2014-10-02T15:01:23.045123456Z"

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

अनुरोध का मुख्य भाग खाली होना चाहिए.

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

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

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

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

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

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