查詢量表預測。
HTTP 要求
GET https://floodforecasting.googleapis.com/v1/gauges:queryGaugeForecasts
這個網址使用 gRPC 轉碼語法。
查詢參數
參數 | |
---|---|
gaugeIds[] |
必要欄位。量規 ID 清單。支援的清單大小上限為 500。如果提供的清單超過 500 個項目,系統會傳回 INVALID_REQUEST 錯誤。 |
issuedTimeStart |
(選用步驟) 最早發布預報的時間,以字串 (ISO 8601) 表示,例如「2023-06-17T10:34:00Z」或日期字串 (例如「2023-10-13」)。開始時間不得早於「2023-10-01」。預設值為一週前。 |
issuedTimeEnd |
(選用步驟) 以字串 (ISO 8601) 形式表示的最新預報發布時間,例如「2023-06-17T10:34:00Z」或日期字串 (例如「2023-10-13」)。預設值為「現在」。 |
要求主體
要求主體必須為空白。
回應主體
gauges.queryGaugeForecasts 的回應。
如果成功,回應主體會含有以下結構的資料:
JSON 表示法 |
---|
{
"forecasts": {
string: {
object ( |
欄位 | |
---|---|
forecasts |
從測量計 ID 到預測集的對應。 這個物件中包含 |
ForecastSet
一組量表預測資料。
JSON 表示法 |
---|
{
"forecasts": [
{
object ( |
欄位 | |
---|---|
forecasts[] |
預測結果。 |
預測
單一測量站的數個前置時間預報。舉例來說,預報的發布時間可能是下午 5 點,但內容包含下午 6 點、7 點、8 點等時間的預測。
注意:部分預測範圍可能早於發布時間。舉例來說,模型輸入資料延遲就可能導致這種情況。以上述範例來說,問題發生時間可能是下午 5 點,預測範圍則是下午 4 點、5 點、6 點等。
注意:範圍長度及間距不一。可能的範圍包括:
[5pm - 5pm]、[6pm - 6pm]、[7pm - 7pm]
[3 月 1 日凌晨 12 點 - 3 月 2 日凌晨 12 點]、[3 月 2 日凌晨 12 點 - 3 月 3 日凌晨 12 點]、[3 月 3 日凌晨 12 點 - 3 月 4 日凌晨 12 點]
JSON 表示法 |
---|
{
"forecastRanges": [
{
object ( |
欄位 | |
---|---|
forecastRanges[] |
預測資料包含多個「預測範圍」,這些範圍是不同時間範圍的預測值。如果範圍的開始和結束時間相同,表示這是時間點。 |
gaugeId |
這項預測適用的儀表 ID。 |
issuedTime |
預報發布時間 (ISO 8601),例如「2023-06-17T10:34:00Z」。發布時間是產生預報的時間。 |
ForecastTimedValue
與時間範圍相關的預測值。單位由相關聯的 GaugeModel 定義。如果開始時間和結束時間相同,表示這是時間點。
JSON 表示法 |
---|
{ "value": number, "forecastStartTime": string, "forecastEndTime": string } |
欄位 | |
---|---|
value |
預測值。 |
forecastStartTime |
間隔的開始時間。 |
forecastEndTime |
間隔的結束時間。 |