Method: currentConditions.lookup

Current Conditions 端點提供超過 100 個國家/地區的每小時空氣品質資訊，解析度最高可達 500 x 500 公尺。涵蓋超過 70 個地方指數和全球空氣品質指數和類別。

HTTP 要求

POST https://airquality.googleapis.com/v1/currentConditions:lookup

這個網址使用 gRPC 轉碼語法。

要求主體

要求主體的資料會採用以下結構：

JSON 表示法 
{
  "location": {
    object (LatLng)
  },
  "extraComputations": [
    enum (ExtraComputation)
  ],
  "uaqiColorPalette": enum (ColorPalette),
  "customLocalAqis": [
    {
      object (CustomLocalAqi)
    }
  ],
  "universalAqi": boolean,
  "languageCode": string
}
欄位
location

object (LatLng)

必要欄位。API 尋找目前天氣狀況資料的經緯度。
extraComputations[]

enum (ExtraComputation)

選用設定。可選擇啟用的其他功能。如果指定額外計算，系統會在回應中傳回相關的元素和欄位。
uaqiColorPalette

enum (ColorPalette)

選用設定。決定「Universal Air Quality Index」(通用空氣品質指數 (UAQI)) 提供的資料調色盤。其他 AQI 具有無法控制的預定調色盤，僅適用於 UAQI 顏色。
customLocalAqis[]

object (CustomLocalAqi)

選用設定。表示「國家/地區與 AQI」的關係。將某國家/地區與所需的 AQI 配對，以便根據所選 AQI 顯示該國家/地區所需的空氣品質資料。這個參數可用於為特定國家/地區指定非預設 AQI，例如取得加拿大的 US EPA 索引，而非加拿大的預設索引。
universalAqi

boolean

選用設定。如果設為 True，系統會將通用 AQI 納入回應的「索引」欄位。預設值為 true。
languageCode

string

選用設定。允許用戶端選擇回應的語言。如果無法針對該語言提供資料，API 會使用最接近的比對結果。允許的值取決於 IETF 標準。預設值為 en (英文)。

回應主體

如果成功，回應主體即會包含具有以下結構的資料：

JSON 表示法 
{
  "dateTime": string,
  "regionCode": string,
  "indexes": [
    {
      object (AirQualityIndex)
    }
  ],
  "pollutants": [
    {
      object (Pollutant)
    }
  ],
  "healthRecommendations": {
    object (HealthRecommendations)
  }
}
欄位
dateTime

string (Timestamp format)

以 RFC3339 世界標準時間「Zulu」格式呈現經過四捨五入的時間戳記，採用奈秒解析度，最多 9 個小數位數。例如：「2014-10-02T15:00:00Z」。
regionCode

string

與要求中提供的地點相應的國家/地區 ISO_3166-1 alpha-2 代碼。如果要求中提供的位置位於爭議地區，回應中可能會略過這個欄位。
indexes[]

object (AirQualityIndex)

根據要求參數，這份清單會納入 (最多) 兩個空氣品質指數：

  • 通用空氣品質指數。如果 universalAqi 布林值設為 true，系統就會傳回這個值。
  • 本機空氣品質指數。如果指定 LOCAL_AQI 額外運算，就會傳回這個結果。
pollutants[]

object (Pollutant)

影響要求中指定位置的汙染物清單。注意： 只有指定下列一或多項額外計算的要求才會傳回此欄位：POLLUTANT_ADDITIONAL_INFO、DOMINANT_POLLUTANT_CONCENTRATION、POLLUTANT_CONCENTRATION。
healthRecommendations

object (HealthRecommendations)

根據回報的空氣品質狀況，提供健康建議和建議做法。系統會針對有風險的族群、對汙染物敏感較高的族群和一般大眾，量身打造不同的推薦內容。

授權範圍

需要下列 OAuth 範圍：

  • https://www.googleapis.com/auth/cloud-platform

詳情請參閱 OAuth 2.0 總覽。