היסטוריה

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

אפשר לבקש את ההיסטוריה של איכות האוויר לפי שעה באמצעות history בנקודת קצה (endpoint) על ידי שליחת בקשת HTTP POST אל:

https://airquality.googleapis.com/v1/history:lookup?key=YOUR_API_KEY

הכללת אפשרויות הבקשה בקובץ ה-JSON גוף הבקשה. גוף הבקשה מכיל את המיקום ואת טווח הזמן שעבורו רוצים לקבל את הערך היסטוריית איכות האוויר לפי שעה. הוא עשוי גם לכלול אפשרויות שונות לשליטה איזה מידע על איכות האוויר צריך לכלול בתשובה.

APIs Explorer מאפשר ליצור בקשות בזמן אמת כדי להכיר אפשרויות ה-API וה-API:

רוצים לנסות?

דוגמה לבקשה של שעה אחת

גוף הבקשה לשעה אחת

הקוד הבא מראה איך לבנות גוף בקשה במשך שעה אחת בקשת היסטוריה באמצעות 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 בצורה שלמטה. פרטים נוספים על נתוני התגובות זמינים במאמר נתוני תגובות.

שתי השיחות שלמעלה מבקשות נתוני איכות אוויר של 4 שעות. עם זאת, מאחר שהגדרת המאפיין 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'