Method: forecast.lookup

यह फ़ंक्शन किसी तय समयसीमा के दौरान, किसी जगह की एयर क्वालिटी का पूर्वानुमान दिखाता है.

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

POST https://airquality.googleapis.com/v1/forecast:lookup

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

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

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

JSON के काेड में दिखाना 
{
  "location": {
    object (LatLng)
  },
  "extraComputations": [
    enum (ExtraComputation)
  ],
  "uaqiColorPalette": enum (ColorPalette),
  "customLocalAqis": [
    {
      object (CustomLocalAqi)
    }
  ],
  "pageSize": integer,
  "pageToken": string,
  "dateTime": string,
  "period": {
    object (Interval)
  }
  // End of list of possible types for union field time_range.
  "universalAqi": boolean,
  "languageCode": string
}
फ़ील्ड
location

object (LatLng)

ज़रूरी है. वह अक्षांश और देशांतर जिसके लिए एपीआई, एयर क्वालिटी का डेटा खोजता है.
extraComputations[]

enum (ExtraComputation)

ज़रूरी नहीं. वैकल्पिक रूप से चालू की जा सकने वाली अन्य सुविधाएं. अतिरिक्त कंप्यूटेशन (हिसाब लगाना) तय करने पर, रिस्पॉन्स में काम के एलिमेंट और फ़ील्ड दिखाए जाएंगे.
uaqiColorPalette

enum (ColorPalette)

ज़रूरी नहीं. 'यूनिवर्सल एयर क्वालिटी इंडेक्स' से मिले डेटा के लिए इस्तेमाल किए जाने वाले रंग पटल को तय करता है (UAQI). यह कलर पटल सिर्फ़ UAQI के लिए काम का है. अन्य एक्यूआई, पहले से तय किए गए रंग पटल होते हैं. इन्हें कंट्रोल नहीं किया जा सकता.
customLocalAqis[]

object (CustomLocalAqi)

ज़रूरी नहीं. 'देश/इलाके के एक्यूआई' के बारे में बताता है संबंध. यह चुने गए एक्यूआई वाले देश/इलाके को जोड़ता है. इससे उस देश/इलाके के लिए ज़रूरी एयर क्वालिटी का डेटा, चुने गए एक्यूआई के हिसाब से दिखाया जाता है. इस पैरामीटर का इस्तेमाल, किसी देश के ऐसे एक्यूआई की जानकारी देने के लिए किया जा सकता है जो डिफ़ॉल्ट न हो. उदाहरण के लिए, कनाडा के डिफ़ॉल्ट इंडेक्स के बजाय, अमेरिका के ईपीए इंडेक्स का पता लगाने के लिए.
pageSize

integer

ज़रूरी नहीं. हर पेज पर, हर घंटे के हिसाब से दी जाने वाली जानकारी के रिकॉर्ड की ज़्यादा से ज़्यादा संख्या (डिफ़ॉल्ट = 24).
pageToken

string

ज़रूरी नहीं. पिछले पूर्वानुमान कॉल से मिला पेज टोकन. इसका इस्तेमाल, अगले पेज को वापस पाने के लिए किया जाता है.
dateTime

string (Timestamp format)

वह टाइमस्टैंप जिसमें किसी खास समय के लिए डेटा दिखाया जाता है. इसमें टाइमस्टैंप को पिछले घंटे के पूर्णांक में बदल दिया जाता है.

इससे सिर्फ़ अनुरोध किए गए टाइमस्टैंप के लिए, हर घंटे का डेटा दिखेगा (जैसे, हर घंटे की जानकारी देने वाला एलिमेंट). उदाहरण के लिए, जिस अनुरोध में dateTime पैरामीटर को 2023-01-03T11:05:49Z पर सेट किया गया है उसे बदलकर 2023-01-03T11:00:00Z कर दिया जाएगा.

ध्यान दें: अनुरोध में dateTime या startTime और endTime का इस्तेमाल किया जा सकता है.
period

object (Interval)

यह startTime और endTime अवधि के बारे में बताता है, जिसके लिए पूर्वानुमान का डेटा पाना है. endTime में बिना किसी भेदभाव के सभी लोग शामिल हो सकते हैं. इसमें टाइमस्टैंप को पिछले घंटे के पूर्णांक में बदल दिया जाता है.

ध्यान दें: अनुरोध में dateTime या startTime और endTime का इस्तेमाल किया जा सकता है.
universalAqi

boolean

ज़रूरी नहीं. अगर इसे 'सही है' पर सेट किया जाता है, तो यूनिवर्सल एक्यूआई को 'इंडेक्स' में शामिल किया जाएगा रिस्पॉन्स का फ़ील्ड (डिफ़ॉल्ट = सही).
languageCode

string

ज़रूरी नहीं. इससे क्लाइंट को जवाब के लिए भाषा चुनने की अनुमति मिलती है. अगर उस भाषा के लिए डेटा नहीं दिया जा सकता, तो एपीआई सबसे करीबी मिलान का इस्तेमाल करता है. अनुमति वाली वैल्यू, आईईटीएफ़ स्टैंडर्ड (डिफ़ॉल्ट = 'en') के हिसाब से होती हैं.

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

एयर क्वालिटी के अनुमान वाले एपीआई का रिस्पॉन्स ऑब्जेक्ट.

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

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

object (HourlyForecast)

ज़रूरी नहीं. इसमें, अनुरोध की गई सीमा में हर घंटे की एयर क्वालिटी की जानकारी होती है. उदाहरण के लिए, अगर 48 घंटों के पूर्वानुमान का अनुरोध किया गया है, तो हर घंटे के पूर्वानुमान के लिए 48 एलिमेंट होंगे.
regionCode

string

ज़रूरी नहीं. अनुरोध में दी गई जगह से जुड़े देश/इलाके का ISO_3166-1 alpha-2 कोड. अगर अनुरोध में दी गई जगह किसी विवादित देश/इलाके में है, तो इस फ़ील्ड को जवाब में शामिल नहीं किया जा सकता.
nextPageToken

string

ज़रूरी नहीं. अगला पेज वापस पाने के लिए टोकन.

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

नीचे दिए गए OAuth के लिंक की ज़रूरत हाेती है:

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

ज़्यादा जानकारी के लिए, OAuth 2.0 की खास जानकारी देखें.

HourlyForecast

इसमें, अनुरोध की गई सीमा में हर घंटे की एयर क्वालिटी की जानकारी होती है. उदाहरण के लिए, अगर 48 घंटों के पूर्वानुमान का अनुरोध किया गया है, तो हर घंटे के पूर्वानुमान के लिए 48 एलिमेंट होंगे.

JSON के काेड में दिखाना 
{
  "dateTime": string,
  "indexes": [
    {
      object (AirQualityIndex)
    }
  ],
  "pollutants": [
    {
      object (Pollutant)
    }
  ],
  "healthRecommendations": {
    object (HealthRecommendations)
  }
}
फ़ील्ड
dateTime

string (Timestamp format)

राउंड डाउन किया गया टाइमस्टैंप, जो RFC3339 यूटीसी "ज़ुलु" में डेटा के बताए गए समय (घंटे) को दिखाता है फ़ॉर्मैट. उदाहरण के लिए: "2014-10-02T15:00:00Z".
indexes[]

object (AirQualityIndex)

अनुरोध के पैरामीटर के आधार पर, इस सूची में ज़्यादा से ज़्यादा दो एयर क्वालिटी इंडेक्स शामिल होंगे:

  • यूनिवर्सल एक्यूआई. अगर universalAqi बूलियन को 'सही' पर सेट किया जाता है, तो गड़बड़ी का मैसेज दिखाया जाएगा.
  • लोकल एक्यूआई. अगर LOCAL_AQI की अतिरिक्त कंप्यूटेशन की जानकारी दी गई हो, तो नतीजे को लौटाया जाएगा.
pollutants[]

object (Pollutant)

प्रदूषण फैलाने वाले उन कॉम्पोनेंट की सूची जो अनुरोध में बताई गई जगह पर असर डालते हैं.

ध्यान दें: यह फ़ील्ड सिर्फ़ उन अनुरोधों के लिए लौटाया जाएगा जिन्होंने नीचे दिए गए अतिरिक्त कंप्यूटेशन या इनमें से किसी एक के बारे में बताया है: POLLUTANT_ADDITIONAL_INFO, DOMINANT_POLLUTANT_CONCENTRATION, POLLUTANT_CONCENTRATION.
healthRecommendations

object (HealthRecommendations)

एयर क्वालिटी की रिपोर्ट की गई स्थितियों के बारे में स्वास्थ्य से जुड़ी सलाह और कार्रवाइयों के सुझाव. जो लोग जोखिम में हैं, प्रदूषण फैलाने वाले कॉम्पोनेंट के प्रति ज़्यादा संवेदनशील ग्रुप, और सामान्य जनसंख्या के लिए, सुझाव अलग-अलग तरीके से दिखाए जाते हैं.