यह फ़ंक्शन किसी चुनी गई समयसीमा के दौरान, किसी जगह की एयर क्वालिटी का इतिहास दिखाता है.
एचटीटीपी अनुरोध
POST https://airquality.googleapis.com/v1/history:lookup
यह यूआरएल gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल करता है.
अनुरोध का मुख्य भाग
अनुरोध के मुख्य हिस्से में, यहां दिए गए स्ट्रक्चर का डेटा शामिल होता है:
JSON के काेड में दिखाना |
---|
{ "pageSize": integer, "pageToken": string, "location": { object ( |
फ़ील्ड | |
---|---|
pageSize |
ज़रूरी नहीं. हर पेज पर घंटे के हिसाब से दिखने वाली जानकारी के रिकॉर्ड की ज़्यादा से ज़्यादा संख्या. डिफ़ॉल्ट सीमा 72 है और ज़्यादा से ज़्यादा वैल्यू 168 है (7 दिनों का डेटा). |
pageToken |
ज़रूरी नहीं. पिछले इतिहास कॉल से मिला पेज टोकन. इसका इस्तेमाल, अगले पेज को वापस पाने के लिए किया जाता है. ध्यान दें कि इस पैरामीटर के लिए वैल्यू देते समय, दिए गए अन्य सभी पैरामीटर, पेज टोकन देने वाले कॉल (पिछला कॉल) से मैच होने चाहिए. |
location |
ज़रूरी है. वह अक्षांश और देशांतर जिसके लिए एपीआई, एयर क्वालिटी से जुड़ी पिछली जानकारी का डेटा खोजता है. |
extraComputations[] |
ज़रूरी नहीं. वैकल्पिक रूप से चालू की जा सकने वाली अन्य सुविधाएं. अतिरिक्त कंप्यूटेशन (हिसाब लगाना) तय करने पर, रिस्पॉन्स में काम के एलिमेंट और फ़ील्ड दिखाए जाएंगे. |
uaqiColorPalette |
ज़रूरी नहीं. 'यूनिवर्सल एयर क्वालिटी इंडेक्स' से मिले डेटा के लिए इस्तेमाल किए जाने वाले रंग पटल को तय करता है (UAQI). यह कलर पटल सिर्फ़ UAQI के लिए काम का है. अन्य एक्यूआई, पहले से तय किए गए रंग पटल होते हैं. इन्हें कंट्रोल नहीं किया जा सकता. |
customLocalAqis[] |
ज़रूरी नहीं. 'देश/इलाके के एक्यूआई' के बारे में बताता है संबंध. यह चुने गए एक्यूआई वाले देश/इलाके को जोड़ता है. इससे उस देश/इलाके के लिए ज़रूरी एयर क्वालिटी का डेटा, चुने गए एक्यूआई के हिसाब से दिखाया जाता है. इस पैरामीटर का इस्तेमाल, किसी देश के ऐसे एक्यूआई की जानकारी देने के लिए किया जा सकता है जो डिफ़ॉल्ट न हो. उदाहरण के लिए, कनाडा के डिफ़ॉल्ट इंडेक्स के बजाय, अमेरिका के ईपीए इंडेक्स का पता लगाने के लिए. |
dateTime |
वह टाइमस्टैंप जिसके लिए आपको पुराना डेटा दिखाना है. इसमें टाइमस्टैंप को पिछले घंटे के पूर्णांक में बदल दिया जाता है. ध्यान दें: यह सिर्फ़ अनुरोध किए गए टाइमस्टैंप के लिए, हर घंटे का डेटा दिखाएगा (जैसे, हर घंटे की जानकारी देने वाला एलिमेंट). उदाहरण के लिए, जिस अनुरोध में dateTime पैरामीटर को 2023-01-03T11:05:49Z पर सेट किया गया है उसे बदलकर 2023-01-03T11:00:00Z कर दिया जाएगा. आरएफ़सी3339 यूटीसी "ज़ुलु" में टाइमस्टैंप फ़ॉर्मैट, नैनोसेकंड रिज़ॉल्यूशन और ज़्यादा से ज़्यादा नौ फ़्रैक्शनल अंकों के साथ हो सकता है. उदाहरण: "2014-10-02T15:01:23Z" और "2014-10-02T15:01:23.045123456Z". ध्यान दें: अनुरोध में |
hours |
1 से 720 तक की संख्या, जो अनुरोध की घंटों की सीमा को दिखाती है. उदाहरण के लिए: अगर वैल्यू 48 है, तो आपको पिछले 48 घंटों का डेटा मिलेगा. |
period |
यह ध्यान दें: अनुरोध में |
universalAqi |
ज़रूरी नहीं. अगर इसे 'सही है' पर सेट किया जाता है, तो यूनिवर्सल एक्यूआई को 'इंडेक्स' में शामिल किया जाएगा जवाब वाला फ़ील्ड. डिफ़ॉल्ट मान 'सही' है. |
languageCode |
ज़रूरी नहीं. इससे क्लाइंट को जवाब के लिए भाषा चुनने की अनुमति मिलती है. अगर उस भाषा के लिए डेटा नहीं दिया जा सकता, तो एपीआई सबसे करीबी मिलान का इस्तेमाल करता है. अनुमति वाली वैल्यू, आईईटीएफ़ स्टैंडर्ड के हिसाब से होती हैं. डिफ़ॉल्ट वैल्यू en है. |
जवाब का मुख्य भाग
अगर एपीआई सही से जुड़ जाता है, ताे जवाब के मुख्य भाग में नीचे दिए गए स्ट्रक्चर शामिल होता है.
JSON के काेड में दिखाना |
---|
{
"hoursInfo": [
{
object ( |
फ़ील्ड | |
---|---|
hoursInfo[] |
ज़रूरी नहीं. इसमें, अनुरोध की गई सीमा में हर घंटे की एयर क्वालिटी की जानकारी होती है. उदाहरण के लिए, अगर अनुरोध 48 घंटों के इतिहास के लिए किया गया है, तो हर घंटे की जानकारी के 48 एलिमेंट होंगे. |
regionCode |
ज़रूरी नहीं. अनुरोध में दी गई जगह से जुड़े देश/इलाके का ISO_3166-1 alpha-2 कोड. अगर अनुरोध में दी गई जगह किसी विवादित देश/इलाके में है, तो इस फ़ील्ड को जवाब में शामिल नहीं किया जा सकता. |
nextPageToken |
ज़रूरी नहीं. अगला पेज वापस पाने के लिए टोकन. |
अनुमति के दायरे
नीचे दिए गए OAuth के लिंक की ज़रूरत हाेती है:
https://www.googleapis.com/auth/cloud-platform
ज़्यादा जानकारी के लिए, OAuth 2.0 की खास जानकारी देखें.
HourInfo
इसमें, अनुरोध की गई सीमा में हर घंटे की एयर क्वालिटी की जानकारी होती है. उदाहरण के लिए, अगर अनुरोध 48 घंटों के इतिहास के लिए किया गया है, तो हर घंटे की जानकारी के 48 एलिमेंट होंगे.
JSON के काेड में दिखाना |
---|
{ "dateTime": string, "indexes": [ { object ( |
फ़ील्ड | |
---|---|
dateTime |
राउंड डाउन किया गया टाइमस्टैंप, जो उस समय को दिखाता है जब डेटा, RFC3339 यूटीसी "ज़ुलु" में बताता है फ़ॉर्मैट, नैनोसेकंड रिज़ॉल्यूशन और ज़्यादा से ज़्यादा नौ फ़्रैक्शनल अंकों के साथ हो सकता है. उदाहरण के लिए: "2014-10-02T15:00:00Z". |
indexes[] |
अनुरोध के पैरामीटर के आधार पर, इस सूची में ज़्यादा से ज़्यादा दो एयर क्वालिटी इंडेक्स शामिल होंगे:
|
pollutants[] |
प्रदूषण फैलाने वाले उन कॉम्पोनेंट की सूची जो अनुरोध में बताई गई जगह पर असर डालते हैं. ध्यान दें: यह फ़ील्ड सिर्फ़ उन अनुरोधों के लिए लौटाया जाएगा जिन्होंने नीचे दिए गए अतिरिक्त कंप्यूटेशन या इनमें से किसी एक के बारे में बताया है: POLLUTANT_ADDITIONAL_INFO, DOMINANT_POLLUTANT_CONCENTRATION, POLLUTANT_CONCENTRATION. |
healthRecommendations |
एयर क्वालिटी की रिपोर्ट की गई स्थितियों के बारे में स्वास्थ्य से जुड़ी सलाह और कार्रवाइयों के सुझाव. जो लोग जोखिम में हैं, प्रदूषण फैलाने वाले कॉम्पोनेंट के प्रति ज़्यादा संवेदनशील ग्रुप, और सामान्य जनसंख्या के लिए, सुझाव अलग-अलग तरीके से दिखाए जाते हैं. |