Weather - Get Weather Along Route

を使用して、ルートに沿った気象災害評価と通知を含む、正確で正確な分単位の予測を取得します。

Get Weather Along Route API は、一連のウェイポイントとして記述されたルートに沿って、ハイパーローカル (1 キロメートル以下)、最大分の天気予報、気象の危険性評価、通知を返す HTTP GET 要求です。 これには、ウェイポイントまたはルートに影響を与える気象の危険性の一覧が含まれます。また、各ウェイポイントの集計された危険度インデックスを使用して、ドライバーの安全性に応じてルートの各部分を描画できます。 ウェイポイントを提出する場合は、120 分以内または直後に移動できる距離内または近くに滞在することをお勧めします。 データは 5 分ごとに更新されます。

このサービスは、最初に配信元と宛先の間のルートを要求し、Weather Along Route エンドポイントの入力として使用できるようにする Azure Maps Route Service を補完します。

さらに、このサービスでは、気象災害の強度が増加するウェイポイントの気象通知を生成するシナリオがサポートされています。 たとえば、車両がウェイポイントに達すると大雨が発生し始めると予想される場合は、そのウェイポイントに対して大雨の気象通知が生成され、ドライバーがそのウェイポイントに到達する前に、最終製品に大雨の通知が表示されます。 ウェイポイントの通知を表示するタイミングのトリガーは、 たとえばジオフェンスに基づくか、ウェイポイントまでの距離を選択できます。

この API は、グリーンランドと南極の上の緯度を除く惑星のすべてのリージョンを対象としています。

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

URI パラメーター

名前 / 必須 説明
format
path True

JsonFormat

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

api-version
query True

string

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

query
query True

string

ルートが計算される座標をコロン (:)で区切り、時系列順に入力します。 少なくとも 2 つのウェイポイントが必要です。 1 つの API 呼び出しには、最大 60 個のウェイポイントが含まれる場合があります。 ウェイポイントは、場所、ETA、および省略可能な見出しを示します。緯度、経度、ETA、見出し、場所

  • Latitude - 緯度座標 (10 進度)。
  • Longitude - 経度座標 (10 進度)。
  • ETA (estimated time of arrival) - 車両がウェイポイントに到達するまでに要する現在の時刻からの分数。 使用できる範囲は 0.0 から 120.0 分です。
  • Heading - ウェイポイントを通過するときの車両の見出しを示す省略可能な値。 真北に対する時計回りの角度で表されます。 これは、運転の危険として太陽のまぶしさを計算するために発行されます。 使用できる範囲は 0.0 ~ 360.0 度です。 指定しない場合、見出しは隣接するウェイポイントの位置に基づいて自動的に派生します。

120分以内または間もなく移動できる距離の範囲内または近くに滞在することをお勧めします。 これにより、旅行に対してより正確な評価を提供し、ウェイポイント間で分離されたイベントがキャプチャされないようにすることができます。 情報は、ルート (特に 2 時間を超える乗車) に沿って更新して、新しいウェイポイントを継続的に引き出すことができます。また、降水量の種類や強度などのコンテンツの予測情報が、時間の経過と共に嵐が発生して散逸する際に正確であることを確認することもできます。

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

WeatherAlongRouteResult

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

Successfully retrieve detailed weather casts along a route described as a sequence of waypoints

要求のサンプル

GET https://atlas.microsoft.com/weather/route/json?api-version=1.1&query=38.907,-77.037,0:38.907,-77.009,10:38.926,-76.928,20:39.033,-76.852,30:39.168,-76.732,40:39.269,-76.634,50:39.287,-76.612,60

応答のサンプル

{
  "summary": {
    "iconCode": 35,
    "hazards": {
      "maxHazardIndex": 0
    }
  },
  "waypoints": [
    {
      "iconCode": 38,
      "shortPhrase": "Mostly cloudy",
      "isDayTime": false,
      "cloudCover": 70,
      "temperature": {
        "value": 3.4,
        "unit": "C",
        "unitType": 17
      },
      "wind": {
        "direction": {
          "degrees": 142
        },
        "speed": {
          "value": 2,
          "unit": "km/h",
          "unitType": 7
        }
      },
      "windGust": {
        "speed": {
          "value": 3,
          "unit": "km/h",
          "unitType": 7
        }
      },
      "precipitation": {
        "dbz": 0,
        "type": "SNOW"
      },
      "lightningCount": 0,
      "sunGlare": {
        "calculatedVehicleHeading": 90,
        "glareIndex": 0
      },
      "hazards": {
        "maxHazardIndex": 0
      },
      "notifications": []
    },
    {
      "iconCode": 38,
      "shortPhrase": "Mostly cloudy",
      "isDayTime": false,
      "cloudCover": 65,
      "temperature": {
        "value": 3.4,
        "unit": "C",
        "unitType": 17
      },
      "wind": {
        "direction": {
          "degrees": 166
        },
        "speed": {
          "value": 1,
          "unit": "km/h",
          "unitType": 7
        }
      },
      "windGust": {
        "speed": {
          "value": 2,
          "unit": "km/h",
          "unitType": 7
        }
      },
      "precipitation": {
        "dbz": 0,
        "type": "SNOW"
      },
      "lightningCount": 0,
      "sunGlare": {
        "calculatedVehicleHeading": 77,
        "glareIndex": 0
      },
      "hazards": {
        "maxHazardIndex": 0
      },
      "notifications": []
    },
    {
      "iconCode": 35,
      "shortPhrase": "Partly cloudy",
      "isDayTime": false,
      "cloudCover": 43,
      "temperature": {
        "value": 3.2,
        "unit": "C",
        "unitType": 17
      },
      "wind": {
        "direction": {
          "degrees": 163
        },
        "speed": {
          "value": 2,
          "unit": "km/h",
          "unitType": 7
        }
      },
      "windGust": {
        "speed": {
          "value": 2,
          "unit": "km/h",
          "unitType": 7
        }
      },
      "precipitation": {
        "dbz": 0,
        "type": "SNOW"
      },
      "lightningCount": 0,
      "sunGlare": {
        "calculatedVehicleHeading": 44,
        "glareIndex": 0
      },
      "hazards": {
        "maxHazardIndex": 0
      },
      "notifications": []
    },
    {
      "iconCode": 35,
      "shortPhrase": "Partly cloudy",
      "isDayTime": false,
      "cloudCover": 34,
      "temperature": {
        "value": 1.6,
        "unit": "C",
        "unitType": 17
      },
      "wind": {
        "direction": {
          "degrees": 189
        },
        "speed": {
          "value": 2,
          "unit": "km/h",
          "unitType": 7
        }
      },
      "windGust": {
        "speed": {
          "value": 4,
          "unit": "km/h",
          "unitType": 7
        }
      },
      "precipitation": {
        "dbz": 0,
        "type": "SNOW"
      },
      "lightningCount": 0,
      "sunGlare": {
        "calculatedVehicleHeading": 32,
        "glareIndex": 0
      },
      "hazards": {
        "maxHazardIndex": 0
      },
      "notifications": []
    },
    {
      "iconCode": 38,
      "shortPhrase": "Mostly cloudy",
      "isDayTime": false,
      "cloudCover": 54,
      "temperature": {
        "value": 0.5,
        "unit": "C",
        "unitType": 17
      },
      "wind": {
        "direction": {
          "degrees": 202
        },
        "speed": {
          "value": 4,
          "unit": "km/h",
          "unitType": 7
        }
      },
      "windGust": {
        "speed": {
          "value": 5,
          "unit": "km/h",
          "unitType": 7
        }
      },
      "precipitation": {
        "dbz": 0,
        "type": "SNOW"
      },
      "lightningCount": 0,
      "sunGlare": {
        "calculatedVehicleHeading": 36,
        "glareIndex": 0
      },
      "hazards": {
        "maxHazardIndex": 0
      },
      "notifications": []
    },
    {
      "iconCode": 35,
      "shortPhrase": "Partly cloudy",
      "isDayTime": false,
      "cloudCover": 46,
      "temperature": {
        "value": 2.4,
        "unit": "C",
        "unitType": 17
      },
      "wind": {
        "direction": {
          "degrees": 222
        },
        "speed": {
          "value": 4,
          "unit": "km/h",
          "unitType": 7
        }
      },
      "windGust": {
        "speed": {
          "value": 5,
          "unit": "km/h",
          "unitType": 7
        }
      },
      "precipitation": {
        "dbz": 0,
        "type": "SNOW"
      },
      "lightningCount": 0,
      "sunGlare": {
        "calculatedVehicleHeading": 38,
        "glareIndex": 0
      },
      "hazards": {
        "maxHazardIndex": 0
      },
      "notifications": []
    },
    {
      "iconCode": 35,
      "shortPhrase": "Partly cloudy",
      "isDayTime": false,
      "cloudCover": 39,
      "temperature": {
        "value": 2.3,
        "unit": "C",
        "unitType": 17
      },
      "wind": {
        "direction": {
          "degrees": 231
        },
        "speed": {
          "value": 4,
          "unit": "km/h",
          "unitType": 7
        }
      },
      "windGust": {
        "speed": {
          "value": 5,
          "unit": "km/h",
          "unitType": 7
        }
      },
      "precipitation": {
        "dbz": 0,
        "type": "SNOW"
      },
      "lightningCount": 0,
      "sunGlare": {
        "calculatedVehicleHeading": 43,
        "glareIndex": 0
      },
      "hazards": {
        "maxHazardIndex": 0
      },
      "notifications": []
    }
  ]
}

定義

名前 説明
ErrorAdditionalInfo

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

ErrorDetail

エラーの詳細。

ErrorResponse

エラー応答

HazardDetail
HazardIndex

重大度/危険度インデックス。

  • 0 - 危険はありません。
  • 1 - 通知を受け取り、注意してください。
  • 2 - 注意を払って、準備してください。
  • 3 - アクションを実行します。
  • 4 - 生命を脅かす、緊急事態。
IconCode

を表示 iconPhraseするイメージを表す数値。 詳細については、「 Azure Maps の Weather サービス 」を参照してください。

JsonFormat

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

SunGlare

ドライバーの太陽がどれだけ盲目であるかを示す評価。

UnitType

表示される単位の種類に関連付けられている数値 ID 値。 単位変換に使用できます。 詳細については、「 Azure Maps の Weather サービス 」を参照してください。

WeatherAlongRoutePrecipitation

ルートに沿った天気の降水予測。

WeatherAlongRouteResult

このオブジェクトは、成功した Weather Along Route から返されます。

WeatherAlongRouteSummary

ルートに沿った天気の短い要約。

WeatherHazards

旅行に影響を与える気象災害の説明。

WeatherNotification
WeatherUnit

気象に関連する特定の単位の特定の値。

WeatherWaypoint
WindDetails

速度と方向を含む風の詳細が返されます。

WindDirection

風向

ErrorAdditionalInfo

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

名前 説明
info

object

追加情報。

type

string

追加情報の種類。

ErrorDetail

エラーの詳細。

名前 説明
additionalInfo

ErrorAdditionalInfo[]

エラーの追加情報。

code

string

エラー コード。

details

ErrorDetail[]

エラーの詳細です。

message

string

エラー メッセージ。

target

string

エラーのターゲット。

ErrorResponse

エラー応答

名前 説明
error

ErrorDetail

error オブジェクト。

HazardDetail

名前 説明
hazardCode

string

危険の種類ごとに一意の識別子 (表示不可): LightRain、 ModerateRain、HeavyRain、LightMix、ModerateMix、HeavyMix、LightSnow、ModerateSnow、HeavySnow、LightIce、ModerateIce、HeavyIce、Hail、LargeHail、SunGlare、SunGlareHigh、Lightning、SevereLightning、WindModerate、WindHigh、WindExtreme、FloodWarning、FlashFloodWarning、TornadoWarning、TsunamiWarning、SevereThunderstormWarning。

hazardIndex

HazardIndex

重大度/危険度インデックス。

  • 0 - 危険はありません。
  • 1 - 通知を受け取り、注意してください。
  • 2 - 注意を払って、準備してください。
  • 3 - アクションを実行します。
  • 4 - 生命を脅かす、緊急事態。
shortPhrase

string

予測された条件と降水強度/種類を記述する表示可能な短い語句。

HazardIndex

重大度/危険度インデックス。

  • 0 - 危険はありません。
  • 1 - 通知を受け取り、注意してください。
  • 2 - 注意を払って、準備してください。
  • 3 - アクションを実行します。
  • 4 - 生命を脅かす、緊急事態。
名前 説明
0

Integer

1

Integer

2

Integer

3

Integer

4

Integer

IconCode

を表示 iconPhraseするイメージを表す数値。 詳細については、「 Azure Maps の Weather サービス 」を参照してください。

名前 説明
1

Integer

10

Integer

11

Integer

12

Integer

13

Integer

14

Integer

15

Integer

16

Integer

17

Integer

18

Integer

19

Integer

2

Integer

20

Integer

21

Integer

22

Integer

23

Integer

24

Integer

25

Integer

26

Integer

27

Integer

28

Integer

29

Integer

3

Integer

30

Integer

31

Integer

32

Integer

33

Integer

34

Integer

35

Integer

36

Integer

37

Integer

38

Integer

39

Integer

4

Integer

40

Integer

41

Integer

42

Integer

43

Integer

44

Integer

5

Integer

6

Integer

7

Integer

8

Integer

9

Integer

JsonFormat

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

名前 説明
json

string

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

SunGlare

ドライバーの太陽がどれだけ盲目であるかを示す評価。

名前 説明
calculatedVehicleHeading

integer

ウェイポイントに車両の見出し値が指定されていない場合、サービスは、指定された場合、近隣のウェイポイントの位置に基づいて見出しを計算します。

glareIndex

integer

ドライバーの太陽のまぶしさを示す 0 ~ 100 のインデックス。 値 50 以上は一部のドライバーにとって危険と見なされ、値 100 はドライバーが太陽にまっすぐに運転していることを意味し、大気の状態は明らかであるため、太陽の全強度がドライバーを盲目にすることができます。

UnitType

表示される単位の種類に関連付けられている数値 ID 値。 単位変換に使用できます。 詳細については、「 Azure Maps の Weather サービス 」を参照してください。

名前 説明
0

Integer

1

Integer

10

Integer

11

Integer

12

Integer

13

Integer

14

Integer

15

Integer

16

Integer

17

Integer

18

Integer

19

Integer

2

Integer

20

Integer

21

Integer

22

Integer

3

Integer

31

Integer

4

Integer

5

Integer

6

Integer

7

Integer

8

Integer

9

Integer

WeatherAlongRoutePrecipitation

ルートに沿った天気の降水予測。

名前 説明
dbz

number

dBZ の予測降水強度 (Z に対するデシベル) を 0.0 から 100.0 に予測しました。

type

string

降水の種類。 降水量が発生する場合は、"RAIN"、"HAIL"、"SNOW"、"ICE"、または "MIX" の種類になります。

WeatherAlongRouteResult

このオブジェクトは、成功した Weather Along Route から返されます。

名前 説明
summary

WeatherAlongRouteSummary

ルートに沿った天気の短い要約。

waypoints

WeatherWaypoint[]

要求で指定されたのと同じ順序で返される各ウェイポイントのデータ。

WeatherAlongRouteSummary

ルートに沿った天気の短い要約。

名前 説明
hazards

WeatherHazards

旅行に影響を与える気象災害の説明。

iconCode

IconCode

を表示 iconPhraseするイメージを表す数値。 詳細については、「 Azure Maps の Weather サービス 」を参照してください。

WeatherHazards

旅行に影響を与える気象災害の説明。

名前 説明
hazardDetails

HazardDetail[]

旅行に影響を与える気象の危険性の詳細。

maxHazardIndex

HazardIndex

重大度/危険度インデックス。

  • 0 - 危険はありません。
  • 1 - 通知を受け取り、注意してください。
  • 2 - 注意を払って、準備してください。
  • 3 - アクションを実行します。
  • 4 - 生命を脅かす、緊急事態。

WeatherNotification

名前 説明
hazardCode

string

危険の種類ごとに一意の識別子 (表示不可): LightRain、 ModerateRain、HeavyRain、LightMix、ModerateMix、HeavyMix、LightSnow、ModerateSnow、HeavySnow、LightIce、ModerateIce、HeavyIce、Hail、LargeHail、SunGlare、SunGlareHigh、Lightning、SevereLightning、WindModerate、WindHigh、WindExtreme、FloodWarning、FlashFloodWarning、TornadoWarning、TsunamiWarning、SevereThunderstormWarning。

hazardIndex

HazardIndex

重大度/危険度インデックス。

  • 0 - 危険はありません。
  • 1 - 通知を受け取り、注意してください。
  • 2 - 注意を払って、準備してください。
  • 3 - アクションを実行します。
  • 4 - 生命を脅かす、緊急事態。
shortPhrase

string

予測された条件と降水強度/種類を記述する表示可能な短い語句。

type

string

危険の発症を警告したり、危険の強度を増加させたりするために生成される通知の種類。

WeatherUnit

気象に関連する特定の単位の特定の値。

名前 説明
unit

string

戻り値の単位の型。

unitType

UnitType

表示される単位の種類に関連付けられている数値 ID 値。 単位変換に使用できます。 詳細については、「 Azure Maps の Weather サービス 」を参照してください。

value

number

丸められた値。

WeatherWaypoint

名前 説明
cloudCover

integer

クラウド カバーを表す割合。

hazards

WeatherHazards

旅行に影響を与える気象災害の説明。

iconCode

IconCode

を表示 iconPhraseするイメージを表す数値。 詳細については、「 Azure Maps の Weather サービス 」を参照してください。

isDayTime

boolean

1 日の時刻を示します。 True は 'day' を示し、false は 'night' を示します。

lightningCount

integer

オープンスケールでの雷雨強度の推定。 値 0 は、雷雨がないことを意味します。1 以上の値は、強度の増加に雷雨があることを意味します。

notifications

WeatherNotification[]

気象災害に関する通知の一覧。

precipitation

WeatherAlongRoutePrecipitation

ルートに沿った天気の降水予測。

shortPhrase

string

予測された条件と降水強度/種類を記述する表示可能な短い語句。

sunGlare

SunGlare

ドライバーの太陽がどれだけ盲目であるかを示す評価。

temperature

WeatherUnit

気象に関連する特定の単位の特定の値。

wind

WindDetails

速度と方向を含む風の詳細が返されます。

windGust

WindDetails

速度と方向を含む風の詳細が返されます。

WindDetails

速度と方向を含む風の詳細が返されます。

名前 説明
direction

WindDirection

風向

speed

WeatherUnit

指定した単位の風の速度。

WindDirection

風向

名前 説明
degrees

integer

方位角の風向き。真北から始まり、時計回りの方向に続きます。 北は 0 度、東は 90 度、南は 180 度、西は 270 度です。 指定できる値は 0 から 359 です。

localizedDescription

string

指定した言語の方向の省略形。