Method: projects.locations.list

उन जगहों की जानकारी देता है जहां इस सेवा का इस्तेमाल किया जा सकता है.

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

GET https://firestore.googleapis.com/v1/{name=projects/*}/locations

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

पाथ पैरामीटर

पैरामीटर
name

string

अगर लागू हो, तो वह संसाधन जिसके पास जगहों की जानकारी के कलेक्शन का मालिकाना हक है.

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

पैरामीटर
filter

string

किसी पसंदीदा सबसेट के लिए, नतीजों को कम करने का फ़िल्टर. फ़िल्टर करने वाली भाषा में, "displayName=tokyo" जैसी स्ट्रिंग इस्तेमाल की जा सकती हैं. साथ ही, इसके बारे में ज़्यादा जानकारी AIP-160 में देखी जा सकती है.
pageSize

integer

दिए जाने वाले नतीजों की ज़्यादा से ज़्यादा संख्या. अगर नीति को सेट नहीं किया जाता है, तो सेवा डिफ़ॉल्ट तौर पर चुनती है.
pageToken

string

जवाब के तौर पर, nextPageToken फ़ील्ड से पेज टोकन मिला है. अगला पेज पाने के लिए, उस पेज टोकन को भेजें.

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

अनुरोध का लेख खाली होना चाहिए.

जवाब का लेख

Locations.ListLocations के लिए जवाब का मैसेज.

अगर इंडेक्सिंग सही से हाे जाती है, ताे जवाब के लेख में नीचे दिए गए स्ट्रक्चर का डेटा शामिल होता है.

JSON के काेड में दिखाना 
{
  "locations": [
    {
      object (Location)
    }
  ],
  "nextPageToken": string
}
फ़ील्ड
locations[]

object (Location)

उन जगहों की सूची जो अनुरोध में दिए गए फ़िल्टर से मेल खाती है.
nextPageToken

string

'अगले पेज की सूची' का स्टैंडर्ड टोकन.

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

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

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

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