Method: history.lookup

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

HTTP リクエスト

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

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

リクエストの本文

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

JSON 表現 
{
  "pageSize": integer,
  "pageToken": string,
  "location": {
    object (LatLng)
  },
  "extraComputations": [
    enum (ExtraComputation)
  ],
  "uaqiColorPalette": enum (ColorPalette),
  "customLocalAqis": [
    {
      object (CustomLocalAqi)
    }
  ],
  "dateTime": string,
  "hours": integer,
  "period": {
    object (Interval)
  }
  // End of list of possible types for union field time_range.
  "universalAqi": boolean,
  "languageCode": string
}
フィールド
pageSize

integer

省略可。ページごとに返される 1 時間ごとの情報レコードの最大数。デフォルトは 72、最大値は 168（7 日間のデータ）です。
pageToken

string

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

このパラメータに値を指定する場合、指定する他のすべてのパラメータは、ページトークンを提供した呼び出し（前の呼び出し）と一致する必要があります。
location

object (LatLng)

必須。API が大気質履歴データを検索する緯度と経度です。
extraComputations[]

enum (ExtraComputation)

省略可。オプションで有効にできる追加機能。追加の計算を指定すると、関連する要素とフィールドがレスポンスで返されます。
uaqiColorPalette

enum (ColorPalette)

省略可。「ユニバーサル大気質指数」によって提供されるデータに使用するカラーパレットを指定します（UAQI）。このカラーパレットは UAQI のみに関係しますが、他の AQI には制御できない事前定義のカラーパレットがあります。
customLocalAqis[]

object (CustomLocalAqi)

省略可。「国/地域を AQI に」を表しますあります。国/地域と目的の AQI をペアにして、選択した AQI に応じてその国/地域に必要な大気質データを表示します。このパラメータを使用して、特定の国のデフォルト以外の AQI を指定できます。たとえば、カナダのデフォルトのインデックスではなく、カナダ向けの米国 EPA インデックスを取得できます。
dateTime

string (Timestamp format)

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

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

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: 「2014-10-02T15:01:23Z」「2014-10-02T15:01:23.045123456Z」となります。

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

integer

リクエストの時間範囲を示す 1 ～ 720 の数値。たとえば、値を 48 にすると、過去 48 時間のデータが生成されます。
period

object (Interval)

履歴データを取得する startTime 期間と endTime 期間を指定します。タイムスタンプは、直近の 1 時間に四捨五入されます。

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

boolean

省略可。true に設定した場合、Universal AQI が「indexes」に含められますフィールドで確認できます。デフォルト値は true です。
languageCode

string

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

レスポンスの本文

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

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

object (HourInfo)

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

string

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

string

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

認可スコープ

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

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

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

HourInfo

リクエストされた範囲の 1 時間ごとの大気質情報が含まれます。たとえば、48 時間の履歴に関するリクエストの場合、1 時間ごとの情報には 48 要素が含まれます。

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

string (Timestamp format)

データが参照している時刻を示す切り捨てられたタイムスタンプ（RFC3339 UTC「Zulu」）ナノ秒単位で最大 9 桁の小数点以下 9 桁でサポートされます。例: 「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)

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