Package google.maps.airquality.v1

索引

AirQuality

大気質に関するサービス。

LookupCurrentConditions

rpc LookupCurrentConditions(LookupCurrentConditionsRequest) returns (LookupCurrentConditionsResponse)

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

承認スコープ

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

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

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

rpc LookupForecast(LookupForecastRequest) returns (LookupForecastResponse)

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

承認スコープ

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

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

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

rpc LookupHeatmapTile(LookupHeatmapTileRequest) returns (HttpBody)

タイルの PNG 画像のデータを含むバイト配列を返します。

承認スコープ

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

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

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

rpc LookupHistory(LookupHistoryRequest) returns (LookupHistoryResponse)

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

承認スコープ

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

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

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

AirQualityIndex

さまざまな大気質指標を表す基本オブジェクト。これらの指標を組み合わせることで、現在の大気質の状態に関するスナップショットを得ることができます。世界中には、さまざまな目的に応じた複数の指標があり、大気質のさまざまな側面の測定に関心のあるグループがあります。

フィールド
code

string

インデックスのコード。このフィールドは、スペースの代わりにスネークケースを使用して、プログラミング目的のインデックスを表します。例: 「uaqi」、「fra_atmo」。
display_name

string

人が読める形式のインデックス名。例: 「AQI（米国）」
aqi_display

string

インデックスの数値スコアのテキスト表現。接頭辞や接尾辞の記号を含めることもできます。通常、最も低いインデックス スコアを表します。例: >100 または 10+。

注: インデックス スコアを表示する場合は、このフィールドを使用する必要があります。数値以外のインデックスの場合、このフィールドは空になります。
color

Color

AQI 数値スコアを表すために使用する色。
category

string

インデックスの数値スコア解釈のテキスト分類。例: 「非常に良い大気質」。
dominant_pollutant

string

主な汚染物質の化学記号。例: 「CO」。
aqi

int32

インデックスの数値スコア。例: 10, 100。

値は正規化されておらず、関連する大気質指数のコンテキストでのみ解釈する必要があります。数値以外のインデックスの場合、このフィールドは返されません。

注: このフィールドは、計算やグラフ表示などに使用します。インデックス スコアを表示するには、AQI 表示フィールドを使用する必要があります。

ColorPalette

ユニバーサル大気質指数（UAQI）によって提供されるデータに使用するカラーパレットを指定します。このカラーパレットは UAQI 専用ですが、他の AQI にはあらかじめ決められたカラーパレットがあり、制御できません。

列挙型
COLOR_PALETTE_UNSPECIFIED デフォルト値。パラメータとして渡す場合は無視されます。
RED_GREEN 赤/緑のパレットを使用するかどうかを指定します。
INDIGO_PERSIAN_DARK インディゴ/ペルシャ色パレット（ダークモード）を使用するかどうかを決定します。
INDIGO_PERSIAN_LIGHT 藍色/ペルシャ色パレット（ライトモード）を使用するかどうかを決定します。

CustomLocalAqi

国/地域と AQI の関係を表します。国/地域を目的の AQI とペア設定して、その国/地域に必要な大気質データが、選択した AQI に従って表示されます。

フィールド
region_code

string

カスタム AQI が必要な国/地域。値は ISO 3166-1 alpha-2 コードを使用して指定する必要があります。
aqi

string

国/地域を関連付ける AQI。値は有効なインデックス コードでなければなりません。

ExtraComputation

必要に応じて有効にできる追加機能。追加の計算を指定すると、関連する要素とフィールドがレスポンスで返されます。

列挙型
EXTRA_COMPUTATION_UNSPECIFIED デフォルト値。パラメータとして渡されたパスは、サーバーによって無視されます。
LOCAL_AQI

リクエストされた場所（国）のローカル（国家）AQI をレスポンスに含めるかどうかを決定します。

指定すると、その場所のローカル AQI に関連するすべてのデータが格納された「air_quality_index」データ構造がレスポンスに含まれます。
HEALTH_RECOMMENDATIONS

現在の AQI 状態に対する健康に関するアドバイスと推奨される対応を回答に含めるかどうかを決定します。

推奨事項は、一般集団と、一般集団よりも汚染物質に対して敏感なリスクのある 6 つの集団向けに調整されています。

指定すると、関連データが利用可能になると、レスポンスに health_recommendations フィールドが入力されます。
POLLUTANT_ADDITIONAL_INFO

各汚染物質の追加情報をレスポンスに含めるかどうかを決定します。

指定した場合、データが利用可能になると、「indexes」フィールドのレスポンスに含まれる各大気質インデックス オブジェクトに additional_info フィールドが含まれます。
DOMINANT_POLLUTANT_CONCENTRATION

グローバル インデックスまたはローカルインデックス（あるいはその両方）に従って測定された主な汚染物質の濃度をレスポンスに含めるかどうかを決定します。

リクエストでグローバル AQI とローカル AQI の両方が指定されている場合、最大 2 つの汚染物質コードが返されます。

指定すると、データが利用可能な場合、「汚染物質」リストに含まれる主な汚染物質オブジェクトに concentration フィールドが含まれます。
POLLUTANT_CONCENTRATION

グローバル インデックスまたはローカルインデックス（あるいはその両方）に従って測定値を取得できるすべての汚染物質の濃度をレスポンスに含めるかどうかを決定します。

指定した場合、データが利用可能な場合、レスポンスの「pollutants」フィールドに含まれる各汚染オブジェクトには concentration フィールドが含まれます。

HealthRecommendations

さまざまな人口グループ向けの健康に関する推奨事項（自由形式のテキスト形式）。推奨値は、関連する大気質状態から取得されます。

フィールド
general_population

string

特定の感度はありません。
elderly

string

退職者と一般集団より高齢者。
lung_disease_population

string

呼吸器に関連した問題や喘息に苦しむ。
heart_disease_population

string

心臓や循環器系の疾患。
athletes

string

スポーツなど激しい屋外活動。
pregnant_women

string

妊娠のあらゆる段階の女性。
children

string

子ども、幼児、乳児などの若い層。

LookupCurrentConditionsRequest

現在の大気質条件のリクエスト定義です。

フィールド
location

LatLng

必須。API が現在の大気質データを検索する経度と緯度。
extra_computations[]

ExtraComputation

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

ColorPalette

省略可。ユニバーサル大気質指数（UAQI）で提供されるデータに使用するカラーパレットを指定します。このカラーパレットは UAQI 専用ですが、他の AQI にはあらかじめ決められたカラーパレットがあり、制御できません。
custom_local_aqis[]

CustomLocalAqi

省略可。国/地域と AQI の関係を表します。国/地域を目的の AQI とペア設定して、その国/地域に必要な大気質データが、選択した AQI に従って表示されます。このパラメータを使用すると、特定の国のデフォルト以外の AQI を指定できます。たとえば、カナダのデフォルトのインデックスではなく、カナダの US EPA インデックスを取得できます。
universal_aqi

bool

省略可。true に設定すると、ユニバーサル AQI がレスポンスの「indexes」フィールドに含まれます。デフォルト値は true です。
language_code

string

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

LookupCurrentConditionsResponse

フィールド
date_time

Timestamp

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

string

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

AirQualityIndex

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

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

Pollutant

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

HealthRecommendations

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

LookupForecastRequest

大気質予測 API のリクエスト オブジェクト。

フィールド
location

LatLng

必須。API が大気質データを検索する対象の緯度と経度。
extra_computations[]

ExtraComputation

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

ColorPalette

省略可。ユニバーサル大気質指数（UAQI）で提供されるデータに使用するカラーパレットを指定します。このカラーパレットは UAQI 専用ですが、他の AQI にはあらかじめ決められたカラーパレットがあり、制御できません。
custom_local_aqis[]

CustomLocalAqi

省略可。国/地域と AQI の関係を表します。国/地域を目的の AQI とペア設定して、その国/地域に必要な大気質データが、選択した AQI に従って表示されます。このパラメータを使用すると、特定の国のデフォルト以外の AQI を指定できます。たとえば、カナダのデフォルトのインデックスではなく、カナダの US EPA インデックスを取得できます。
page_size

int32

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

string

省略可。前回の予測呼び出しで受け取ったページトークン。後続のページを取得するために使用されます。
共用体フィールド time_range。必要な大気質予測データの期間。範囲は 1 時間以上先の四捨五入する必要があります。このフィールドを指定しないと、INVALID_ARGUMENT エラーが発生します。time_range は次のいずれかになります。
date_time

Timestamp

特定の時点のデータを返すタイムスタンプ。タイムスタンプは過去 1 時間に丸められます。

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

Interval

予測データを取得する期間の開始日と終了日を指定します。タイムスタンプは過去 1 時間に丸められます。
universal_aqi

bool

省略可。true に設定すると、ユニバーサル AQI がレスポンスの「indexes」フィールドに含まれます（デフォルトは true）。
language_code

string

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

LookupForecastResponse

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

フィールド
hourly_forecasts[]

HourlyForecast

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

string

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

string

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

HourlyForecast

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

フィールド
date_time

Timestamp

データが参照する時間（時間）を示す、切り捨てられたタイムスタンプ（RFC3339 UTC「Zulu」形式）。例: 「2014-10-02T15:00:00Z」
indexes[]

AirQualityIndex

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

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

Pollutant

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

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

HealthRecommendations

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

LookupHeatmapTileRequest

ヒートマップ タイルのリクエスト。

構造が標準のタイルサーバーの GET 呼び出しに準拠している（例: https://airquality.googleapis.com/v1/mapTypes/{map_type}/heatmapTiles/{zoom}/{x}/{y}）

例: https://airquality.googleapis.com/v1/mapTypes/BAQI_INDIGO_PERSIAN/heatmapTiles/1/1/1

フィールド
map_type

MapType

必須。大気質ヒートマップのタイプ。地図でグラフィカルに表示する汚染物質を定義します。

Allowed values:
- UAQI_RED_GREEN (UAQI, red-green palette)
- UAQI_INDIGO_PERSIAN (UAQI, indigo-persian palette)
- PM25_INDIGO_PERSIAN
- GBR_DEFRA
- DEU_UBA
- CAN_EC
- FRA_ATMO
- US_AQI
zoom

int32

必須。地図のズームレベル。地図表示での地図のコンテンツの大きさを定義します。

ズームレベル 0 では、全世界が 1 つのタイルに表示されます。ズームレベル 1 は、全世界が 4 つのタイルで表示されます。ズームレベル 2 では、全世界が 16 個のタイルで表示されます。ズームレベル 16 は、全世界が 65,536 個のタイルで表示されます。

指定できる値: 0 ～ 16
x

int32

必須。リクエストされたタイルの東西のポイントを定義します。
y

int32

必須。リクエストされたタイルの南北ポイントを定義します。

LookupHistoryRequest

大気質履歴 API のリクエスト オブジェクト。

フィールド
page_size

int32

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

string

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

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

LatLng

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

ExtraComputation

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

ColorPalette

省略可。ユニバーサル大気質指数（UAQI）で提供されるデータに使用するカラーパレットを指定します。このカラーパレットは UAQI 専用ですが、他の AQI にはあらかじめ決められたカラーパレットがあり、制御できません。
custom_local_aqis[]

CustomLocalAqi

省略可。国/地域と AQI の関係を表します。国/地域を目的の AQI とペア設定して、その国/地域に必要な大気質データが、選択した AQI に従って表示されます。このパラメータを使用すると、特定の国のデフォルト以外の AQI を指定できます。たとえば、カナダのデフォルトのインデックスではなく、カナダの US EPA インデックスを取得できます。
共用体フィールド time_range。必要な大気質データの期間。期間に関連するフィールドを指定しないと、INVALID_ARGUMENT エラーが発生します。time_range には次のいずれか 1 つだけを指定できます。time_range には、次のいずれかのみを指定できます。
date_time

Timestamp

過去のデータを返すためのタイムスタンプ。タイムスタンプは過去 1 時間に丸められます。

注: これにより、リクエストされたタイムスタンプの時間データのみ（つまり、1 つの時間ごとの info 要素）が返されます。たとえば、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」
hours

int32

リクエストの時間範囲を示す 1 ～ 720 の数値。例: 値が 48 の場合、過去 48 時間のデータが生成されます。
period

Interval

過去のデータを取得する開始日と終了日を指定します。タイムスタンプは過去 1 時間に丸められます。
universal_aqi

bool

省略可。true に設定すると、ユニバーサル AQI がレスポンスの「indexes」フィールドに含まれます。デフォルト値は true です。
language_code

string

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

LookupHistoryResponse

フィールド
hours_info[]

HourInfo

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

string

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

string

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

HourInfo

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

フィールド
date_time

Timestamp

データが参照する時刻を RFC3339 UTC「Zulu」形式で示す切り捨てタイムスタンプ。精度はナノ秒単位で、小数点以下 9 桁までです。例: 「2014-10-02T15:00:00Z」
indexes[]

AirQualityIndex

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

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

Pollutant

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

HealthRecommendations

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

MapType

大気質ヒートマップのタイプ。地図でグラフィカルに表示する汚染物質を定義します。

列挙型
MAP_TYPE_UNSPECIFIED デフォルト値。パラメータとして渡されたパスは、サーバーによって無視されます。
UAQI_RED_GREEN ユニバーサル大気質指数の赤と緑のパレット。
UAQI_INDIGO_PERSIAN ユニバーサル大気質指数（インディゴ ペルシャ）のパレット。
PM25_INDIGO_PERSIAN PM2.5 インデックス インディゴ ペルシャ パレット
GBR_DEFRA デイリー大気質指数（英国）のカラーパレット。
DEU_UBA ドイツのローカル大気質指数のカラーパレット。
CAN_EC Canadian Air Quality Health Index カラーパレット
FRA_ATMO フランス大気質指数のカラーパレット。
US_AQI 米国の大気質指数のカラーパレット。

汚染物質

大気質汚染物質に関するデータ。

フィールド
code

string

汚染物質のコードネーム。例: 「so2」。利用可能なコードの一覧については、こちらをご覧ください。
display_name

string

汚染物質の表示名。例: 「NOx」。
full_name

string

汚染物質の氏名。化合物の場合は IUPAC 名です。例: 「二酸化硫黄」。

IUPAC 名前テーブルの詳細については、https://iupac.org/what-we-do/periodic-table-of-elements/ をご覧ください。
concentration

Concentration

標準的な大気汚染測定単位のいずれかで測定された汚染物質の濃度レベル。
additional_info

AdditionalInfo

汚染物質に関する追加情報。

AdditionalInfo

特定の汚染物質の排出源と健康への影響。

フィールド
sources

string

汚染物質の主な排出源を表すテキスト。
effects

string

汚染物質による健康への主な影響を表すテキスト。

濃度

大気中における特定の汚染物質の濃度。

フィールド
units

Unit

この汚染物質の濃度の測定単位。
value

float

汚染物質濃度の値。

本体

汚染物質の濃度の測定に使用する単位を定義します。

列挙型
UNIT_UNSPECIFIED 濃度単位が指定されていません。
PARTS_PER_BILLION 濃度の ppb（10 億あたりの単位）。
MICROGRAMS_PER_CUBIC_METER 濃度の単位「μg/m^3」（マイクログラム/立方メートル）。