目前狀況端點可提供超過 100 個國家/地區的每小時空氣品質資訊,解析度最高可達 500 x 500 公尺。包含超過 70 個地方指數和全球空氣品質指數和類別。
HTTP 要求
POST https://airquality.googleapis.com/v1/currentConditions:lookup
這個網址使用 gRPC 轉碼語法。
要求主體
要求主體的資料會採用以下結構:
JSON 表示法 |
---|
{ "location": { object ( |
欄位 | |
---|---|
location |
必要欄位。API 用來尋找目前空氣品質狀況資料的經緯度。 |
extraComputations[] |
選用設定。可視需要啟用的其他功能。指定額外的運算作業會在回應中傳回相關元素和欄位。 |
uaqiColorPalette |
選用設定。決定「全球空氣品質指數」所提供資料的調色盤。(UAQI)。這個調色盤只適用於 UAQI,其他 AQI 則有無法控制的預設調色盤。 |
customLocalAqis[] |
選用設定。將「國家/地區」表示至 AQI關係將國家/地區與所需的 AQI 配對,讓系統根據所選 AQI 顯示該國家/地區所需的空氣品質資料。這個參數可用於為特定國家/地區指定非預設的 AQI,例如取得加拿大的美國環境保護局索引,而非加拿大的預設索引。 |
universalAqi |
選用設定。如果設為 True,系統會將通用 AQI 納入「索引」來自回應的 欄位。預設值為 true。 |
languageCode |
選用設定。允許用戶端選擇回應語言。如果該語言無法提供資料,API 就會使用最接近的項目。允許的值必須採用 IETF 標準。預設值為 en (英文)。 |
回應主體
如果成功,回應主體即會包含具有以下結構的資料:
JSON 表示法 |
---|
{ "dateTime": string, "regionCode": string, "indexes": [ { object ( |
欄位 | |
---|---|
dateTime |
RFC3339 世界標準時間「Zulu」的捨去時間戳記格式,解析度為奈秒,且最多 9 個小數位數。例如:「2014-10-02T15:00:00Z」。 |
regionCode |
與要求中提供的地點對應的國家/地區 ISO_3166-1 alpha-2 代碼。如果要求中提供的地點位於有爭議的地區,回應中可能會省略這個欄位。 |
indexes[] |
根據要求參數,這份清單最多會包含兩個空氣品質指數:
|
pollutants[] |
影響要求中指定位置的汙染物清單。注意:系統只會針對指定了下列一或多個額外運算的要求,傳回這個欄位:POLLUTANT_ADDITIONAL_INFO、DOMINANT_POLLUTANT_CONCENTRATION、POLLUTANT_CONCENTRATION。 |
healthRecommendations |
與系統回報的空氣品質情況相關的健康建議和應變措施建議。推薦系統也會針對有風險的族群、對汙染物較為敏感的族群,以及一般大眾提供不同的建議。 |
授權範圍
需要下列 OAuth 範圍:
https://www.googleapis.com/auth/cloud-platform
詳情請參閱 OAuth 2.0 總覽。