傳回特定時間範圍內特定地區的空氣品質記錄。
HTTP 要求
POST https://airquality.googleapis.com/v1/history:lookup
這個網址使用 gRPC 轉碼語法。
要求主體
要求主體的資料會採用以下結構:
JSON 表示法 |
---|
{ "pageSize": integer, "pageToken": string, "location": { object ( |
欄位 | |
---|---|
pageSize |
選用設定。每頁傳回的每小時資訊記錄數量上限。預設值為 72,最大值為 168 (資料 7 天)。 |
pageToken |
選用設定。接收自先前記錄呼叫的網頁權杖。可用來擷取後續網頁。 請注意,為這個參數提供值時,您提供的所有其他參數都必須與提供網頁符記的呼叫 (先前的呼叫) 相符。 |
location |
必要欄位。API 尋找空氣品質記錄資料的經緯度。 |
extraComputations[] |
選用設定。其他可視需要啟用的功能。指定額外的運算將在回應中傳回相關的元素和欄位。 |
uaqiColorPalette |
選用設定。決定「環球空氣品質指數」(UAQI) 提供的資料所使用的調色盤。這個調色盤僅適用於 UAQI,其他 AQI 則是具有無法控制的預定調色盤。 |
customLocalAqis[] |
選用設定。表示「國家/地區與 AQI」的關係。將國家/地區與所需的 AQI 配對,即可根據所選 AQI 顯示該國家/地區所需的空氣品質資料。這個參數可用來指定特定國家/地區的非預設的 AQI。舉例來說,如要取得加拿大的美國 EPA 索引,而不是加拿大的預設索引值。 |
dateTime |
要傳回歷來資料的時間戳記。系統會將時間戳記四捨五入至前一個小時。 注意:這會僅傳回要求的時間戳記 (例如一個每小時資訊元素) 的每小時資料。舉例來說,如果要求在 dateTime 參數設為 2023-01-03T11:05:49Z 的情況下傳送,要求會無條件捨去為 2023-01-03T11:00:00Z。 採用 RFC3339 世界標準時間「Zulu」格式的時間戳記,採用奈秒解析度和最多九個小數位數。例如:「2014-10-02T15:01:23Z」和「2014-10-02T15:01:23.045123456Z」。 注意:在要求中可以使用 |
hours |
介於 1 到 720 的數字,表示要求的小時範圍。舉例來說,如果值為 48,系統會傳回過去 48 小時的資料。 |
period |
指出要取得歷來資料的 注意:在要求中可以使用 |
universalAqi |
選用設定。如果設為 True,系統會將通用 AQI 納入回應的「索引」欄位。預設值為 true。 |
languageCode |
選用設定。允許用戶端選擇回應的語言。如果無法提供該語言的資料,API 會使用最接近的項目。允許的值採用 IETF 標準。預設值為 en (英文)。 |
回應主體
如果成功,回應主體即會包含具有以下結構的資料:
JSON 表示法 |
---|
{
"hoursInfo": [
{
object ( |
欄位 | |
---|---|
hoursInfo[] |
選用設定。包含要求範圍內每小時的空氣品質資訊。舉例來說,如果要求的時間是 48 小時,報表就會顯示 48 個每小時資訊元素。 |
regionCode |
選用設定。與要求中所列位置相對應的國家/地區的 ISO_3166-1 alpha-2 代碼。如果要求中提供的地點位於有爭議的地域,回應可能會省略這個欄位。 |
nextPageToken |
選用設定。用於擷取下一頁的符記。 |
授權範圍
需要下列 OAuth 範圍:
https://www.googleapis.com/auth/cloud-platform
詳情請參閱 OAuth 2.0 總覽。
HourInfo
包含要求範圍內每小時的空氣品質資訊。舉例來說,如果要求的時間是 48 小時,報表就會顯示 48 個每小時資訊元素。
JSON 表示法 |
---|
{ "dateTime": string, "indexes": [ { object ( |
欄位 | |
---|---|
dateTime |
經過四捨五入的時間戳記,表示資料採用 RFC3339 世界標準時間「Zulu」格式的時間,採用奈秒解析度和最多九個小數位數。例如:「2014-10-02T15:00:00Z」。 |
indexes[] |
根據要求參數,這份清單會包含 (最多) 個空氣品質索引:
|
pollutants[] |
影響要求中指定位置的汙染物清單。注意: 只有在要求指定下列一或多項額外運算時,才會傳回此欄位:POLLUTANT_ADDITIONAL_INFO、DOINANT_POLLUTANT_CONCENTRATION、POLLUTANT_CONCENTRATION。 |
healthRecommendations |
與已回報空氣品質狀況相關的健康建議和應變措施。系統會針對有風險的族群、汙染物敏感度較高的族群及一般大眾,量身打造不同的推薦內容。 |