記錄

history 端點會提供特定位置的歷來每小時空氣品質資訊 (最長 30 天)。您可以控管要傳回哪些 AQI 和重要資訊 (例如汙染物濃度和健康建議)。

您可以使用 history 端點，傳送 HTTP POST 要求來要求每小時空氣品質記錄：

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

將您的要求選項加入 JSON 要求主體中。要求主體包含您要取得每小時空氣品質記錄的位置和時間範圍。可能也包含多種選項，控制要在回應中包含哪些空氣品質資訊。

一小時要求示例

單一小時要求主體

下列程式碼說明如何使用 history 方法，建構一小時的記錄要求主體。在本例中，您設定了位置和過去的時間戳記。

注意： 請確認 dateTime 參數指定過去 30 天內的時間範圍。

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 回應。如要進一步瞭解回應資料，請參閱「回應資料」。

注意： 根據預設，回應包含包含基本 AQI 資訊的通用 AQI。您可以設定對應的參數，移除 AQI 或替換為不同的 AQI。

{
    "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 建構要求主體，以傳回多筆過往每小時空氣品質記錄。

您可以指定時間範圍 (代表開始和結束時間戳記)，或指定從目前時間回溯的小時數，藉此要求多筆記錄。

注意： 結果會在「頁面」中傳回，並且在第一頁傳回最新的結果。使用 pageSize 屬性控制每頁的結果數量上限。如果需要多個網頁才能擷取所有結果，則每個頁面都會包含 nextPageToken 屬性，其中包含用於擷取後續頁面的符記。

在以下範例中，由於您將頁面大小設為 2，因此系統會以兩個頁面傳回您四小時空氣品質記錄的要求，且每個頁面都包含 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'

您可以傳遞開始和結束的時間戳記，提出類似的要求：

注意： 請確認 startTime 和 endTime 參數指定了過去 30 天內的時間範圍。

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 值。

注意： 傳遞 pageToken 屬性來存取後續資料頁面時，所有其他要求參數都必須與提供網頁權杖的原始呼叫相符。

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'