מחזירה תחזית איכות האוויר במיקום ספציפי בטווח תאריכים נתון.
בקשת HTTP
POST https://airquality.googleapis.com/v1/forecast:lookup
בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.
גוף הבקשה
גוף הבקשה מכיל נתונים במבנה הבא:
ייצוג JSON |
---|
{ "location": { object ( |
שדות | |
---|---|
location |
חובה. קו הרוחב וקו האורך שלפיהם מתבצע חיפוש של נתוני איכות האוויר ב-API. |
extraComputations[] |
זה שינוי אופציונלי. תכונות נוספות שאפשר להפעיל. ציון חישובים נוספים יגרום להחזרת הרכיבים והשדות הרלוונטיים בתשובה. |
uaqiColorPalette |
זה שינוי אופציונלי. קובע את לוח הצבעים שמשמש לנתונים שסופקו על ידי 'מדד איכות האוויר האוניברסלי' (UAQI). לוח הצבעים הזה רלוונטי רק ל-UAQI. למדדי AQI אחרים יש לוח צבעים שהוגדר מראש ואי אפשר לשלוט בו. |
customLocalAqis[] |
זה שינוי אופציונלי. מציין 'מדינה/אזור ל-AQI' קשר גומלין. מתבצעת התאמה בין מדינה או אזור לבין AQI הרצוי, כדי שנתוני איכות האוויר שנחוצים למדינה או לאזור האלה יוצגו בהתאם ל-AQI שנבחר. אפשר להשתמש בפרמטר הזה כדי לציין AQI שאינו ברירת המחדל למדינה מסוימת, לדוגמה, כדי לקבל את מדד EPA של ארה"ב לקנדה, במקום את אינדקס ברירת המחדל לקנדה. |
pageSize |
זה שינוי אופציונלי. המספר המקסימלי של רשומות מידע בכל שעה שצריך להחזיר בכל דף (ברירת מחדל = 24). |
pageToken |
זה שינוי אופציונלי. אסימון דף שהתקבל מקריאה קודמת לתחזית. הוא משמש לאחזור הדף הבא. |
dateTime |
חותמת זמן שלגביה מוחזרים נתונים לגבי נקודת זמן ספציפית. חותמת הזמן מעוגלת לשעה הקודמת. הפעולה הזו תחזיר נתונים שעתיים עבור חותמת הזמן המבוקשת בלבד (כלומר, רכיב מידע שעתי אחד). לדוגמה, בקשה שנשלחת כשהפרמטר dateTime מוגדר כ-2023-01-03T11:05:49Z יעוגל למטה ל-2023-01-03T11:00:00Z. הערה: אפשר להשתמש ב- |
period |
מציינת את התקופה הערה: אפשר להשתמש ב- |
universalAqi |
זה שינוי אופציונלי. אם המדיניות מוגדרת כ-True, מדד ה-AQI האוניברסלי ייכלל במדדים 'אינדקסים' בשדה של התשובה (ברירת המחדל היא True). |
languageCode |
זה שינוי אופציונלי. הלקוח יכול לבחור את השפה של התשובה. אם אי אפשר לספק נתונים לשפה הזו, ה-API משתמש בהתאמה הקרובה ביותר. הערכים המותרים מסתמכים על תקן IETF (ברירת המחדל היא 'en'). |
גוף התשובה
אובייקט התשובה של ממשק ה-API של תחזית איכות האוויר (AQI).
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא:
ייצוג JSON |
---|
{
"hourlyForecasts": [
{
object ( |
שדות | |
---|---|
hourlyForecasts[] |
זה שינוי אופציונלי. מכילה את נתוני איכות האוויר בכל שעה בטווח המבוקש. לדוגמה, אם הבקשה היא למשך 48 שעות של תחזית, יופיעו 48 רכיבים של תחזיות לפי שעה. |
regionCode |
זה שינוי אופציונלי. קוד ISO_3166-1 alpha-2 של המדינה/האזור התואמים למיקום שצוין בבקשה. אם המיקום שצוין בבקשה נמצא באזור שנוי במחלוקת, יכול להיות שהשדה הזה יושמט מהתשובה. |
nextPageToken |
זה שינוי אופציונלי. האסימון שצריך לאחזר את הדף הבא. |
היקפי ההרשאות
נדרש היקף ההרשאות הבא של OAuth:
https://www.googleapis.com/auth/cloud-platform
למידע נוסף, קראו את המאמר סקירה כללית של OAuth 2.0.
HourlyForecast
מכילה את נתוני איכות האוויר בכל שעה בטווח המבוקש. לדוגמה, אם הבקשה היא למשך 48 שעות של תחזית, יופיעו 48 רכיבים של תחזיות לפי שעה.
ייצוג JSON |
---|
{ "dateTime": string, "indexes": [ { object ( |
שדות | |
---|---|
dateTime |
חותמת זמן מעוגלת כלפי מטה שמציינת את השעה (שעה) שאליה הנתונים מתייחסים ב-'Zulu' (אזור זמן RFC3339 UTC) הפורמט. לדוגמה: '2014-10-02T15:00:00Z'. |
indexes[] |
הרשימה הזו תכלול (עד) שני מדדים של איכות האוויר, על סמך הפרמטרים של הבקשות:
|
pollutants[] |
רשימה של מזהמים שמשפיעים על המיקום שצוין בבקשה. הערה: השדה הזה יוחזר רק לבקשות שציינו אחת או יותר מהחישובים הנוספים הבאים: POLLUTANT_ADDITIONAL_INFO, DOMINANT_POLLUTANT_CONCENTRATION, POLLUTANT_CONCENTRATION. |
healthRecommendations |
עצות בנושאי בריאות ופעולות מומלצות שקשורות לתנאי איכות האוויר שדווחו. ההמלצות מותאמות באופן שונה לאוכלוסיות בסיכון, לקבוצות עם רגישות גבוהה יותר למזהמים ולאוכלוסייה הכללית. |