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，例如取得加拿大的美國環境保護局索引，而非加拿大的預設索引。
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 納入「索引」欄位 (預設值為 = 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 世界標準時間「Zulu」為單位的捨去時間戳記，指出資料參照的時間 (小時)格式。例如：「2014-10-02T15:00:00Z」。
indexes[]

object (AirQualityIndex)

根據要求參數，這份清單最多會包含兩個空氣品質指數：

  • 通用 AQI如果 universalAqi 布林值設為 true，系統會傳回這個值。
  • 當地 AQI.如果指定 LOCAL_AQI 額外運算，就會傳回 。
pollutants[]

object (Pollutant)

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

注意：系統只會針對指定了下列一或多個額外運算的要求，傳回這個欄位：POLLUTANT_ADDITIONAL_INFO、DOMINANT_POLLUTANT_CONCENTRATION、POLLUTANT_CONCENTRATION。
healthRecommendations

object (HealthRecommendations)

與系統回報的空氣品質情況相關的健康建議和應變措施建議。推薦系統也會針對有風險的族群、對汙染物較為敏感的族群，以及一般大眾提供不同的建議。