Method: forecast.lookup

指定された期間における特定の場所の大気質予測を返します。

HTTP リクエスト

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

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

リクエストの本文

リクエストの本文には、次の構造のデータが含まれます。

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

省略可。ページごとに返される 1 時間ごとの情報レコードの最大数（デフォルト = 24）。
pageToken

string

省略可。前回の予測呼び出しで受け取ったページトークン。後続のページを取得するために使用されます。
dateTime

string (Timestamp format)

特定の時点のデータを返すタイムスタンプ。タイムスタンプは、直近の 1 時間に四捨五入されます。

これにより、リクエストされたタイムスタンプについてのみ 1 時間ごとのデータが返されます（つまり、1 時間ごとの情報要素だけが返されます）。たとえば、dateTime パラメータが 2023-01-03T11:05:49Z に設定されている状態で送信されたリクエストは、2023-01-03T11:00:00Z に切り捨てられます。

注: リクエストでは dateTime または startTime と endTime を使用できます。
period

object (Interval)

予測データを取得する startTime 期間と endTime 期間を指定します。endTime はその数値を含んでいます。タイムスタンプは、直近の 1 時間に四捨五入されます。

注: リクエストでは dateTime または startTime と endTime を使用できます。
universalAqi

boolean

省略可。true に設定した場合、Universal AQI が「indexes」に含められます（デフォルトは true）です。
languageCode

string

省略可。クライアントはレスポンスの言語を選択できます。その言語のデータを提供できない場合、API は最も近い言語を使用します。使用できる値は IETF 標準に準拠しています（デフォルトは「en」）。

レスポンスの本文

大気質予測 API のレスポンス オブジェクト。

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

JSON 表現 
{
  "hourlyForecasts": [
    {
      object (HourlyForecast)
    }
  ],
  "regionCode": string,
  "nextPageToken": string
}
フィールド
hourlyForecasts[]

object (HourlyForecast)

省略可。リクエストされた範囲の 1 時間ごとの大気質情報が含まれます。たとえば、リクエストが 48 時間の予測の場合、1 時間ごとの予測の要素数は 48 になります。
regionCode

string

省略可。リクエストで指定された地域に対応する国/地域の ISO_3166-1 alpha-2 コード。リクエストで指定された場所が係争地にある場合は、レスポンスからこのフィールドが省略されることがあります。
nextPageToken

string

省略可。次のページを取得するためのトークン。

認可スコープ

次の OAuth スコープが必要です。

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

詳しくは、OAuth 2.0 の概要をご覧ください。

HourlyForecast

リクエストされた範囲の 1 時間ごとの大気質情報が含まれます。たとえば、リクエストが 48 時間の予測の場合、1 時間ごとの予測の要素数は 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)

このリストには、リクエスト パラメータに基づいて、最大 2 つの大気質指数が含まれます。

  • ユニバーサル AQI。universalAqi ブール値が true に設定されている場合に返されます。
  • ローカル AQI。LOCAL_AQI の追加計算が指定されている場合に返されます。
pollutants[]

object (Pollutant)

リクエストで指定された場所に影響を与える汚染物質のリスト。

注: このフィールドは、POLLUTANT_ADDITIONAL_INFO、DOMINANT_POLLUTANT_CONCENTRATION、POLLUTANT_CONCENTRATION の追加計算を 1 つ以上指定したリクエストに対してのみ返されます。
healthRecommendations

object (HealthRecommendations)

報告された大気質の状態に関連する健康に関するアドバイスと推奨される対応。推奨事項は、リスクのある集団、汚染物質に対して敏感な集団、一般集団に応じて異なります。