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

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

दस्तावेज सूचीबद्ध करता है।

HTTP अनुरोध

GET https://firestore.googleapis.com/v1/{parent=projects/*/databases/*/documents/*/**}/{collectionId}

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

पथ पैरामीटर

पैरामीटर
parent

string

आवश्यक है। मूल संसाधन नाम। प्रारूप में: projects/{project_id}/databases/{database_id}/documents या projects/{project_id}/databases/{database_id}/documents/{document_path} । उदाहरण के लिए: projects/my-project/databases/my-database/documents या projects/my-project/databases/my-database/documents/chatrooms/my-chatroom

collectionId

string

आवश्यक है। सूची के लिए parent सापेक्ष संग्रह आईडी। उदाहरण के लिए: chatrooms या messages

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

पैरामीटर
pageSize

integer

लौटने के लिए दस्तावेजों की अधिकतम संख्या।

pageToken

string

यदि कोई हो, तो nextPageToken मान पिछले सूची अनुरोध से वापस आ गया।

orderBy

string

द्वारा परिणामों को क्रमबद्ध करने का आदेश। उदाहरण के लिए: priority desc, name

mask

object ( DocumentMask )

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

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

showMissing

boolean

यदि सूची में लापता दस्तावेज दिखाना चाहिए। गुम दस्तावेज़ एक दस्तावेज़ है जो मौजूद नहीं है लेकिन उप-दस्तावेज़ हैं। ये दस्तावेज़ एक कुंजी के साथ वापस आ जाएंगे, लेकिन फ़ील्ड, Document.create_time , या Document.update_time सेट नहीं होंगे।

showMissing साथ अनुरोध निर्दिष्ट नहीं कर सकते हैं where या orderBy

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

string ( bytes format)

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

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

readTime

string ( Timestamp format)

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

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

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

अनुरोध निकाय रिक्त होना चाहिए।

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

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

Firestore.ListDocuments लिए प्रतिक्रिया।

JSON प्रतिनिधित्व
 {
  "documents" :  [
    {
      object ( Document )
    }
  ] ,
  "nextPageToken" :  string
} 
खेत
documents[]

object ( Document )

दस्तावेज मिले।

nextPageToken

string

अगला पेज टोकन

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

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

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

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