Package google.maps.airquality.v1

インデックス

AirQuality

大気質サービス。

LookupCurrentConditions

rpc LookupCurrentConditions(LookupCurrentConditionsRequest) returns (LookupCurrentConditionsResponse)

現在の状況エンドポイントは、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」の関係を表します。国または地域と目的の大気質指数をペア設定すると、選択した大気質指数に応じて、その国または地域に必要な大気質データが表示されます。

フィールド
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 つの汚染物質コードが返されることがあります。

指定されている場合、データが利用可能な場合は、「pollutants」リストに含まれる主要な汚染物質オブジェクトに 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 を指定できます。たとえば、カナダのデフォルト インデックスではなく、カナダの US EPA インデックスを取得できます。
universal_aqi

bool

省略可。true に設定すると、レスポンスの「indexes」フィールドにユニバーサル AQI が含まれます。デフォルト値は 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 に設定されている場合に返されます。
  • ローカル AQI。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 を指定できます。たとえば、カナダのデフォルト インデックスではなく、カナダの US EPA インデックスを取得できます。
page_size

int32

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

string

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

Timestamp

特定の時点のデータを返すタイムスタンプ。タイムスタンプは、直前の正確な時刻に丸められます。

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

Interval

予測データを取得する期間の開始日と終了日を指定します。タイムスタンプは、直前の正確な時刻に丸められます。
universal_aqi

bool

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

string

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

LookupForecastResponse

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

フィールド
hourly_forecasts[]

HourlyForecast

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

string

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

string

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

HourlyForecast

リクエストされた期間の各時間の大気質情報が含まれます。たとえば、48 時間の予測をリクエストすると、1 時間ごとの予測が 48 個返されます。

フィールド
date_time

Timestamp

データが参照する時刻（時間）を示す丸め下げタイムスタンプ（RFC3339 UTC「Zulu」形式）。例: 「2014-10-02T15:00:00Z」。
indexes[]

AirQualityIndex

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

  • ユニバーサル AQI。universal_aqi ブール値が true に設定されている場合に返されます。
  • ローカル AQI。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

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

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

LatLng

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

ExtraComputation

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

ColorPalette

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

CustomLocalAqi

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

Timestamp

過去のデータを返すタイムスタンプ。タイムスタンプは、直前の正確な時刻に丸められます。

注: リクエストされたタイムスタンプの 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」。
hours

int32

1 ～ 720 の整数で、リクエストの時間範囲を示します。たとえば、値が 48 の場合、過去 48 時間のデータが返されます。
period

Interval

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

bool

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

string

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

LookupHistoryResponse

フィールド
hours_info[]

HourInfo

省略可。リクエストされた期間の各時間の大気質情報が含まれます。たとえば、48 時間の履歴をリクエストすると、1 時間あたりの情報が 48 個返されます。
region_code

string

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

string

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

HourInfo

リクエストされた期間の各時間の大気質情報が含まれます。たとえば、48 時間の履歴をリクエストすると、1 時間あたりの情報が 48 個返されます。

フィールド
date_time

Timestamp

データが参照する時刻を示す丸め下げタイムスタンプ（RFC3339 UTC「Zulu」形式、ナノ秒単位、小数点以下 9 桁）。例: 「2014-10-02T15:00:00Z」。
indexes[]

AirQualityIndex

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

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

Pollutant

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

HealthRecommendations

報告された大気質の状態に関連する健康に関するアドバイスと推奨される対応推奨事項は、リスクの高い人々、汚染物質に敏感なグループ、一般の人々で異なります。

マップタイプ

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

列挙型
MAP_TYPE_UNSPECIFIED デフォルト値。パラメータとして渡された場合、サーバーはこれを無視します。
UAQI_RED_GREEN 汎用大気質指数の赤と緑のパレット。
UAQI_INDIGO_PERSIAN ユニバーサル大気質指数の Indigo-Persian パレット。
PM25_INDIGO_PERSIAN PM2.5 指数の indigo-persian パレット。
GBR_DEFRA 1 日の大気質指数（英国）のカラーパレット。
DEU_UBA ドイツのローカル大気質指数のカラーパレット。
CAN_EC カナダの大気質健康指数のカラーパレット。
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 億分の 1）。
MICROGRAMS_PER_CUBIC_METER 濃度単位「µg/m^3」（立方メートルあたりのマイクログラム）。