किसी दस्तावेज़ के नीचे सभी संग्रह आईडी सूचीबद्ध करता है।
HTTP अनुरोध
POST https://firestore.googleapis.com/v1beta1/{parent=projects/*/databases/*/documents}:listCollectionIds
यूआरएल जीआरपीसी ट्रांसकोडिंग सिंटैक्स का उपयोग करता है।
पथ पैरामीटर
पैरामीटर | |
---|---|
parent | आवश्यक। मूल दस्तावेज़. प्रारूप में: |
निकाय से अनुरोध करें
अनुरोध निकाय में निम्नलिखित संरचना वाला डेटा शामिल है:
JSON प्रतिनिधित्व |
---|
{ "pageSize": integer, "pageToken": string, // Union field |
खेत | |
---|---|
pageSize | वापस आने वाले परिणामों की अधिकतम संख्या. |
pageToken | एक पेज टोकन. |
यूनियन फ़ील्ड consistency_selector । इस अनुरोध के लिए संगति मोड. यदि सेट नहीं किया गया है, तो डिफॉल्ट मजबूत स्थिरता पर निर्भर करता है। consistency_selector निम्नलिखित में से केवल एक हो सकता है: | |
readTime | दस्तावेज़ों को वैसे ही पढ़ता है जैसे वे दिए गए समय पर थे। यह पिछले एक घंटे के भीतर एक माइक्रोसेकंड सटीक टाइमस्टैम्प होना चाहिए, या यदि पॉइंट-इन-टाइम रिकवरी सक्षम है, तो यह पिछले 7 दिनों के भीतर एक पूरे मिनट का टाइमस्टैम्प भी हो सकता है। RFC3339 UTC "ज़ुलु" प्रारूप में एक टाइमस्टैम्प, नैनोसेकंड रिज़ॉल्यूशन और नौ भिन्नात्मक अंकों तक। उदाहरण: |
प्रतिक्रिया निकाय
Firestore.ListCollectionIds
से प्रतिक्रिया।
सफल होने पर, प्रतिक्रिया निकाय में निम्नलिखित संरचना वाला डेटा शामिल होता है:
JSON प्रतिनिधित्व |
---|
{ "collectionIds": [ string ], "nextPageToken": string } |
खेत | |
---|---|
collectionIds[] | संग्रह आईडी. |
nextPageToken | एक पेज टोकन जिसका उपयोग सूची जारी रखने के लिए किया जा सकता है। |
प्राधिकरण के दायरे
निम्नलिखित OAuth स्कोप में से एक की आवश्यकता है:
-
https://www.googleapis.com/auth/datastore
-
https://www.googleapis.com/auth/cloud-platform
अधिक जानकारी के लिए, प्रमाणीकरण अवलोकन देखें।