Method: forecast.lookup

傳回特定時間範圍內特定地區的空氣品質預測資料。

HTTP 要求

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

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

要求主體

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

JSON 表示法 
{
  "location": {
    object (LatLng)
  },
  "extraComputations": [
    enum (ExtraComputation)
  ],
  "uaqiColorPalette": enum (ColorPalette),
  "customLocalAqis": [
    {
      object (CustomLocalAqi)
    }
  ],
  "pageSize": integer,
  "pageToken": string,
  "dateTime": string,
  "period": {
    object (Interval)
  }
  // End of list of possible types for union field time_range.
  "universalAqi": boolean,
  "languageCode": string
}
欄位
location

object (LatLng)

必要欄位。API 尋找空氣品質資料的經緯度。
extraComputations[]

enum (ExtraComputation)

選用設定。其他可視需要啟用的功能。指定額外的運算將在回應中傳回相關的元素和欄位。
uaqiColorPalette

enum (ColorPalette)

選用設定。決定「環球空氣品質指數」(UAQI) 提供的資料所使用的調色盤。這個調色盤僅適用於 UAQI，其他 AQI 則是具有無法控制的預定調色盤。
customLocalAqis[]

object (CustomLocalAqi)

選用設定。表示「國家/地區與 AQI」的關係。將國家/地區與所需的 AQI 配對，即可根據所選 AQI 顯示該國家/地區所需的空氣品質資料。這個參數可用來指定特定國家/地區的非預設的 AQI。舉例來說，如要取得加拿大的美國 EPA 索引，而不是加拿大的預設索引值。
pageSize

integer

選用設定。每頁傳回的每小時資訊記錄數量上限 (預設為 24)。
pageToken

string

選用設定。接收自先前的預測呼叫傳送的網頁權杖。可用來擷取後續網頁。
dateTime

string (Timestamp format)

傳回特定時間點的資料時間戳記。系統會將時間戳記四捨五入至前一個小時。

如此一來，系統只會根據要求的時間戳記 (例如單一的每小時資訊元素) 傳回每小時資料。舉例來說，如果要求在 dateTime 參數設為 2023-01-03T11:05:49Z 的情況下傳送，要求會無條件捨去為 2023-01-03T11:00:00Z。

注意：在要求中可以使用 dateTime 或 startTime 和 endTime。
period

object (Interval)

指出取得預測資料的 startTime 和 endTime 期間。endTime 包含。系統會將時間戳記四捨五入至前一個小時。

注意：在要求中可以使用 dateTime 或 startTime 和 endTime。
universalAqi

boolean

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

string

選用設定。允許用戶端選擇回應的語言。如果無法提供該語言的資料，API 會使用最接近的項目。允許的值須採用 IETF 標準 (預設值為「en」)。

回應主體

空氣品質預測 API 的回應物件。

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

JSON 表示法 
{
  "hourlyForecasts": [
    {
      object (HourlyForecast)
    }
  ],
  "regionCode": string,
  "nextPageToken": string
}
欄位
hourlyForecasts[]

object (HourlyForecast)

選用設定。包含要求範圍內每小時的空氣品質資訊。舉例來說，如果請求的是 48 小時的預測資料，每小時天氣預報就會有 48 個元素。
regionCode

string

選用設定。與要求中所列位置相對應的國家/地區的 ISO_3166-1 alpha-2 代碼。如果要求中提供的地點位於有爭議的地域，回應可能會省略這個欄位。
nextPageToken

string

選用設定。用於擷取下一頁的符記。

授權範圍

需要下列 OAuth 範圍：

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

詳情請參閱 OAuth 2.0 總覽。

HourlyForecast

包含要求範圍內每小時的空氣品質資訊。舉例來說，如果請求的是 48 小時的預測資料，每小時天氣預報就會有 48 個元素。

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

string (Timestamp format)

經過四捨五入的時間戳記，代表資料參照的時間 (小時)，採用 RFC3339 UTC Zulu 格式。例如：「2014-10-02T15:00:00Z」。
indexes[]

object (AirQualityIndex)

根據要求參數，這份清單會包含 (最多) 個空氣品質索引：

  • 通用空氣品質指數。如果 universalAqi 布林值設為 true，系統會傳回此值。
  • 本地空氣品質指數。如果指定 LOCAL_AQI 額外計算，將傳回。
pollutants[]

object (Pollutant)

影響要求中指定位置的汙染物清單。

注意： 只有在要求指定下列一或多項額外運算時，才會傳回此欄位：POLLUTANT_ADDITIONAL_INFO、DOINANT_POLLUTANT_CONCENTRATION、POLLUTANT_CONCENTRATION。
healthRecommendations

object (HealthRecommendations)

與已回報空氣品質狀況相關的健康建議和應變措施。系統會針對有風險的族群、汙染物敏感度較高的族群及一般大眾，量身打造不同的推薦內容。