Method: forecast.lookup

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

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

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

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

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

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

जेएसओएन के काेड में दिखाना 
{
  "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 के लिए काम का है, जबकि अन्य AQI में पहले से तय किए गए रंग पटल होते हैं, जिन्हें कंट्रोल नहीं किया जा सकता.
customLocalAqis[]

object (CustomLocalAqi)

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

integer

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

string

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

string (Timestamp format)

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

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

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

object (Interval)

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

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

boolean

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

string

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

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

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

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

जेएसओएन के काेड में दिखाना 
{
  "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 एलिमेंट होंगे.

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

string (Timestamp format)

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

object (AirQualityIndex)

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

  • यूनिवर्सल AQI. universalAqi बूलियन को सही पर सेट करने पर दिखाया जाएगा.
  • स्थानीय AQI. LOCAL_AQI अतिरिक्त कंप्यूटेशन के बताए गए तरीके के आधार पर नतीजे दिए जाएंगे.
pollutants[]

object (Pollutant)

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

ध्यान दें: यह फ़ील्ड सिर्फ़ उन अनुरोधों के लिए दिया जाएगा जिन्होंने आगे दी गई एक या ज़्यादा अतिरिक्त गणनाएं तय की हैं: POLLUTANT_ADDITIONAL_INFO, DOMINANT_POLLUTANT_CONCENTRATION, POLLUTANT_CONCENTRATION.
healthRecommendations

object (HealthRecommendations)

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