Weather - Get Current Air Quality

リファレンス

サービス:: Maps

API バージョン:: 1.1

潜在的なリスクと推奨される予防措置を含む現在の大気質情報を取得するために使用します。

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

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

省略可能なパラメーターを含む:

GET https://atlas.microsoft.com/weather/airQuality/current/json?api-version=1.1&language={language}&query={query}&pollutants={pollutants}

URI パラメーター

名前	/	必須	型	説明
format	path	True	JsonFormat	応答の目的の形式。サポートされているのは `json` 形式のみです。
api-version	query	True	string	Azure Maps API のバージョン番号。
query	query	True	number[]	緯度の後に経度 (例: "47.641268,-122.125679" など) で構成されるコンマ区切り文字列として指定された該当するクエリ。
language	query		string	検索結果を返す言語。サポートされている IETF 言語タグの 1 つである必要があります。大文字と小文字は区別されません。指定した言語のデータが特定のフィールドで使用できない場合は、既定の言語が使用されます。詳細については、「サポートされている言語」を参照してください。
pollutants	query		boolean	各汚染物質に関する詳細情報を返すブール値。既定では True です。

要求ヘッダー

名前	必須	型	説明
x-ms-client-id		string	Microsoft Entra ID セキュリティモデルと組み合わせて使用するアカウントを指定します。これは Azure Maps アカウントの一意の ID を表し、Azure Maps 管理プレーンアカウント API から取得できます。 Azure Maps で Microsoft Entra ID セキュリティを使用するには、ガイダンスについては、次の記事を参照してください。

応答

名前	型	説明
200 OK	AirQualityResult	OK
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 とスコープに対するアクセス制御が可能なオブジェクトを使用してアプリケーションをモデル化するためのソリューションを提供します。

メモ

このセキュリティ定義では、ヘッダーを x-ms-client-id 使用して、アプリケーションがアクセスを要求している 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

スコープ

名前	説明
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

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

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

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

型: apiKey
/: query

SAS Token

これは、Azure portal、PowerShell、CLI、Azure SDK、または REST API を使用して、Azure 管理プレーンを介して Azure Maps リソースの SAS の一覧表示操作から作成される共有アクセス署名トークンです。

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

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

型: apiKey
/: header

例

Get Current Air Quality

要求のサンプル

HTTP

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

応答のサンプル

状態コード:: 200

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

定義

名前	説明
AirQuality	特定の時刻における特定の場所の大気質に関する情報。
AirQualityResult	このオブジェクトは、成功した Get Air Quality 呼び出しから返されます。
DominantPollutant	汚染物質の種類。随時追加される場合がありますのでご注意ください。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
JsonFormat	応答の目的の形式。サポートされているのは `json` 形式のみです。
Pollutant	個々の汚染物質に関する詳細情報。 =false の場合 `pollutants`は返されません。
PollutantType	汚染物質の種類。随時追加される場合がありますのでご注意ください。
UnitType	表示される単位の種類に関連付けられている数値 ID 値。単位変換に使用できます。詳細については、「 Azure Maps の Weather サービス」を参照してください。
WeatherUnit	天気に関連する特定の単位の特定の値。

AirQuality

特定の時刻における特定の場所の大気質に関する情報。

名前	型	説明
category	string	要求された言語での大気質の 1 単語の説明。たとえば、"Excellent" などです。
categoryColor	string	この空気質の結果のカテゴリに対応する一意の色。
dateTime	string	ISO 8601 形式で表示されている現在の観測値の日付と時刻 (例: 2019-10-27T19:39:57-08:00)。
description	string	この大気質のテキストによる説明は、要求された言語になります。
dominantPollutant	DominantPollutant	最も高い濃度の汚染物質。
globalIndex	number	0 ~ 300 以上のスケールで国際的に正規化された大気質評価。数値が高いほど、空気の質が悪くなります。
index	number	ローカル規制機関によるスケールセットの大気質評価。スケールは場所によって大きく異なる場合があります。詳細については、Wikipedia を参照してください。
pollutants	Pollutant[]	個々の汚染物質に関する情報。

AirQualityResult

このオブジェクトは、成功した Get Air Quality 呼び出しから返されます。

名前	型	説明
nextLink	string	は、返される機能の次のページへのリンクです。最後のページの場合は、このフィールドはありません。
results	AirQuality[]	クエリ対象の場所のすべての大気質の結果の一覧。

DominantPollutant

汚染物質の種類。随時追加される場合がありますのでご注意ください。

名前	型	説明
Carbon Monoxide	string	一酸化炭素 ("CO")
Nitrogen Dioxide	string	二酸化窒素 ("NO2")
Ozone	string	Zone ("O3")
Particulate Matter 10	string	粒子状物質 10 ("PM10")
Particulate Matter 2.5	string	粒子状物質 2.5 ("PM2.5")
Sulfur Dioxide	string	二酸化硫黄 ("SO2")

ErrorAdditionalInfo

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

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラーコード。
details	ErrorDetail[]	エラーの詳細です。
message	string	エラーメッセージ。
target	string	エラーのターゲット。

ErrorResponse

エラー応答

名前	型	説明
error	ErrorDetail	error オブジェクト。

JsonFormat

応答の目的の形式。サポートされているのは json 形式のみです。

名前	型	説明
json	string	JavaScript オブジェクト表記データ交換形式

Pollutant

個々の汚染物質に関する詳細情報。 =false の場合 pollutantsは返されません。

名前	型	説明
concentration	WeatherUnit	空気の体積あたりの汚染物質粒子の数を含むオブジェクト。
globalIndex	number	0 ~ 300 以上のスケールで国際的に正規化された大気質評価。数値が高いほど、空気の質が悪くなります。
index	number	ローカル規制機関によるスケールセットの大気質評価。スケールは場所によって大きく異なる場合があります。詳細については、Wikipedia を参照してください。
name	string	英語の汚染物質の名前。
type	PollutantType	汚染物質の種類。随時追加される場合がありますのでご注意ください。

PollutantType