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