Method: projects.databases.collectionGroups.fields.list

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

फ़िलहाल, FirestoreAdmin.ListFields सिर्फ़ उन लिस्टिंग फ़ील्ड के साथ काम करता है जिन्हें साफ़ तौर पर बदल दिया गया है. यह क्वेरी जारी करने के लिए, indexConfig.usesAncestorConfig:false पर सेट किए गए फ़िल्टर के साथ FirestoreAdmin.ListFields को कॉल करें.

एचटीटीपी अनुरोध

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

यह यूआरएल gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल करता है.

पाथ के पैरामीटर

पैरामीटर
parent

string

projects/{projectId}/databases/{databaseId}/collectionGroups/{collectionId} फ़ॉर्म के पैरंट का नाम

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

पैरामीटर
filter

string

सूची के नतीजों पर लागू करने के लिए फ़िल्टर. फ़िलहाल, FirestoreAdmin.ListFields सिर्फ़ उन लिस्टिंग फ़ील्ड के साथ काम करता है जिन्हें साफ़ तौर पर बदल दिया गया है. यह क्वेरी जारी करने के लिए, indexConfig.usesAncestorConfig:false पर सेट किए गए फ़िल्टर के साथ FirestoreAdmin.ListFields को कॉल करें.
pageSize

integer

दिखाए जाने वाले नतीजों की संख्या.
pageToken

string

FirestoreAdmin.ListFields को किए गए पिछले कॉल से लौटाया गया पेज टोकन, जिसका इस्तेमाल नतीजों का अगला पेज पाने के लिए किया जा सकता है.

अनुरोध का मुख्य भाग

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

जवाब का मुख्य भाग

FirestoreAdmin.ListFields के लिए रिस्पॉन्स.

अगर एपीआई सही से जुड़ जाता है, ताे जवाब के मुख्य भाग में नीचे दिए गए स्ट्रक्चर शामिल होता है.

जेएसओएन के काेड में दिखाना 
{
  "fields": [
    {
      object (Field)
    }
  ],
  "nextPageToken": string
}
फ़ील्ड
fields[]

object (Field)

अनुरोध किए गए फ़ील्ड.
nextPageToken

string

एक पेज टोकन, जिसका इस्तेमाल नतीजों के किसी दूसरे पेज का अनुरोध करने के लिए किया जा सकता है. अगर खाली है, तो यह आखिरी पेज है.

अनुमति के दायरे

इनमें से किसी एक OAuth दायरों की ज़रूरत होती है:

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

ज़्यादा जानकारी के लिए, पुष्टि करने से जुड़ी खास जानकारी देखें.