Method: history.lookup

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

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

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

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

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

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

जेएसओएन के काेड में दिखाना
{
  "pageSize": integer,
  "pageToken": string,
  "location": {
    object (LatLng)
  },
  "extraComputations": [
    enum (ExtraComputation)
  ],
  "uaqiColorPalette": enum (ColorPalette),
  "customLocalAqis": [
    {
      object (CustomLocalAqi)
    }
  ],

  // Union field time_range can be only one of the following:
  "dateTime": string,
  "hours": integer,
  "period": {
    object (Interval)
  }
  // End of list of possible types for union field time_range.
  "universalAqi": boolean,
  "languageCode": string
}
फ़ील्ड
pageSize

integer

ज़रूरी नहीं. हर पेज के हिसाब से, हर घंटे की जाने वाली जानकारी रिकॉर्ड करने की ज़्यादा से ज़्यादा संख्या. डिफ़ॉल्ट वैल्यू 72 है और ज़्यादा से ज़्यादा वैल्यू 168 (सात दिनों का डेटा) है.

pageToken

string

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

ध्यान दें कि इस पैरामीटर के लिए वैल्यू देते समय, दिए गए अन्य सभी पैरामीटर को उस कॉल से मैच होना चाहिए जिसने पेज टोकन (पिछला कॉल) दिया था.

location

object (LatLng)

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

extraComputations[]

enum (ExtraComputation)

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

uaqiColorPalette

enum (ColorPalette)

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

customLocalAqis[]

object (CustomLocalAqi)

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

यूनियन फ़ील्ड time_range. वह समयसीमा जिसमें एयर क्वालिटी का डेटा ज़रूरी है. किसी समय सीमा से संबंधित फ़ील्ड को तय न कर पाने पर, एक INVALID_VERSION गड़बड़ी दिखाई देगी. time_range इनमें से सिर्फ़ एक हो सकती है: time_range इनमें से सिर्फ़ एक हो सकती है:
dateTime

string (Timestamp format)

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

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

RFC3339 यूटीसी "ज़ुलु" फ़ॉर्मैट में एक टाइमस्टैंप, जिसमें नैनोसेकंड रिज़ॉल्यूशन और नौ फ़्रैक्शनल अंक तक हो सकते हैं. उदाहरण: "2014-10-02T15:01:23Z" और "2014-10-02T15:01:23.045123456Z".

hours

integer

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

period

object (Interval)

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

universalAqi

boolean

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

languageCode

string

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

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

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

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

object (HourInfo)

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

regionCode

string

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

nextPageToken

string

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

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

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

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

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

इंटरवल

यह एक टाइम इंटरवल को दिखाता है. इसे टाइमस्टैंप की शुरुआत (शामिल) और खत्म होने के टाइमस्टैंप (खास तौर पर) के तौर पर एन्कोड किया जाता है.

प्रारंभ अंत से कम या उसके बराबर होना चाहिए. जब शुरुआत के अंत के बराबर हो, तो इंटरवल खाली होता है (समय से मेल नहीं खाता). जब शुरू और खत्म, दोनों की जानकारी नहीं दी जाती है, तो इंटरवल किसी भी समय से मेल खाता है.

जेएसओएन के काेड में दिखाना
{
  "startTime": string,
  "endTime": string
}
फ़ील्ड
startTime

string (Timestamp format)

ज़रूरी नहीं. अंतराल की शुरुआत शामिल है.

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

endTime

string (Timestamp format)

ज़रूरी नहीं. इंटरवल का खास खत्म होना.

अगर बताया गया है, तो इस अंतराल से मेल खाने वाला टाइमस्टैंप, खत्म होने से पहले का होना चाहिए.

HourInfo

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

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

string (Timestamp format)

राउंड डाउन करने का टाइमस्टैंप, जिससे पता चलता है कि डेटा, RFC3339 यूटीसी "ज़ुलु" फ़ॉर्मैट में है. इसमें नैनोसेकंड रिज़ॉल्यूशन और नौ फ़्रैक्शनल अंक हो सकते हैं. उदाहरण के लिए: "2014-10-02T15:00:00Z".

indexes[]

object (AirQualityIndex)

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

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

object (Pollutant)

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

healthRecommendations

object (HealthRecommendations)

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