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 के लिए जवाब.

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

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

object (Location)

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

string

स्टैंडर्ड लिस्ट नेक्स्ट-पेज टोकन.

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

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

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

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