נקודת הקצה history מספקת מידע היסטורי על איכות האוויר לפי שעה במיקום ספציפי, בטווח תאריכים נתון, עד למקסימום של 30 ימים. אתם יכולים לקבוע אילו מדדי AQI ומידע רלוונטי יוחזרו (כמו רמת הריכוז של המזהמים והמלצות בריאותיות).
כדי לבקש היסטוריה של איכות האוויר לפי שעה, שולחים בקשת HTTP POST לנקודת הקצה history:
https://airquality.googleapis.com/v1/history:lookup?key=YOUR_API_KEY
כוללים את אפשרויות הבקשה בגוף הבקשה ב-JSON. גוף הבקשה מכיל את המיקום ואת טווח התאריכים שאתם רוצים לקבל לגביהם את היסטוריית איכות האוויר לפי שעה. הוא יכול גם לכלול אפשרויות שונות לשליטה במידע על איכות האוויר שייכלל בתגובה.
בעזרת APIs Explorer אתם יכולים לשלוח בקשות בזמן אמת כדי להכיר את ה-API ואת האפשרויות שלו:
דוגמה לבקשה לשעה אחת
גוף הבקשה לשעה אחת
בדוגמת הקוד הבאה אפשר לראות איך ליצור גוף בקשה להיסטוריה של שעה אחת באמצעות ה-method history.
בדוגמה הזו, אתם מגדירים את המיקום ואת חותמת הזמן בעבר.
curl -X POST -d '{
"dateTime": "2023-06-26T15:01:23Z",
"location": {
"latitude": 37.419734,
"longitude": -122.0827784
}
}' \
-H 'Content-Type: application/json' \
'https://airquality.googleapis.com/v1/history:lookup?key=YOUR_API_KEY'
תשובה תוך שעה
הקריאה שלמעלה יוצרת את תגובת ה-JSON הבאה. לפרטים נוספים על נתוני התגובה, ראו נתוני תגובה.
{ "hoursInfo": [ { "dateTime": "2023-06-26T15:00:00Z", "indexes": [ { "code": "uaqi", "displayName": "Universal AQI", "aqi": 73, "aqiDisplay": "73", "color": { "red": 118, "green": 202, "blue": 51, "alpha": 255 }, "category": "Good air quality", "dominantPollutant": "pm10" } ] } ], "regionCode": "us" }
דוגמה לבקשה של טווח תאריכים
בקשה לטווח תאריכים
הקוד הבא מראה איך ליצור גוף בקשה ל-history שמחזירה כמה רשומות של נתונים היסטוריים של איכות האוויר לפי שעה.
כדי לבקש כמה רשומות, אפשר לציין טווח תאריכים (חותמת זמן של התחלה וסיום) או לציין את מספר השעות אחורה מהשעה הנוכחית.
בדוגמה הבאה, מכיוון שגודל הדף הוגדר ל-2, הבקשה להיסטוריית איכות האוויר של ארבע שעות מוחזרת בשני דפים, כאשר כל דף מכיל נתונים של שעתיים.
curl -X POST -d '{
"hours": 4,
"pageSize": 2,
"pageToken":"",
"location": {
"latitude": 37.419734,
"longitude": -122.0827784
}
}' \
-H 'Content-Type: application/json' \
'https://airquality.googleapis.com/v1/history:lookup?key=YOUR_API_KEY'
אפשר לשלוח בקשה דומה על ידי העברת חותמות הזמן של ההתחלה והסיום:
curl -X POST -d '{
"period": {
"startTime":"2023-06-15T08:00:00Z",
"endTime":"2023-06-15T12:00:00Z"
},
"pageSize": 2,
"pageToken":"",
"location": {
"latitude": 37.419734,
"longitude": -122.0827784
}
}' \
-H 'Content-Type: application/json' \
'https://airquality.googleapis.com/v1/history:lookup?key=YOUR_API_KEY'
תשובה עם טווח תאריכים
הקריאות שלמעלה יוצרות תגובת JSON בפורמט הבא. לפרטים נוספים על נתוני התגובה, ראו נתוני תגובה.
שתי הקריאות שלמעלה מבקשות נתונים של איכות האוויר במשך ארבע שעות. עם זאת, בגלל שהגדרתם את המאפיין pageSize לערך 2 בבקשה, התגובה כוללת רק תוצאות מהשעתיים האחרונות.
{ "hoursInfo": [ { "dateTime": "2023-06-15T11:00:00Z", "indexes": [ { "code": "uaqi", "displayName": "Universal AQI", "aqi": 83, "aqiDisplay": "83", "color": { "red": 74, "green": 185, "blue": 54, "alpha": 255 }, "category": "Excellent air quality", "dominantPollutant": "o3" } ] }, { "dateTime": "2023-06-15T10:00:00Z", "indexes": [ { "code": "uaqi", "displayName": "Universal AQI", "aqi": 89, "aqiDisplay": "89", "color": { "red": 48, "green": 175, "blue": 55, "alpha": 255 }, "category": "Excellent air quality", "dominantPollutant": "o3" } ] } ], "regionCode": "us", "nextPageToken": "ChYaEgl3gv3XubVCQBEsNMY9TTdUMTE6MDA6MDA" }
שימו לב שהתשובה כוללת גם את המאפיין nextPageToken. אפשר להשתמש במאפיין הזה כדי לגשת לדף הבא של התוצאות, שמכיל את הנתונים של השעתיים הבאות.
כדי לגשת לדף התוצאות הבא, שולחים בקשה שנייה לנקודת הקצה history, אבל הפעם מגדירים את המאפיין pageToken לערך של nextPageToken מהתגובה הראשונה.
curl -X POST -d '{
"hours": 4,
"pageSize": 2,
"pageToken":"ChYaEgl3gv3XubVCQBEsNMY9TTdUMTE6MDA6MDA",
"location": {
"latitude": 37.419734,
"longitude": -122.0827784
}
}' \
-H 'Content-Type: application/json' \
'https://airquality.googleapis.com/v1/history:lookup?key=YOUR_API_KEY'
רוצה לנסות?
ב-APIs Explorer אתם יכולים לשלוח בקשות לדוגמה כדי להכיר את ה-API ואת האפשרויות שהוא מציע.
לוחצים על סמל ה-API api בצד שמאל של הדף.
אפשר לערוך את הפרמטרים של הבקשה.
לוחצים על הכפתור Execute. בתיבת הדו-שיח, בוחרים את החשבון שבו רוצים להשתמש כדי לשלוח את הבקשה.
בחלונית APIs Explorer, לוחצים על סמל המסך המלא fullscreen כדי להרחיב את החלון של APIs Explorer.