Method: currentConditions.lookup

Current Conditions エンドポイントは、100 か国以上における 1 時間ごとの大気質情報を、最大 500 x 500 メートルの解像度で提供しています。70 以上のローカル指数、グローバルな大気質指数および大気質カテゴリが含まれます。

HTTP リクエスト

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

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

リクエスト本文

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

JSON 表現
{
  "location": {
    object (LatLng)
  },
  "extraComputations": [
    enum (ExtraComputation)
  ],
  "uaqiColorPalette": enum (ColorPalette),
  "customLocalAqis": [
    {
      object (CustomLocalAqi)
    }
  ],
  "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 インデックスを取得できます。

universalAqi

boolean

(省略可)true に設定した場合、ユニバーサル AQI はレスポンスの index フィールドにも含まれます。デフォルト値は true です。

languageCode

string

(省略可)クライアントがレスポンスの言語を選択できるようにします。その言語のデータを提供できない場合、API は最も近い言語を使用します。指定できる値は IETF 標準に基づきます。デフォルト値は en です。

レスポンスの本文

成功すると、レスポンスの本文に次の構造のデータが含まれます。

JSON 表現
{
  "dateTime": string,
  "regionCode": string,
  "indexes": [
    {
      object (AirQualityIndex)
    }
  ],
  "pollutants": [
    {
      object (Pollutant)
    }
  ],
  "healthRecommendations": {
    object (HealthRecommendations)
  }
}
フィールド
dateTime

string (Timestamp format)

RFC3339 UTC「Zulu」形式の切り捨てられたタイムスタンプ。ナノ秒単位で、最大 9 桁の小数点以下になります。例: "2014-10-02T15:00:00Z"

regionCode

string

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

indexes[]

object (AirQualityIndex)

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

  • ユニバーサル大気質指数。UniversalAqi ブール値が true に設定されている場合は返されます。
  • 地域の大気質指数。LOCAL_AQI 追加計算が指定されている場合は返されます。
pollutants[]

object (Pollutant)

リクエストで指定されたロケーションに影響する汚染物質のリスト。注: このフィールドは、追加の計算 POLLUTANT_additional_INFO、DOMINANT_POLLUTANT_CONCENTRATION、POLLUTANT_CONCENTRATION を 1 つ以上指定したリクエストに対してのみ返されます。

healthRecommendations

object (HealthRecommendations)

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

認可スコープ

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

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

詳細については、OAuth 2.0 の概要をご覧ください。