Weather - Get Air Quality Daily Forecasts

汚染物質レベル、潜在的なリスク、推奨される予防措置を含む、今後 1 日から 7 日間の毎日の大気質予測を取得するために使用します。

Get Air Quality Daily Forecasts API は、汚染物質の濃度と予測される毎日の大気質の全体的な状態に関する詳細情報を返す HTTP GET 要求です。 このサービスでは、汚染レベル、大気質指数値、主要な汚染物質、リスク レベルと推奨される予防措置を要約した簡単な声明など、今後 1 日から 7 日間の予測された毎日の大気質情報を提供できます。

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

URI パラメーター

名前 / 必須 説明
format
path True

JsonFormat

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

api-version
query True

string

Azure Maps API のバージョン番号。

query
query True

number[]

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

duration
query

DailyDuration

int32

空気の質について知りたい日数を指定します。 使用可能な値は、1、2、3、4、5、6、7 です。 既定値は 1 です。

language
query

string

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

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

要求ヘッダー

名前 必須 説明
x-ms-client-id

string

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

応答

名前 説明
200 OK

DailyAirQualityForecastResult

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 を使用すると、複数のユース ケースに対するアプリケーションの構成ベースのセットアップが可能になります。

型: 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 Daily Air Quality Forecasts

要求のサンプル

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

応答のサンプル

{
  "results": [
    {
      "dateTime": "2021-07-18T07:00:00+00:00",
      "index": 35.1,
      "globalIndex": 42.2,
      "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."
    },
    {
      "dateTime": "2021-07-19T07:00:00+00:00",
      "index": 31.6,
      "globalIndex": 37,
      "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."
    },
    {
      "dateTime": "2021-07-20T07:00:00+00:00",
      "index": 33.6,
      "globalIndex": 40,
      "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."
    }
  ]
}

定義

名前 説明
DailyAirQuality

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

DailyAirQualityForecastResult

このオブジェクトは、毎日の大気質予測の取得に成功した呼び出しから返されます。

DailyDuration

空気の質について知りたい日数を指定します。 使用可能な値は、1、2、3、4、5、6、7 です。 既定値は 1 です。

DominantPollutant

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

ErrorAdditionalInfo

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

ErrorDetail

エラーの詳細。

ErrorResponse

エラー応答

JsonFormat

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

DailyAirQuality

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

名前 説明
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 を参照してください。

DailyAirQualityForecastResult

このオブジェクトは、毎日の大気質予測の取得に成功した呼び出しから返されます。

名前 説明
nextLink

string

は、返される機能の次のページへのリンクです。 最後のページの場合は、このフィールドはありません。

results

DailyAirQuality[]

クエリ対象の場所に対するすべての毎日の大気質予測の一覧。

DailyDuration

空気の質について知りたい日数を指定します。 使用可能な値は、1、2、3、4、5、6、7 です。 既定値は 1 です。

名前 説明
1

string

2

string

3

string

4

string

5

string

6

string

7

string

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 オブジェクト表記データ交換形式