Method: gauges.searchGaugesByArea

भौगोलिक क्षेत्र के हिसाब से गेज खोजें.

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

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

POST https://floodforecasting.googleapis.com/v1/gauges:searchGaugesByArea

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

अनुरोध का मुख्य हिस्सा

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

JSON के काेड में दिखाना 
{
  "pageSize": integer,
  "pageToken": string,

  // Union field search_by can be only one of the following:
  "regionCode": string,
  "loop": {
    object (Loop)
  }
  // End of list of possible types for union field search_by.
  "includeNonQualityVerified": boolean,
  "includeGaugesWithoutHydroModel": boolean
}
फ़ील्ड
pageSize

integer

ज़रूरी नहीं. ज़्यादा से ज़्यादा कितने गेज लौटाने हैं. ऐसा हो सकता है कि सेवा इस वैल्यू से कम नतीजे दिखाए. अगर इसकी जानकारी नहीं दी गई है, तो ज़्यादा से ज़्यादा 50,000 गेज दिखाए जाएंगे. ज़्यादा से ज़्यादा 50,000 वैल्यू डाली जा सकती हैं. इससे ज़्यादा वैल्यू डालने पर,उन्हें 50,000 में बदल दिया जाएगा.
pageToken

string

ज़रूरी नहीं. यह एक पेज टोकन है, जो पिछले SearchGauges कॉल से मिला था. अगला पेज पाने के लिए, यह जानकारी दें. पेज नंबर के हिसाब से डेटा दिखाने के दौरान, SearchGauges को दिए गए अन्य सभी पैरामीटर, पेज टोकन देने वाले कॉल से मेल खाने चाहिए.

यूनियन फ़ील्ड search_by.

search_by इनमें से सिर्फ़ एक हो सकता है:
regionCode

string

क्षेत्र के कोड के हिसाब से, किसी क्षेत्र में मौजूद सभी गेज खोजें. https://cldr.unicode.org/ (सूची https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry) का इस्तेमाल करें.
loop

object (Loop)

लूप में मौजूद सभी गेज खोजें. लूप एक सामान्य गोलाकार पॉलीगॉन होता है. इसके बारे में जानने के लिए, Loop देखें.
includeNonQualityVerified

boolean

ज़रूरी नहीं. उन गेज को नतीजे में शामिल करें जिनकी क्वालिटी की पुष्टि नहीं हुई है. कृपया इसका इस्तेमाल सावधानी से करें. डिफ़ॉल्ट रूप से, यह 'गलत' पर सेट होती है.
includeGaugesWithoutHydroModel

boolean

ज़रूरी नहीं. उन गेज के नतीजों में शामिल करें जिनमें Google का इन-हाउस हाइड्रोलॉजिकल मॉडल नहीं है. डिफ़ॉल्ट रूप से, यह 'गलत' पर सेट होती है.

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

gauges.searchGaugesByArea का जवाब.

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

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

object (Gauge)

अनुरोध किए गए इलाके में मौजूद गेज.
nextPageToken

string

ज़रूरी नहीं. यह एक ऐसा टोकन है जिसे pageToken के तौर पर भेजा जा सकता है, ताकि अगला पेज वापस पाया जा सके. अगर इस फ़ील्ड को खाली छोड़ा जाता है, तो इसके बाद कोई पेज नहीं होता.