Method: projects.databases.collectionGroups.fields.list

इस डेटाबेस के लिए फ़ील्ड कॉन्फ़िगरेशन और मेटाडेटा सूचीबद्ध करता है।

वर्तमान में, FirestoreAdmin.ListFields केवल उन लिस्टिंग फ़ील्ड का समर्थन करता है जिन्हें स्पष्ट रूप से ओवरराइड किया गया है। इस क्वेरी को जारी करने के लिए, indexConfig.usesAncestorConfig:false or ttlConfig:*` पर सेट फ़िल्टर के साथ FirestoreAdmin.ListFields कॉल करें।

HTTP अनुरोध

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

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

पथ पैरामीटर

पैरामीटर
parent

string

आवश्यक। फ़ॉर्म का मूल नाम projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId}

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

पैरामीटर
filter

string

सूची परिणामों पर लागू होने वाला फ़िल्टर. वर्तमान में, FirestoreAdmin.ListFields केवल उन लिस्टिंग फ़ील्ड का समर्थन करता है जिन्हें स्पष्ट रूप से ओवरराइड किया गया है। इस क्वेरी को जारी करने के लिए, FirestoreAdmin.ListFields एक फ़िल्टर के साथ कॉल करें जिसमें indexConfig.usesAncestorConfig:false शामिल है।

pageSize

integer

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

pageToken

string

एक पृष्ठ टोकन, जो पिछली कॉल से FirestoreAdmin.ListFields पर लौटाया गया था, जिसका उपयोग परिणामों का अगला पृष्ठ प्राप्त करने के लिए किया जा सकता है।

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

अनुरोध का मुख्य भाग खाली होना चाहिए.

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

FirestoreAdmin.ListFields के लिए प्रतिक्रिया।

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

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

object ( Field )

अनुरोधित फ़ील्ड.

nextPageToken

string

एक पेज टोकन जिसका उपयोग परिणामों के दूसरे पेज का अनुरोध करने के लिए किया जा सकता है। यदि रिक्त है, तो यह अंतिम पृष्ठ है।

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

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

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

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