Weather - Get Air Quality Daily Forecasts
汚染物質レベル、潜在的なリスク、推奨される予防措置を含む、今後 1 日から 7 日間の毎日の大気質予測を取得するために使用します。
API は Get Air Quality Daily Forecasts
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 |
応答の目的の形式。 サポートされているのは |
|
api-version
|
query | True |
string |
Azure Maps API のバージョン番号。 |
query
|
query | True |
number[] |
緯度の後に経度 (例: "47.641268,-122.125679" など) で構成されるコンマ区切り文字列として指定された該当するクエリ。 |
duration
|
query | 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 |
OK |
|
Other Status Codes |
予期しないエラーが発生しました。 |
セキュリティ
AADToken
これらは OAuth 2.0 フロー Microsoft Entraです。 Azure ロールベースのアクセス制御と組み合わせて使用すると、Azure Maps REST API へのアクセスを制御できます。 Azure ロールベースのアクセス制御は、1 つ以上のAzure Mapsリソース アカウントまたはサブリソースへのアクセスを指定するために使用されます。 REST API をAzure Mapsするための 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 プラットフォームの概要」を参照してください。
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
名前 | 説明 |
---|---|
https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
これは、Azure portalでAzure Maps アカウントをCreateするとき、または PowerShell、CLI、Azure SDK、または REST API を使用してプロビジョニングされる共有キーです。
このキーを使用すると、すべてのアプリケーションですべての REST API にアクセスできます。 つまり、このキーは、発行先のアカウントのマスター キーとして使用できます。
公開されているアプリケーションの場合は、機密クライアント アプリケーション のアプローチを使用して、キーを安全に格納できるように、Azure Maps REST API にアクセスすることをお勧めします。
Type:
apiKey
In:
query
SAS Token
これは、Azure portal、PowerShell、CLI、Azure SDK、または REST API を介して Azure 管理プレーンを介して、Azure Maps リソースの List SAS 操作から作成される共有アクセス署名トークンです。
このトークンを使用すると、すべてのアプリケーションが Azure ロールベースのアクセス制御を使用してアクセスし、特定のトークンに使用される有効期限、レート、およびリージョンに対するきめ細かい制御が許可されます。 言い換えると、SAS トークンを使用して、アプリケーションが共有キーよりもセキュリティで保護された方法でアクセスを制御できます。
公開されているアプリケーションの場合、 Map アカウント リソース で許可される配信元の特定のリストを構成して、レンダリングの不正使用を制限し、SAS トークンを定期的に更新することをお勧めします。
Type:
apiKey
In:
header
例
Get Daily Air Quality Forecasts
Sample Request
GET https://atlas.microsoft.com/weather/airQuality/forecasts/daily/json?api-version=1.1&query=47.632346,-122.13887&duration=3
Sample Response
{
"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."
}
]
}
定義
名前 | 説明 |
---|---|
Daily |
特定の時刻における特定の場所の大気質に関する情報。 |
Daily |
このオブジェクトは、毎日の大気質予測の取得に成功した呼び出しから返されます。 |
Daily |
空気の品質について知りたい日数を指定します。 使用可能な値は、1、2、3、4、5、6、および 7 です。 既定値は 1 です。 |
Dominant |
汚染物質の種類。 追加する場合もありますので、予めご了承ください。 |
Error |
リソース管理エラーの追加情報。 |
Error |
エラーの詳細。 |
Error |
エラー応答 |
Json |
応答の目的の形式。 サポートされているのは |
DailyAirQuality
特定の時刻における特定の場所の大気質に関する情報。
名前 | 型 | 説明 |
---|---|---|
category |
string |
要求された言語の空気質の 1 単語の説明。 たとえば、"Excellent" などです。 |
categoryColor |
string |
この空気質の結果のカテゴリに対応する一意の色。 |
dateTime |
string |
ISO 8601 形式で表示されている現在の観測値の日時 (2019-10-27T19:39:57-08:00 など)。 |
description |
string |
この空気質の説明は、要求された言語になります。 |
dominantPollutant |
最も濃度の高い汚染物質。 |
|
globalIndex |
number |
0 から 300 以上のスケールで国際的に正規化された空気品質評価。数値が高いほど、空気の品質が悪くなります。 |
index |
number |
ローカル規制機関によって設定されたスケールの大気質評価。 スケールは場所によって大きく異なる場合があります。 詳細については 、Wikipedia を参照してください。 |
DailyAirQualityForecastResult
このオブジェクトは、毎日の大気質予測の取得に成功した呼び出しから返されます。
名前 | 型 | 説明 |
---|---|---|
nextLink |
string |
は、返される機能の次のページへのリンクです。 最後のページの場合、このフィールドはありません。 |
results |
クエリ対象の場所に対するすべての毎日の大気質予測の一覧。 |
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 |
オゾン ("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 |
エラーの追加情報。 |
|
code |
string |
エラー コード。 |
details |
エラーの詳細です。 |
|
message |
string |
エラー メッセージ。 |
target |
string |
エラーのターゲット。 |
ErrorResponse
エラー応答
名前 | 型 | 説明 |
---|---|---|
error |
error オブジェクト。 |
JsonFormat
応答の目的の形式。 サポートされているのは json
形式のみです。
名前 | 型 | 説明 |
---|---|---|
json |
string |