Method: projects.databases.documents.batchGet

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

इस बात की कोई गारंटी नहीं है कि दस्तावेज़ उसी क्रम में दिखेंगे जैसे उन्हें दिखाने का अनुरोध किया गया था.

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

POST https://firestore.googleapis.com/v1beta1/{database=projects/*/databases/*}/documents:batchGet

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

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

पैरामीटर
database

string

ज़रूरी है. डेटाबेस का नाम. फ़ॉर्मैट: projects/{projectId}/databases/{databaseId}.

अनुरोध का मुख्य भाग

अनुरोध के मुख्य हिस्से में, इस तरह का डेटा शामिल होता है:

जेएसओएन के काेड में दिखाना 
{
  "documents": [
    string
  ],
  "mask": {
    object (DocumentMask)
  },

  // Union field consistency_selector can be only one of the following:
  "transaction": string,
  "newTransaction": {
    object (TransactionOptions)
  },
  "readTime": string
  // End of list of possible types for union field consistency_selector.
}
फ़ील्ड
documents[]

string

उन दस्तावेज़ों के नाम जिन्हें फिर से हासिल करना है. फ़ॉर्मैट: projects/{projectId}/databases/{databaseId}/documents/{document_path}. अगर कोई भी दस्तावेज़ दिए गए database का चाइल्ड रिसॉर्स नहीं है, तो अनुरोध रद्द कर दिया जाएगा. डुप्लीकेट नामों को हटा दिया जाएगा.
mask

object (DocumentMask)

लौटाए जाने वाले फ़ील्ड. अगर यह नीति सेट नहीं है, तो सभी फ़ील्ड दिखाता है.

अगर किसी दस्तावेज़ में ऐसा फ़ील्ड है जो इस मास्क में मौजूद नहीं है, तो जवाब में वह फ़ील्ड नहीं दिखेगा.
यूनियन फ़ील्ड consistency_selector. इस लेन-देन के लिए अनुकूलता मोड. अगर यह नीति सेट नहीं है, तो डिफ़ॉल्ट रूप से अच्छी कंसिस्टेंसी होती है. consistency_selector इनमें से सिर्फ़ एक हो सकती है:
transaction

string (bytes format)

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

base64 कोड में बदली गई स्ट्रिंग.
newTransaction

object (TransactionOptions)

नया लेन-देन शुरू करता है और दस्तावेज़ों को पढ़ता है. डिफ़ॉल्ट तौर पर, यह लेन-देन सिर्फ़ पढ़ने के लिए होता है. नया लेन-देन आईडी, स्ट्रीम में पहले जवाब के तौर पर दिखाया जाएगा.
readTime

string (Timestamp format)

दस्तावेज़ों को उसी समय पढ़ता है जैसे वे दिए गए समय पर थे.

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

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

जवाब का मुख्य भाग

Firestore.BatchGetDocuments के लिए स्ट्रीम किया गया जवाब.

अगर एपीआई सही से जुड़ जाता है, ताे जवाब के मुख्य भाग में नीचे दिए गए स्ट्रक्चर शामिल होता है.

जेएसओएन के काेड में दिखाना 
{
  "transaction": string,
  "readTime": string,

  // Union field result can be only one of the following:
  "found": {
    object (Document)
  },
  "missing": string
  // End of list of possible types for union field result.
}
फ़ील्ड
transaction

string (bytes format)

वह लेन-देन, जो इस अनुरोध के तहत शुरू किया गया था. सिर्फ़ पहले जवाब में सेट की जाएगी और सिर्फ़ तब सेट की जाएगी, जब अनुरोध में BatchGetDocumentsRequest.new_transaction को सेट किया गया हो.

base64 कोड में बदली गई स्ट्रिंग.
readTime

string (Timestamp format)

दस्तावेज़ को पढ़े जाने का समय. ऐसा हो सकता है कि यह बढ़ोतरी एक बार में हो. इस वजह से, नतीजे स्ट्रीम में पिछले दस्तावेज़ के लिए, यह गारंटी दी जा सकती है कि उनके ReadTime और इस दस्तावेज़ के बीच कोई बदलाव नहीं होगा.

RFC3339 यूटीसी "ज़ुलु" फ़ॉर्मैट में एक टाइमस्टैंप, जिसमें नैनोसेकंड का रिज़ॉल्यूशन और नौ फ़्रैक्शनल अंक हो सकते हैं. उदाहरण: "2014-10-02T15:01:23Z" और "2014-10-02T15:01:23.045123456Z".
यूनियन फ़ील्ड result. कोई एक नतीजा. अगर सर्वर सिर्फ़ ट्रांज़ैक्शन लौटा रहा है, तो यह फ़ील्ड खाली हो सकता है. result इनमें से सिर्फ़ एक हो सकती है:
found

object (Document)

अनुरोध किया गया दस्तावेज़.
missing

string

दस्तावेज़ का वह नाम है जिसका अनुरोध किया गया था, लेकिन वह मौजूद नहीं है. फ़ॉर्मैट: projects/{projectId}/databases/{databaseId}/documents/{document_path}.

अनुमति के दायरे

इनमें से किसी एक OAuth दायरों की ज़रूरत होती है:

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

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