Method: projects.databases.documents.listCollectionIds

किसी दस्तावेज़ के नीचे सभी संग्रह आईडी सूचीबद्ध करता है।

HTTP अनुरोध

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

यूआरएल जीआरपीसी ट्रांसकोडिंग सिंटैक्स का उपयोग करता है।

पथ पैरामीटर

पैरामीटर
parent

string

आवश्यक। मूल दस्तावेज़. प्रारूप में: projects/{projectId}/databases/{databaseId}/documents/{document_path} उदाहरण के लिए: projects/my-project/databases/my-database/documents/chatrooms/my-chatroom

निकाय से अनुरोध करें

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

JSON प्रतिनिधित्व
{
  "pageSize": integer,
  "pageToken": string,

  // Union field consistency_selector can be only one of the following:
  "readTime": string
  // End of list of possible types for union field consistency_selector.
}
खेत
pageSize

integer

वापस आने वाले परिणामों की अधिकतम संख्या.

pageToken

string

एक पेज टोकन. ListCollectionIdsResponse से एक मान होना चाहिए।

यूनियन फ़ील्ड consistency_selector । इस अनुरोध के लिए संगति मोड. यदि सेट नहीं किया गया है, तो डिफॉल्ट मजबूत स्थिरता पर निर्भर करता है। consistency_selector निम्नलिखित में से केवल एक हो सकता है:
readTime

string ( Timestamp format)

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

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

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

प्रतिक्रिया निकाय

Firestore.ListCollectionIds से प्रतिक्रिया।

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

JSON प्रतिनिधित्व
{
  "collectionIds": [
    string
  ],
  "nextPageToken": string
}
खेत
collectionIds[]

string

संग्रह आईडी.

nextPageToken

string

एक पेज टोकन जिसका उपयोग सूची जारी रखने के लिए किया जा सकता है।

प्राधिकरण के दायरे

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

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

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