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 を指定できます。たとえば、カナダのデフォルトのインデックスではなく、カナダの US EPA インデックスを取得できます。
pageSize

integer

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

string

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

string (Timestamp format)

特定の時点のデータを返すタイムスタンプ。タイムスタンプは過去 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 に設定すると、ユニバーサル 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 に設定されている場合に返されます。
  • ローカル大気質指数。LOCAL_AQI 追加計算が指定されている場合は返されます。
pollutants[]

object (Pollutant)

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

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

object (HealthRecommendations)

報告された大気質状態に関連する健康に関するアドバイスと推奨される対応。推奨事項は、リスクのある集団、汚染物質に敏感なグループ、一般集団に合わせて調整されています。