Method: gauges.queryGaugeForecasts

クエリ ゲージの予測。

HTTP リクエスト

GET https://floodforecasting.googleapis.com/v1/gauges:queryGaugeForecasts

この URL は gRPC Transcoding 構文を使用します。

クエリ パラメータ

パラメータ
gaugeIds[]

string

必須。ゲージ ID のリスト。サポートされるリストのサイズは 500 に制限されています。500 を超えるリストを指定すると、INVALID_REQUEST エラーで失敗します。
issuedTimeStart

string

省略可。最も早い予測発行時刻（文字列形式（ISO 8601））。例: 「2023-06-17T10:34:00Z」、または日付文字列（「2023-10-13」など）。開始日を「2023-10-01」より前にすることはできません。デフォルトは 1 週間前です。
issuedTimeEnd

string

省略可。最新の予報が発行された日時（ISO 8601 形式の文字列）。例: 「2023-06-17T10:34:00Z」、または日付文字列（「2023-10-13」など）。デフォルトは now です。

リクエストの本文

リクエストの本文は空にする必要があります。

レスポンスの本文

gauges.queryGaugeForecasts のレスポンス。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

JSON 表現 
{
  "forecasts": {
    string: {
      object (ForecastSet)
    },
    ...
  }
}
フィールド
forecasts

map (key: string, value: object (ForecastSet))

ゲージ ID と予測セットを対応付けるマップ。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }

ForecastSet

ゲージの予測のセット。

JSON 表現 
{
  "forecasts": [
    {
      object (Forecast)
    }
  ]
}
フィールド
forecasts[]

object (Forecast)

予測。

予測

複数のリードタイムに対する 1 つのゲージの予測。たとえば、発行時刻が午後 5 時の予測には、午後 6 時、午後 7 時、午後 8 時などの予測が含まれます。

注: 予測範囲の一部は、発行時刻よりも早くなる可能性があります。これは、たとえばモデルの入力データの遅延が原因で発生することがあります。上記の例では、問題の発生時刻が午後 5 時で、予測範囲が午後 4 時、午後 5 時、午後 6 時などになる可能性があります。

注: 範囲の長さと範囲間の距離は異なります。可能な範囲の例を次に示します。

  1. [5pm - 5pm]、[6pm - 6pm]、[7pm - 7pm]

  2. [3 月 1 日午前 12 時～ 3 月 2 日午前 12 時]、[3 月 2 日午前 12 時～ 3 月 3 日午前 12 時]、[3 月 3 日午前 12 時～ 3 月 4 日午前 12 時]

JSON 表現 
{
  "forecastRanges": [
    {
      object (ForecastTimedValue)
    }
  ],
  "gaugeId": string,
  "issuedTime": string
}
フィールド
forecastRanges[]

object (ForecastTimedValue)

予測は、さまざまな期間に関連するさまざまな予測値である複数の「予測範囲」で構成されます。範囲の開始と終了が等しい場合、それは時間の瞬間を意味します。
gaugeId

string

この予測の対象となるゲージの ID。
issuedTime

string

予報の発行時刻（ISO 8601）。例: 「2023-06-17T10:34:00Z」。発行時刻は、予測が生成された時刻です。

ForecastTimedValue

期間に関連する予測値。単位は、関連付けられている GaugeModel によって定義されます。開始と終了が等しい場合は、時間インスタントを意味します。

JSON 表現 
{
  "value": number,
  "forecastStartTime": string,
  "forecastEndTime": string
}
フィールド
value

number

予測の値。
forecastStartTime

string

期間の開始。
forecastEndTime

string

間隔の終了。