דף זה תורגם על ידי Cloud Translation API.

היסטוריה

נקודת הקצה history מספקת מידע היסטורי על איכות האוויר לפי שעה במיקום מסוים, בטווח זמן נתון, עד 30 ימים לכל היותר. אתם יכולים לקבוע אילו מדדי איכות אוויר ומידע רלוונטי יוחזרו (למשל רמת הריכוז של מזהמים והמלצות בריאותיות).

אפשר לבקש היסטוריה של איכות האוויר לפי שעה באמצעות נקודת הקצה history. לשם כך, שולחים בקשת HTTP POST אל:

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, בוחרים בסמל המסך המלא מסך מלא כדי להרחיב את החלון של APIs Explorer.