Weather - Get Minute Forecast

1 分、5 分、15 分間隔で次の 120 分間の分単位の予報を取得するために使用します。
Get Minute Forecast API は、特定の場所の今後 120 分間の分単位の予報を返す HTTP GET リクエストです。 ユーザーは、1 分、5 分、15 分の間隔で気象予測を要求できます。 応答には、降水の種類(雨、雪、またはその両方の混合を含む)、開始時間、降水強度値(dBZ)などの詳細が含まれます。 詳細については、「 分単位の天気予報データを要求する」を参照してください。

GET {endpoint}/weather/forecast/minute/json?api-version=1.1&query={query}
GET {endpoint}/weather/forecast/minute/json?api-version=1.1&query={query}&interval={interval}&language={language}

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 海里以内の海域で利用できます。

interval
query

integer (int32)

返される天気予報の時間間隔を分単位で指定します。 サポートされている値は次のとおりです

  • 1 - 1 分間隔の予測を取得します。 既定で返されます。
  • 5 - 5 分間隔の予測を取得します。
  • 15 - 15 分間隔の予測を取得します。
language
query

string

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

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

要求ヘッダー

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

MinuteForecastResult

要求は成功しました。

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

例

Successfully retrieve minute-by-minute forecasts for a given location

要求のサンプル

GET https://atlas.microsoft.com/weather/forecast/minute/json?api-version=1.1&query=47.632346,-122.138874&interval=15

応答のサンプル

{
  "intervalSummaries": [
    {
      "briefPhrase": "Rain ending in %minute_value min",
      "endMinute": 24,
      "iconCode": 12,
      "longPhrase": "Rain ending in %minute_value min",
      "shortPhrase": "Rain ending in %minute_value min",
      "startMinute": 0,
      "totalMinutes": 25
    },
    {
      "briefPhrase": "No precipitation for at least %MINUTE_VALUE min",
      "endMinute": 119,
      "iconCode": 7,
      "longPhrase": "No precipitation for at least %MINUTE_VALUE min",
      "shortPhrase": "No precip for %MINUTE_VALUE min",
      "startMinute": 25,
      "totalMinutes": 95
    }
  ],
  "intervals": [
    {
      "cloudCover": 100,
      "color": {
        "blue": 2,
        "green": 98,
        "hex": "#086202",
        "red": 8
      },
      "dbz": 23,
      "iconCode": 12,
      "minute": 0,
      "precipitationType": "Rain",
      "shortPhrase": "Light Rain",
      "simplifiedColor": {
        "blue": 39,
        "green": 190,
        "hex": "#23BE27",
        "red": 35
      },
      "startTime": "2019-11-14T15:18:00-08:00",
      "threshold": "LIGHT"
    },
    {
      "cloudCover": 100,
      "color": {
        "blue": 9,
        "green": 133,
        "hex": "#208509",
        "red": 32
      },
      "dbz": 18,
      "iconCode": 12,
      "minute": 15,
      "precipitationType": "Rain",
      "shortPhrase": "Light Rain",
      "simplifiedColor": {
        "blue": 39,
        "green": 190,
        "hex": "#23BE27",
        "red": 35
      },
      "startTime": "2019-11-14T15:33:00-08:00",
      "threshold": "LIGHT"
    },
    {
      "cloudCover": 100,
      "dbz": 0,
      "iconCode": 7,
      "minute": 30,
      "shortPhrase": "No Precipitation",
      "startTime": "2019-11-14T15:48:00-08:00"
    },
    {
      "cloudCover": 100,
      "dbz": 0,
      "iconCode": 7,
      "minute": 45,
      "shortPhrase": "No Precipitation",
      "startTime": "2019-11-14T16:03:00-08:00"
    },
    {
      "cloudCover": 100,
      "dbz": 0,
      "iconCode": 7,
      "minute": 60,
      "shortPhrase": "No Precipitation",
      "startTime": "2019-11-14T16:18:00-08:00"
    },
    {
      "cloudCover": 100,
      "dbz": 0,
      "iconCode": 7,
      "minute": 75,
      "shortPhrase": "No Precipitation",
      "startTime": "2019-11-14T16:33:00-08:00"
    },
    {
      "cloudCover": 100,
      "dbz": 0,
      "iconCode": 7,
      "minute": 90,
      "shortPhrase": "No Precipitation",
      "startTime": "2019-11-14T16:48:00-08:00"
    },
    {
      "cloudCover": 100,
      "dbz": 0,
      "iconCode": 7,
      "minute": 105,
      "shortPhrase": "No Precipitation",
      "startTime": "2019-11-14T17:03:00-08:00"
    }
  ],
  "summary": {
    "briefPhrase": "Rain ending in 25 min",
    "briefPhrase60": "Rain ending in 25 min",
    "iconCode": 12,
    "longPhrase": "Rain ending in 25 min",
    "shortPhrase": "Rain ending in 25 min"
  }
}

定義

Name 説明
ColorValue

RGBカラーは成分(red、 green、 blue)および十六進数(hex)形式で返されます。 分単位の予報で各区間をレーダースタイル表示に表示するために使用されます。dbzにマッピングされた全スペクトル色についてはForecastInterval.color、precipitationTypeおよびthresholdから派生した粗い色についてはForecastInterval.simplifiedColorを参照してください。 基となる色のマッピングについては、Azure Mapsの気象サービスをご覧ください。

ErrorAdditionalInfo

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

ErrorDetail

エラーの詳細。

ErrorResponse

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

ForecastInterval

分単位の予報内の単一の時間断片を表し、その区間における予想される気象条件を記述します。 各間隔は1分、5分、または15分で、要求される解像度に応じて、開始時刻、降水強度(dbz)、降水の種類と閾値、短い説明文、アイコンコード、雲の被覆、そしてレーダースタイルディスプレイで状況を視覚的に表現するための全スペクトル色と簡略化された色が含まれます。

IconCode

どのアイコンを表示するかを示す数値の天候コードです。 この列挙の各値は、晴れ、雲、雷雨などのAzure Maps天気アイコンに対応し、人間が読み取れる返iconPhraseと組み合わされます。 同じコードは、現在、時間ごとの、日次、四半日、分単位の応答に現れることがあり、アプリケーションはすべての気象サービスで一貫したアイコンセットを表示できます。

コードの完全なリスト、それらがマッピングするアイコン、例の画像については、Azure Mapsの気象サービスをご覧ください。

IntervalSummary

分単位の予報内の連続したウィンドウの天気見通しを記述します。通常は 、25分後に雨が終わる 、または 10分後に始まる軽い雪のような類似した条件の連続です。 各サマリーは予報開始時(startMinute、 endMinute、 totalMinutes)までの分単位のウィンドウを指定し、3つの長さ(短、簡潔、長)のフレーズ説明を提供し、利用可能なUIスペースに応じた適切な詳細レベルを表示できるようにし、代表的な天気アイコンの用に使う iconCode も含まれています。 MinuteForecastResultは、予測期間をカバーする1つ以上のIntervalSummary項目を返します。

JsonFormat

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

MinuteForecastResult

応答は「Get Minute Forecast」操作によって返され、指定された場所の今後120分間の降水見通しを要求された解像度(1分、5分、または15分)で提供しました。 応答は3層に分かれています。全体のフレーズ説明と期間中の代表アイコンを含む全体summary、連続した分を類似条件の長い区間(例:雨が25分で終わるなど)にまとめるintervalSummariesアレイ、そして降水強度(dbz)、降水量の種類、雲量、レーダースタイルの可視化に使われる色などの詳細な1分ごとの予報ポイントを含むintervalsアレイです。

MinuteForecastSummary

今後の分単位の降水見通しを説明するフレーズ要約を提供します。 複数のフレーズ長(短(~25文字)、簡短(~60文字)、長(60+文字)が含まれており、アプリケーションは利用可能なUI空間に最適な詳細レベルを表示できます。 iconCodeはその時代の象徴的な天気アイコンを示します。

PrecipitationType

降水のタイプを指定します。 有効な値は雨、雪、氷、または混合です。 このプロパティは、dBZ が 0 より大きい場合の応答に含まれます。

ColorValue

RGBカラーは成分(red、 green、 blue)および十六進数(hex)形式で返されます。 分単位の予報で各区間をレーダースタイル表示に表示するために使用されます。dbzにマッピングされた全スペクトル色についてはForecastInterval.color、precipitationTypeおよびthresholdから派生した粗い色についてはForecastInterval.simplifiedColorを参照してください。 基となる色のマッピングについては、Azure Mapsの気象サービスをご覧ください。

Name 型 説明
blue

integer (int32)

RGB値の青成分です。 有効な値は0から255の範囲です。

green

integer (int32)

RGB 値の緑色のコンポーネント。 有効な値は0から255の範囲です。

hex

string

#で接頭辞がついた16進数RGB文字列と同じ色、例えば赤の #FF0000。

red

integer (int32)

RGB 値の赤のコンポーネント。 有効な値は0から255の範囲です。

ErrorAdditionalInfo

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

Name 型 説明
info

追加情報。

type

string

追加情報の種類。

ErrorDetail

エラーの詳細。

Name 型 説明
additionalInfo

ErrorAdditionalInfo[]

エラーの追加情報。

code

string

エラー コード。

details

ErrorDetail[]

エラーの詳細。

message

string

エラー メッセージ。

target

string

エラーターゲット。

ErrorResponse

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

Name 型 説明
error

ErrorDetail

エラー オブジェクト。

ForecastInterval

分単位の予報内の単一の時間断片を表し、その区間における予想される気象条件を記述します。 各間隔は1分、5分、または15分で、要求される解像度に応じて、開始時刻、降水強度(dbz)、降水の種類と閾値、短い説明文、アイコンコード、雲の被覆、そしてレーダースタイルディスプレイで状況を視覚的に表現するための全スペクトル色と簡略化された色が含まれます。

Name 型 説明
cloudCover

integer (int32)

この期間中の空の雲に覆われる割合は、0(晴れ)から100(曇り)までのことです。 NULL である可能性があります。

color

ColorValue

dbzにマッピングされる全スペクトル色で、レーダースタイルのディスプレイでこの区間をレンダリングするために使われていました。 dbzがゼロより大きい場合にのみ返されます。

dbz

number (double)

降水強度の指標として用いられる、Zに対するデシベル(dBZ)でのレーダー反射率の予測。 値が高いほど降水量が多いことを示します。値が0の場合は降水がないことを示します。

iconCode

IconCode

この間隔の代表的な天気アイコンコード。 数値はAzure Mapsの天気アイコンに対応しており、完全なリストについては「Azure Mapsの気象サービス」をご覧ください。

minute

integer (int32)

この予報間隔の開始は、予報開始時(分0)から数分数で表されます。 startTimeとペアを組み、対応するIntervalSummaryのstartMinuteフィールドと一致します。

precipitationType

PrecipitationType

この期間に予想される降水の種類は、 雨、 雪、 氷、 または混合のいずれかです。 dbzがゼロより大きい場合にのみ返されます。

shortPhrase

string

この期間中の降水条件を表す短いフレーズ(例: 小雨)。 最大で約25文字まで。

simplifiedColor

ColorValue

precipitationTypeとthresholdから派生した簡略化された色で、dBZの全色スペクトルではなく、素早く読みやすいレーダー可視化を必要とするUIに適しています。 dbzがゼロより大きい場合にのみ返されます。

startTime

string (date-time)

この予報区間の開始は RFC 3339 形式(yyyy-mm-ddThh:mm:ss±hh:mm)。 例えば、 2019-11-14T15:18:00-08:00です。

threshold

string

現在の precipitationType で降水が含まれる強度バケット(例えば、 軽度、 中度、 重度)です。 precipitationTypeと共に使用して、simplifiedColorを決定します。 dbzがゼロより大きい場合にのみ返されます。

IconCode

どのアイコンを表示するかを示す数値の天候コードです。 この列挙の各値は、晴れ、雲、雷雨などのAzure Maps天気アイコンに対応し、人間が読み取れる返iconPhraseと組み合わされます。 同じコードは、現在、時間ごとの、日次、四半日、分単位の応答に現れることがあり、アプリケーションはすべての気象サービスで一貫したアイコンセットを表示できます。

コードの完全なリスト、それらがマッピングするアイコン、例の画像については、Azure Mapsの気象サービスをご覧ください。

値 説明
1

Sunny

2

晴れ一時曇り

3

晴れ時々曇り

4

晴れたり曇ったり

5

薄晴れ

6

ほとんど曇り

7

Cloudy

8

どんよりした (曇り)

11

Fog

12

Showers

13

曇り一時小雨

14

晴れ時々小雨

15

Thunderstorms

16

曇り一時雷雨

17

晴れ時々雷雨

18

Rain

19

Flurries

20

曇り一時にわか雨

21

晴れ時々にわか雨

22

Snow

23

曇り一時雪

24

氷

25

Sleet

26

雨氷

29

雨と雪

30

Hot

31

寒い

32

Windy

33

透明

34

ほぼ晴れ

35

時々曇り

36

晴れたり曇ったり

37

薄月夜

38

ほとんど曇り

39

曇り時々小雨

40

曇り一時小雨

41

曇りときどき雷雨

42

曇り一時雷雨

43

曇り一時にわか雨

44

曇り一時雪

IntervalSummary

分単位の予報内の連続したウィンドウの天気見通しを記述します。通常は 、25分後に雨が終わる 、または 10分後に始まる軽い雪のような類似した条件の連続です。 各サマリーは予報開始時(startMinute、 endMinute、 totalMinutes)までの分単位のウィンドウを指定し、3つの長さ(短、簡潔、長)のフレーズ説明を提供し、利用可能なUIスペースに応じた適切な詳細レベルを表示できるようにし、代表的な天気アイコンの用に使う iconCode も含まれています。 MinuteForecastResultは、予測期間をカバーする1つ以上のIntervalSummary項目を返します。

Name 型 説明
briefPhrase

string

この区間の降水条件を説明する簡単なフレーズです。 最大60文字まで。

endMinute

integer (int32)

この区間の最後の1分は、予報開始時(分0)から数分で表されます。

iconCode

IconCode

この間隔の代表的な天気アイコンコード。 数値はAzure Mapsの天気アイコンに対応しており、完全なリストについては「Azure Mapsの気象サービス」をご覧ください。

longPhrase

string

この期間中の降水条件を説明する長いフレーズです。 60文字以上対応。

shortPhrase

string

この区間の降水条件を説明する短いフレーズです。 最大25文字まで。

startMinute

integer (int32)

この区間の最初の1分は、予報開始時(分0)から数分で表されます。

totalMinutes

integer (int32)

この区間の長さは分単位(endMinute - startMinute + 1)。

JsonFormat

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

値 説明
json

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

MinuteForecastResult

応答は「Get Minute Forecast」操作によって返され、指定された場所の今後120分間の降水見通しを要求された解像度(1分、5分、または15分)で提供しました。 応答は3層に分かれています。全体のフレーズ説明と期間中の代表アイコンを含む全体summary、連続した分を類似条件の長い区間(例:雨が25分で終わるなど)にまとめるintervalSummariesアレイ、そして降水強度(dbz)、降水量の種類、雲量、レーダースタイルの可視化に使われる色などの詳細な1分ごとの予報ポイントを含むintervalsアレイです。

Name 型 説明
intervalSummaries

IntervalSummary[]

予報窓を1つ以上の連続した類似条件の区間に分割するフレーズ要約(例えば、 雨は25分で終わり 、その後は 部分的に曇りが続く)。 各項目は扱う分数(startMinute、 endMinute、 totalMinutes)を指定し、短句、短句、長句のバリエーションを提供し、ストレッチの分 iconCode も含まれています。 これらの要約は、予測期間全体をカバーしています。

intervals

ForecastInterval[]

分単位の予測を構成する詳細な各ステップ予測ポイントです。 各 ForecastInterval は要求される解像度に応じて1分、5分、または15分をカバーし、開始時刻、降水強度(dbz)、降水の種類と閾値、短い説明文、アイコンコード、雲の被覆、レーダースタイル表示に使われる色を報告します。

summary

MinuteForecastSummary

約120分の予報窓全体における降水見通しを説明するトップレベルのフレーズ要約。 短い、簡い、長いバリエーションを含み、利用可能なUIスペースに応じた適切な詳細レベルを表示できるようにし、当時の代表的な iconCode も含まれています。

MinuteForecastSummary

今後の分単位の降水見通しを説明するフレーズ要約を提供します。 複数のフレーズ長(短(~25文字)、簡短(~60文字)、長(60+文字)が含まれており、アプリケーションは利用可能なUI空間に最適な詳細レベルを表示できます。 iconCodeはその時代の象徴的な天気アイコンを示します。

Name 型 説明
briefPhrase

string

約120分の予報窓全体の降水見通しを説明する簡単なフレーズです。 最大で約60文字まで。

briefPhrase60

string

この天体の他のフレーズよりも短い期間内、次の60分間の降水見通しを簡潔に説明したフレーズです。 最大で約60文字まで。

iconCode

IconCode

120分の予報期間全体を表す象徴的な天気アイコンコード。 数値はAzure Mapsの天気アイコンに対応しており、完全なリストについては「Azure Mapsの気象サービス」をご覧ください。

longPhrase

string

1~120分の予報窓全体の降水見通しを説明する長いフレーズです。 60文字以上対応。

shortPhrase

string

1~120分の予報窓全体の降水見通しを説明する短いフレーズです。 最大で約25文字まで。

PrecipitationType

降水のタイプを指定します。 有効な値は雨、雪、氷、または混合です。 このプロパティは、dBZ が 0 より大きい場合の応答に含まれます。

値 説明
Ice

氷

Mix

Mix

Rain

Rain

Snow

Snow