Google अश्वेत समुदायों के लिए नस्लीय इक्विटी को आगे बढ़ाने के लिए प्रतिबद्ध है। देखो कैसे।
इस पेज का अनुवाद Cloud Translation API से किया गया है.
Switch to English

विधि: Projects.dat डेटाबेस.documents.batchGet

कई दस्तावेज मिलते हैं।

इस विधि द्वारा लौटाए गए दस्तावेज़ों को उसी क्रम में वापस करने की गारंटी नहीं है, जिस क्रम में उनसे अनुरोध किया गया था।

HTTP अनुरोध

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

URL gRPC ट्रांसकोडिंग सिंटैक्स का उपयोग करता है।

पथ पैरामीटर

पैरामीटर
database

string

आवश्यक है। डेटाबेस का नाम। प्रारूप में: projects/{project_id}/databases/{database_id}

शरीर का अनुरोध करें

अनुरोध निकाय में निम्न संरचना वाला डेटा है:

JSON प्रतिनिधित्व
 {
  "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/{project_id}/databases/{database_id}/documents/{document_path} । यदि कोई भी दस्तावेज़ दिए गए database का बाल संसाधन नहीं है, तो अनुरोध विफल हो जाएगा। डुप्लीकेट नामों को खत्म कर दिया जाएगा।

mask

object ( DocumentMask )

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

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

संघ क्षेत्र consistency_selector । इस लेनदेन के लिए स्थिरता मोड। यदि सेट नहीं है, तो मजबूत स्थिरता के लिए चूक। consistency_selector निम्नलिखित में से केवल एक हो सकता है:
transaction

string ( bytes format)

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

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

newTransaction

object ( TransactionOptions )

एक नया लेनदेन शुरू करता है और दस्तावेजों को पढ़ता है। केवल-पढ़ने के लिए लेन-देन में कमी। नई ट्रांजेक्शन आईडी स्ट्रीम में पहली प्रतिक्रिया के रूप में वापस आ जाएगी।

readTime

string ( Timestamp format)

दस्तावेजों को पढ़ता है क्योंकि वे दिए गए समय पर थे। यह 270 सेकंड से अधिक पुराना नहीं हो सकता है।

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

प्रतिक्रिया शरीर

यदि सफल हो, तो प्रतिक्रिया निकाय में निम्न संरचना वाला डेटा होता है:

Firestore.BatchGetDocuments लिए स्ट्रीम की गई प्रतिक्रिया।

JSON प्रतिनिधित्व
 {
  "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 अनुरोध में सेट किया गया था।

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

readTime

string ( Timestamp format)

जिस समय दस्तावेज़ पढ़ा गया था। यह मोनोटिक रूप से बढ़ सकता है, इस मामले में परिणाम स्ट्रीम में पिछले दस्तावेज़ों को उनके रीडटाइम और इस एक के बीच नहीं बदलने की गारंटी है।

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

संघ क्षेत्र का result एक एकल परिणाम। यह खाली हो सकता है यदि सर्वर सिर्फ एक लेनदेन वापस कर रहा है। result केवल निम्न में से एक हो सकता है:
found

object ( Document )

एक दस्तावेज़ जो अनुरोध किया गया था।

missing

string

एक दस्तावेज़ नाम जो अनुरोध किया गया था लेकिन मौजूद नहीं है। प्रारूप में: projects/{project_id}/databases/{database_id}/documents/{document_path}

प्राधिकरण स्कोप्स

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

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

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