एक दस्तावेज़ मिलता है.
एचटीटीपी अनुरोध
GET https://firestore.googleapis.com/v1/{name=projects/*/databases/*/documents/*/**}
यह यूआरएल gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल करता है.
पाथ पैरामीटर
| पैरामीटर | |
|---|---|
name |
ज़रूरी है. मिलने वाले दस्तावेज़ का संसाधन नाम. फ़ॉर्मैट: |
क्वेरी पैरामीटर
| पैरामीटर | |
|---|---|
mask |
लौटाए जाने वाले फ़ील्ड. अगर यह नीति सेट नहीं है, तो सभी फ़ील्ड दिखाता है. अगर दस्तावेज़ में कोई ऐसा फ़ील्ड है जो इस मास्क में मौजूद नहीं है, तो वह फ़ील्ड जवाब में नहीं लौटाया जाएगा. |
यूनियन पैरामीटर consistency_selector. इस लेन-देन के लिए कंसिस्टेंसी मोड. इस नीति को सेट न करने पर, डिफ़ॉल्ट रूप से एक जैसा अनुभव मिलता है. consistency_selector इनमें से सिर्फ़ एक हो सकता है: |
|
transaction |
लेन-देन के दस्तावेज़ को पढ़ता है. base64 कोड में बदली गई स्ट्रिंग. |
readTime |
दिए गए समय पर दस्तावेज़ के वर्शन को पढ़ता है. यह पिछले एक घंटे के अंदर का सटीक टाइमस्टैंप होना चाहिए या अगर पॉइंट-इन-टाइम रिकवरी चालू है, तो यह पिछले सात दिनों में पूरे मिनट का टाइमस्टैंप भी हो सकता है. आरएफ़सी3339 यूटीसी के "ज़ुलू" फ़ॉर्मैट में एक टाइमस्टैंप, जिसमें नैनोसेकंड रिज़ॉल्यूशन और ज़्यादा से ज़्यादा नौ फ़्रैक्शनल अंक हैं. उदाहरण: |
अनुरोध का मुख्य भाग
अनुरोध का लेख खाली होना चाहिए.
जवाब का लेख
कामयाब होने पर, जवाब के मुख्य हिस्से में Document का एक इंस्टेंस शामिल होता है.
अनुमति के दायरे
इनमें से किसी एक OAuth स्कोप की ज़रूरत होती है:
https://www.googleapis.com/auth/datastorehttps://www.googleapis.com/auth/cloud-platform
ज़्यादा जानकारी के लिए, पुष्टि करने से जुड़ी खास जानकारी देखें.