Weather - Get Current Air Quality

Service:
Maps
API バージョン:
1.1

潜在的なリスクと推奨される予防措置を含む現在の大気質情報を取得するために使用します。
Get Current Air Quality API は、汚染物質の濃度と現在の大気質の全体的なステータスに関する詳細情報 (汚染レベル、大気質指数値、主要な汚染物質、リスク レベルと推奨される予防措置をまとめた簡単なステートメントなど) を返す HTTP GET 要求です。

GET {endpoint}/weather/airQuality/current/json?api-version=1.1&query={query}
省略可能なパラメーターを含む: 
GET {endpoint}/weather/airQuality/current/json?api-version=1.1&language={language}&query={query}&pollutants={pollutants}

URI パラメーター

Name / 必須 型 説明
endpoint
 path True

string (uri)

Azure Mapsサービスのホストネーム。 Azureパブリッククラウドにはhttps://atlas.microsoft.comを使いましょう。 特定のAzure Maps地理やソブリンクラウドをターゲットにする場合は、Azure Maps地理的範囲を参照してください。
format
 path True

JsonFormat

応答の目的の形式。 json 形式のみがサポートされています。
api-version
 query True

string

minLength: 1

この操作に使用する API バージョン。
query
 query True

number[]

緯度の後に経度 (例: "47.641268,-122.125679") で構成されるコンマ区切り文字列として指定された該当するクエリ。

気象情報は、通常、陸上の場所、陸地に囲まれた水域、および海岸線から約 50 海里以内の海域で利用できます。
language
 query

string

検索結果を返す言語。 サポートされている IETF 言語タグの 1 つである必要があります。大文字と小文字は区別されません。 指定した言語のデータが特定のフィールドで使用できない場合は、既定の言語が使用されます。

詳細については、サポートされている言語の を参照してください。
pollutants
 query

boolean

各汚染物質に関する詳細情報を返すブール値。 デフォルトでは True です。

要求ヘッダー

Name 必須 型 説明
x-ms-client-id

string

Microsoft Entra IDセキュリティモデルで使用されることを意図したアカウントを示します。 このAzure Mapsアカウントの一意IDは、Azure Maps管理プレーンのアカウントAPIから取得できます。 Azure MapsにおけるMicrosoft Entra IDセキュリティの使用についての詳細は、Azure Mapsの認証管理Manage certificationをご覧ください。

応答

Name 型 説明
200 OK

AirQualityResult

要求は成功しました。
Other Status Codes

ErrorResponse

予期しないエラー応答。

セキュリティ

AadToken

これらはMicrosoft Entra OAuth 2.0フローです。 Azureロールベースアクセス制御と組み合わせることで、Azure Maps REST APIへのアクセス制御に利用できます。 Azure ロールベースのアクセス制御は、1つ以上の Azure Maps リソースアカウントまたはサブリソースへのアクセスを指定するために使用されます。 Azure Maps REST API に対する 1 つ以上のアクセス許可で構成される組み込みロールまたはカスタム ロールを使用して、任意のユーザー、グループ、またはサービス プリンシパルにアクセス権を付与できます。

シナリオを実装するには、認証の概念表示することをお勧めします。 要約すると、このセキュリティ定義は、特定の API とスコープに対するアクセス制御が可能なオブジェクトを介してアプリケーションをモデル化するためのソリューションを提供します。

Note

  • このセキュリティ定義 使用して、アプリケーションがアクセスを要求している Azure Maps リソースを示す必要があります。 これは、Maps 管理 APIから取得できます。
  • Authorization URL は、Azure パブリック クラウド インスタンスに固有です。 ソブリンクラウドは固有の認可URLとMicrosoft Entra IDの設定を持っています。
  • Azure ロールベースのアクセス制御は、Azure portal、PowerShell、CLI、Azure SDK、または REST API を使用して Azure 管理プレーンから構成されます。
  • Azure Maps Web SDK を使用すると、複数のユース ケースに対するアプリケーションの構成ベースのセットアップが可能になります。
  • Microsoft ID プラットフォームの詳細については、「Microsoft ID プラットフォームの概要」を参照してください。

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

Name 説明
https://atlas.microsoft.com/.default

subscription-key

これは、Azure portal で、または PowerShell、CLI、Azure SDK、または REST API を使用して Azure Maps アカウント を作成 場合にプロビジョニングされる共有キーです。

このキーを使用すると、すべてのアプリケーションがすべての REST API にアクセスできます。 つまり、このキーは、発行されたアカウントのマスター キーとして使用できます。

パブリックに公開されているアプリケーションの場合は、キーを安全に格納できるように、機密クライアント アプリケーション アプローチを使用して Azure Maps REST API にアクセスすることをお勧めします。

型: apiKey
/: header

SAS Token

これは、Azure portal、PowerShell、CLI、Azure SDK、または REST API を介して Azure 管理プレーンを介して、Azure Maps リソース のリスト SAS 操作から作成される Shared Access Signature トークンです。

このトークンを使用すると、すべてのアプリケーションは、Azure ロールベースのアクセス制御と、特定のトークンに対する使用の有効期限、レート、およびリージョンに対するきめ細かな制御を使用してアクセスすることが承認されます。 つまり、SAS トークンを使用して、アプリケーションが共有キーよりもセキュリティで保護された方法でアクセスを制御できるようにします。

パブリックに公開されているアプリケーションの場合は、Map アカウント リソースの許可された配信元の特定の一覧を構成し、レンダリングの不正使用を制限し、SAS トークンを定期的に更新するように することをお勧めします。

型: apiKey
/: header

例

Get Current Air Quality

要求のサンプル

GET https://atlas.microsoft.com/weather/airQuality/current/json?api-version=1.1&query=47.632346,-122.13887

応答のサンプル

状態コード:
200 
{
  "results": [
    {
      "description": "The air quality is generally acceptable for most individuals. However, sensitive groups may experience minor to moderate symptoms from long-term exposure.",
      "category": "Fair",
      "categoryColor": "#FFC300",
      "dateTime": "2021-07-19T02:00:00+00:00",
      "dominantPollutant": "Ozone",
      "globalIndex": 22.1,
      "index": 21.6,
      "pollutants": [
        {
          "name": "Nitrogen Dioxide",
          "type": "NO2",
          "concentration": {
            "unit": "µg/m³",
            "unitType": 31,
            "value": 13.4
          },
          "globalIndex": 6.7,
          "index": 6.7
        },
        {
          "name": "Ozone",
          "type": "O3",
          "concentration": {
            "unit": "µg/m³",
            "unitType": 31,
            "value": 53.5
          },
          "globalIndex": 22.1,
          "index": 21.6
        },
        {
          "name": "Particulate Matter 10",
          "type": "PM10",
          "concentration": {
            "unit": "µg/m³",
            "unitType": 31,
            "value": 12.2
          },
          "globalIndex": 12.2,
          "index": 11.3
        },
        {
          "name": "Particulate Matter 2.5",
          "type": "PM2.5",
          "concentration": {
            "unit": "µg/m³",
            "unitType": 31,
            "value": 3.2
          },
          "globalIndex": 6.5,
          "index": 13.5
        },
        {
          "name": "Carbon Monoxide",
          "type": "CO",
          "concentration": {
            "unit": "µg/m³",
            "unitType": 31,
            "value": 118.4
          },
          "globalIndex": 0.6,
          "index": 1.2
        },
        {
          "name": "Sulfur Dioxide",
          "type": "SO2",
          "concentration": {
            "unit": "µg/m³",
            "unitType": 31,
            "value": 1.1
          },
          "globalIndex": 1.1,
          "index": 0.6
        }
      ]
    }
  ]
}

定義

Name 説明
AirQuality

ある場所の現在の大気質測定値は、 AirQualityResult.results年に記録として戻りました。 地域の規制機関(index)が報告する大気質指数と国際的に正規化された指数(globalIndex)を組み合わせ、結果を駆動する dominantPollutant を特定し、局所化された定性的 category と色分けされたUIに適した対応 categoryColor と組み合わせます。 短い description では、この数値が日常活動や健康上の注意事項にどのような意味を持つかが説明され、リクエストで汚染物質の詳細を求める際には、 pollutants 配列に汚染物質ごとの内訳が記載されています。
AirQualityResult

回答はGet Current Air Quality操作によって返送され、指定された場所の現在の大気質状況を提供します。 results配列には、局所および世界的に正規化された大気質指数、支配的な汚染物質、定性的カテゴリーとそれに対応する色、健康への影響の簡単な説明、そして(必要に応じて)汚染物質ごとの詳細をまとめた単一のAirQuality項目が含まれています。
DominantPollutant

濃度が最も高い汚染物質を識別します。
ErrorAdditionalInfo

リソース管理エラーの追加情報。
ErrorDetail

エラーの詳細。
ErrorResponse

すべてのAzure Resource Manager APIで失敗した操作に対してエラー詳細を返す共通のエラー応答です。 (これは、OData エラー応答形式にも従います)。
JsonFormat

応答の目的の形式。 json 形式のみがサポートされています。
Pollutant

調査地点で測定された単一の汚染物質は、 AirQuality.pollutantsの1つのエントリーとして返答されました。 各項目は汚染物質(コードと英語名で)を特定し、大気中の測定 concentration を報告し、汚染物質の個別寄与を地域のAQI(index)および国際正規化指数(globalIndex)に示します。これらは AirQualityの全体測定と同じ2つのスケールですが、この汚染物質に限定されています。 一般的な大気質の測定では、二 酸化窒素、 オゾン、 粒子状物質10、粒子状 物質2.5、 一酸化炭素、二 酸化硫黄 の各汚染物質ごとに1つのエントリーがあり、参加者はどの物質がどれだけ影響しているかを確認できます。
PollutantType

Azure Maps Weather Serviceが追跡する6種類の汚染物質の説明。
UnitType

表示されるユニットの種類に関連する整数値。 たとえば、摂氏の場合は 17、華氏の場合は 18 です。 単位の翻訳に使用できます。 詳細については、Azure Maps<>>の

WeatherValue

気温、露点、風速などの気象関連指標の値は、単位URIパラメータで指定されたメートル法またはインペリアル単位で示されます。 詳細は「Azure Mapsの気象サービス」の「ユニットタイプ」をご覧ください。

AirQuality

Object

ある場所の現在の大気質測定値は、 AirQualityResult.results年に記録として戻りました。 地域の規制機関(index)が報告する大気質指数と国際的に正規化された指数(globalIndex)を組み合わせ、結果を駆動する dominantPollutant を特定し、局所化された定性的 category と色分けされたUIに適した対応 categoryColor と組み合わせます。 短い description では、この数値が日常活動や健康上の注意事項にどのような意味を持つかが説明され、リクエストで汚染物質の詳細を求める際には、 pollutants 配列に汚染物質ごとの内訳が記載されています。

Name 型 説明
category

string

現在の大気質の簡潔な質的要約を、依頼で指定された言語で返送します。 典型的な値は「 良好」「 普通」「 中程度」「 悪い」「 危険」などがあります。正確なセットは、調査対象地域の規制機関によって異なります。
categoryColor

string

16進数の色コードマッチングcategoryで、UIで大気質の読み取りを色分けするのに適しています。例えば、Fair(公平)の #FFC300 です。 各 category 値は異なる色を持ち、一目で読み取りを認識できます。
dateTime

string (date-time)

大気質の測定が適用される日時( ISO 8601 形式)は、yyyy-mm-ddThh:mm:ss+hh:mmです。 例えば、 2021-07-19T02:00:00+00:00です。
description

string

現在の大気質や敏感なグループが考慮すべき注意事項を説明する自由形式の文を1、2文、リクエストに指定された言語で返送します。 例えば、 空気の質はほとんどの人にとって一般的に許容範囲内です。しかし、敏感な人には長期的な曝露により軽度から中程度の症状が現れることがあります。
dominantPollutant

DominantPollutant

現在のindexとglobalIndexを駆動する汚染物質は、オゾンやNO2のようなDominantPollutant値の一つです。 現在の大気質に最も影響している物質を特定するのに役立ちます。
globalIndex

number (float)

地域のAQI尺度に依存しず、地域ごとに比較可能な正規化された大気質指数です。 この値は、測定された6つの汚染物質(PM2.5、PM10、NO2、SO2、CO、O3)における最も高い個別サブインデックスです。その最大値を生み出した汚染物質はdominantPollutantで返されます。

品揃えとカテゴリー:

価値 Category
0-20 非常に良い
21-50 普通
51-100 悪い
101-150 異常
151-250 とても不健康です
251+ 危険だ

例えば、サブ指数CO 0.6、SO2 1.1、PM2.5 6.5、NO2 6.7、PM10 12.2、O3 22.1というサブ指数が与えられると、 globalIndex は 22.1 、 dominantPollutant は オゾンです。
index

number (float)

調査対象の場所に対して、地域の規制機関が設定した尺度上の大気質指数(AQI)です。 AQIの尺度は国や地域によって大きく異なるため、同じ数値でも場所によって意味が異なることがあります。ラベルは地域ごとに一貫性のあるものとして category を使いましょう。 例えば、クエリされた場所のスケールで 21.6 です。 背景については、ウィキペディアの 大気質指数 を参照してください。
pollutants

Pollutant[]

全体の測定値の背後には汚染物質ごとの詳細があり、測定対象ごとに1つの Pollutant エントリー(通常 は二酸化窒素、 オゾン、 粒子状物質10、粒子状物質 2.5、 一酸化炭素、 二酸化硫黄)が記載されています。 各項目は汚染物質の濃度と個別の index および globalIndex 寄与を報告しています。 汚染物質の詳細を求める依頼があった場合にのみ返送します。

AirQualityResult

Object

回答はGet Current Air Quality操作によって返送され、指定された場所の現在の大気質状況を提供します。 results配列には、局所および世界的に正規化された大気質指数、支配的な汚染物質、定性的カテゴリーとそれに対応する色、健康への影響の簡単な説明、そして(必要に応じて)汚染物質ごとの詳細をまとめた単一のAirQuality項目が含まれています。

Name 型 説明
nextLink

string

応答がページ付けされた際に次のページを取得できるURLで、単一の呼び出しで返すには大きすぎる結果セットをナビゲートするのに適しています。 ページがなければ空っぽ。
results

AirQuality[]

現地の大気質の読み取り値は単一要素のアレイとして返されました。 項目では、地域の大気質指数(index)、国際正規化指数(globalIndex)、 dominantPollutant (例: オゾン)、質的 category (例: Fair)と一致する categoryColor (例: #FFC300)、健康への影響の簡単な description 、そして汚染物質の詳細を求める際には、測定された汚染物質ごとに1つのエントリーを持つ pollutants 配列を報告します。

DominantPollutant

列挙

濃度が最も高い汚染物質を識別します。

値 説明
Carbon Monoxide

一酸化炭素(CO)は、無色・無臭・無味ながらも、炭素含有燃料の不完全燃焼によって発生する非常に有毒なガスです。 一般的な発生源には、自動車の排気ガス、ガスストーブ、炉、薪の火などがあります。
Nitrogen Dioxide

二酸化窒素(NO2)は重要な大気汚染物質です。 これは規制されており、世界保健機関 (WHO) によって設定された推奨制限ガイドラインの対象となります。
Ozone

オゾン(O3)は光化学スモッグの重要な成分であり、これは多くの大都市を包み込む茶色く有害な霞の一種で、太陽光と特定の汚染物質との光化学反応によって生じます。
Particulate Matter 2.5

粒子状物質2.5(PM2.5)は、直径が一般的に2.5マイクロメートル以下の微細粒子を指します。 これらの粒子は人間の髪の毛の100分の1以上細く、長時間空中に浮遊することがあります。
Particulate Matter 10

粒子状物質10(PM10)は、直径が一般的に10マイクロメートル以下の粒子を指します。 これらの粒子には、ほこり、花粉、すす、煙、液滴などが含まれます。
Sulfur Dioxide

二酸化硫黄(SO2)は、重く無色の無機気体で、刺激的な臭いを放ちます。 主に発電所や産業施設で化石燃料を燃やして生成されますが、火山などの自然発生源から排出されることもあります。

ErrorAdditionalInfo

Object

リソース管理エラーの追加情報。

Name 型 説明
info

追加情報。
type

string

追加情報の種類。

ErrorDetail

Object

エラーの詳細。

Name 型 説明
additionalInfo

ErrorAdditionalInfo[]

エラーの追加情報。
code

string

エラー コード。
details

ErrorDetail[]

エラーの詳細。
message

string

エラー メッセージ。
target

string

エラーターゲット。

ErrorResponse

Object

すべてのAzure Resource Manager APIで失敗した操作に対してエラー詳細を返す共通のエラー応答です。 (これは、OData エラー応答形式にも従います)。

Name 型 説明
error

ErrorDetail

エラー オブジェクト。

JsonFormat

列挙

応答の目的の形式。 json 形式のみがサポートされています。

値 説明
json

JavaScript オブジェクト表記データ交換形式 を する

Pollutant

Object

調査地点で測定された単一の汚染物質は、 AirQuality.pollutantsの1つのエントリーとして返答されました。 各項目は汚染物質(コードと英語名で)を特定し、大気中の測定 concentration を報告し、汚染物質の個別寄与を地域のAQI(index)および国際正規化指数(globalIndex)に示します。これらは AirQualityの全体測定と同じ2つのスケールですが、この汚染物質に限定されています。 一般的な大気質の測定では、二 酸化窒素、 オゾン、 粒子状物質10、粒子状 物質2.5、 一酸化炭素、二 酸化硫黄 の各汚染物質ごとに1つのエントリーがあり、参加者はどの物質がどれだけ影響しているかを確認できます。

Name 型 説明
concentration

WeatherValue

汚染物質の空気中の濃度は、NO2、O3、PM10、PM2.5、CO、SO2(例えばオゾンは53.5 μg/m³、二酸化窒素は13.4 μg/m³)で測定され、報告時には百万分の一(ppm)で測定されます。 濃度は index と globalIndexに入力される生の測定値です。
globalIndex

number (float)

この汚染物質の国際標準化大気質指数への寄与度は、 AirQuality.globalIndex と同じ0から300+スケールで反映されるため、各汚染物質の数値を地域間で比較できます。 値が高いほど、大気質悪化への寄与が大きいことを示します。 例えば、オゾンは22.1、二酸化窒素は6.7です。
index

number (float)

この汚染物質が調査対象地域の地方規制機関が設定した尺度における全体的な大気質指数(AQI)への寄与度。 AirQuality.indexと同じ局所スケールを使用しているため、生の数値は同じ場所の全体値と比較可能ですが、場所間で直接比較することはできません。例えば、全体がindex21.6(オゾンが支配的な汚染物質)の測定値に対してオゾンは21.6です。 背景については、ウィキペディアの 大気質指数 を参照してください。
name

string

この汚染物質は英語名でtypeと組み合わさっています。例えば、NO2は二酸化窒素、O3はオゾン、PM10は粒子状物質10、PM2.5は粒子状物質2.5、COは一酸化炭素、SO2は二酸化硫黄などです。 要求された言語に関係なく常に英語で返送されるため、ローカライズされたテキストが不要な場合でも安定した表示ラベルとして適しています。
type

PollutantType

汚染物質コードは、安定的で言語に依存しない識別子として使われ、 PollutantType 値の一つ(PM2.5、 PM10、 O3、 NO2、 SO2、 またはCO)です。 将来的には追加の汚染物質の種類が追加される可能性があります。

PollutantType

列挙

Azure Maps Weather Serviceが追跡する6種類の汚染物質の説明。

値 説明
CO

過去1時間の一酸化炭素(CO)の平均濃度(マイクログラム毎立方メートル、μg/m³)。

COは無色・無臭・無味ながらも、炭素含有燃料の不完全燃焼によって発生する非常に有毒なガスです。 一般的な発生源には、自動車の排気ガス、ガスストーブ、炉、薪の火などがあります。
NO2

過去1時間の二酸化窒素(NO2)の平均濃度(マイクログラム毎立方メートル、μg/m³)。

NO2は重要な大気汚染物質です。 これは規制されており、世界保健機関 (WHO) によって設定された推奨制限ガイドラインの対象となります。
O3

過去1時間のオゾン(O3)の平均濃度(マイクログラム毎立方メートル、μg/m³)。

O3は光化学スモッグの重要な成分であり、これは多くの大都市を包み込む茶色く有害な霞の原因で、太陽光と特定の汚染物質との光化学反応によって生じます。
PM2.5

過去1時間の直径2.5ミクロン未満の粒子の平均濃度(マイクログラム毎立方メートル(μg/m³)です。

PM2.5、別名エアロゾルは、微細な塵と空気中に浮遊する微細な液体の滴から成ります。
PM10

過去1時間で測定された直径2.5〜10ミクロンの粒子の平均濃度(マイクログラム/立方メートル(μg/m³)です。

粒子状物質10(PM10)、別名エアロゾルは、微細な粉塵と空気中に浮遊する微細な液体の滴から成ります。
SO2

過去1時間の二酸化硫黄(SO2)の平均濃度(マイクログラム/立方メートル単位、μg/m³)。

SO2は密度が高く無色の無機気体で、刺激的な臭いを放ちます。 主に発電所や工業施設での化石燃料の燃焼によって生産されますが、火山などの自然発生源からも排出されることがあります。

UnitType

列挙

表示されるユニットの種類に関連する整数値。 たとえば、摂氏の場合は 17、華氏の場合は 18 です。 単位の翻訳に使用できます。 詳細については、Azure Maps<>>の

値 説明
0

feet
1

inches
2

miles
3

millimeter
4

centimeter
5

測定
6

kilometer
7

kilometersPerHour
8

knots
9

milesPerHour
10

metersPerSecond
11

hectoPascals
12

inchesOfMercury
13

kiloPascals
14

millibars
15

millimetersOfMercury
16

poundsPerSquareInch
17

Celsius
18

Fahrenheit
19

kelvin
20

percent
21

float
22

整数
31

MicrogramsPerCubicMeterOfAir

WeatherValue

Object

気温、露点、風速などの気象関連指標の値は、単位URIパラメータで指定されたメートル法またはインペリアル単位で示されます。 詳細は「Azure Mapsの気象サービス」の「ユニットタイプ」をご覧ください。

Name 型 説明
unit

string

返還値に使われる単位、例えば「C」はCelsius、「F」は華氏(F)です。
unitType

UnitType

単位の種類を表す整数です。 例えば、0はフィート、1はインチ、2はマイルです。 完全なリストについては、「Azure MapsのWeather services」記事のユニットタイプをご覧ください。
value

number (float)

測定値は指定された単位で表されます。