Weather - Get Minute Forecast

サービス:: Maps

API バージョン:: 1.1

1 分、5 分、15 分間隔で次の 120 分間の分単位の予報を取得するために使用します。

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

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

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

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

URI パラメーター

名前	/	必須	型	説明
format	path	True	JsonFormat	応答の目的の形式。 `json` 形式のみがサポートされています。
api-version	query	True	string	Azure Maps API のバージョン番号。
query	query	True	number[]	緯度の後に経度 (例: "47.641268,-122.125679") で構成されるコンマ区切り文字列として指定された該当するクエリ。気象情報は、通常、陸上の場所、陸地に囲まれた水域、および海岸線から約 50 海里以内の海域で利用できます。
interval	query		integer	返される天気予報の時間間隔を分単位で指定します。サポートされている値は次のとおりです `1` - 1 分間隔の予測を取得します。既定で返されます。 `5` - 5 分間隔の予測を取得します。 `15` - 15 分間隔の予測を取得します。
language	query		string	検索結果を返す言語。サポートされている IETF 言語タグの 1 つである必要があります。大文字と小文字は区別されません。指定した言語のデータが特定のフィールドで使用できない場合は、既定の言語が使用されます。詳細については、サポートされている言語のを参照してください。

要求ヘッダー

名前	必須	型	説明
x-ms-client-id		string	Microsoft Entra ID セキュリティモデルでの使用を目的としたアカウントを示します。 Azure Maps アカウントのこの一意の ID は、 Azure Maps 管理プレーンアカウント API から取得できます。 Azure Maps で Microsoft Entra ID セキュリティを使用する方法の詳細については、「 Azure Maps での認証の管理」を参照してください。

応答

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

Notes

このセキュリティ定義使用して、アプリケーションがアクセスを要求している 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 で、または PowerShell、CLI、Azure SDK、または REST API を使用して Azure Maps アカウントを作成場合にプロビジョニングされる共有キーです。

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

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

型: apiKey
/: query

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

要求のサンプル

HTTP

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

応答のサンプル

状態コード:: 200

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

定義

名前	説明
ColorValue
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
ForecastInterval
IconCode	`Phrase` プロパティで記述される現在の気象条件に対応する画像を表す数値。詳細については、「 Azure Maps の天気予報サービス」を参照してください。 NULL を指定できます。
IntervalSummary
JsonFormat	応答の目的の形式。 `json` 形式のみがサポートされています。
MinuteForecastResult
MinuteForecastSummary	予測期間全体のフレーズの概要。
PrecipitationType	降水のタイプを指定します。有効な値は、Rain、Snow、Ice、または Mix です。このプロパティは、dBZ が 0 より大きい場合の応答に含まれます。

ColorValue

Object

名前	型	説明
blue	integer (int32)	RGB値の青成分
green	integer (int32)	RGB 値の緑色のコンポーネント。
hex	string	16 進数の色の値。
red	integer (int32)	RGB 値の赤のコンポーネント。

ErrorAdditionalInfo

Object

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

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

ErrorDetail

Object

エラーの詳細。

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

ErrorResponse

Object

エラー応答

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

ForecastInterval

Object

名前	型	説明
cloudCover	integer (int32)	雲量を表すパーセント。
color	ColorValue	dBZ にマップされるフルスペクトルカラー (Z を基準としたデシベル)。 dBZ が 0 の場合、応答に色は存在しません。
dbz	number (double)	予測降水強度を表す単位。
iconCode	IconCode (int32)	`Phrase` プロパティで記述される現在の気象条件に対応する画像を表す数値。詳細については、「 Azure Maps の天気予報サービス」を参照してください。 NULL を指定できます。
minute	integer (int32)	インターバルの最初の 1 分。
precipitationType	PrecipitationType	降水のタイプを指定します。有効な値は、Rain、Snow、Ice、または Mix です。このプロパティは、dBZ が 0 より大きい場合の応答に含まれます。
shortPhrase	string	間隔の降水条件を説明する短いフレーズ。
simplifiedColor	ColorValue	降水量の種類と閾値にマップされるバンドの色。 dBZ が 0 の場合、応答には存在しません。
startTime	string (date-time)	例えば、ISO 8601 形式での区間開始日時は2019-10-27T19:39:57-08:00です。
threshold	string	しきい値を指定するキー。 precipitationType と共に、simplifiedColor を決定するために使用できます。 dBZ が 0 の場合、応答には存在しません。

IconCode

列挙

Phrase プロパティで記述される現在の気象条件に対応する画像を表す数値。詳細については、「 Azure Maps の天気予報サービス」を参照してください。 NULL を指定できます。

値	説明
1	Sunny
2	晴れ一時曇り
3	晴れ時々曇り
4	晴れたり曇ったり
5	薄晴れ
6	ほとんど曇り
7	Cloudy
8	どんよりした (曇り)
9
10
11	Fog
12	Showers
13	曇り一時小雨
14	晴れ時々小雨
15	Thunderstorms
16	曇り一時雷雨
17	晴れ時々雷雨
18	Rain
19	Flurries
20	曇り一時にわか雨
21	晴れ時々にわか雨
22	Snow
23	曇り一時雪
24	Ice
25	Sleet
26	雨氷
27
28
29	雨と雪
30	Hot
31	Cold
32	Windy
33	Clear
34	ほぼ晴れ
35	時々曇り
36	断続的な雲(夜)
37	薄月夜
38	曇り (夜)
39	曇り時々小雨
40	曇り時々にわか雨(夜)
41	曇りときどき雷雨
42	曇り、雷雨(夜間)
43	曇り時々ちらつき(夜)
44	曇り、雪(夜)

IntervalSummary

Object

名前	型	説明
briefPhrase	string	簡単な要約フレーズ。フレーズの長さは約 60 文字です。
endMinute	integer (int32)	サマリーが適用される最後の分。
iconCode	IconCode (int32)	`Phrase` プロパティで記述される現在の気象条件に対応する画像を表す数値。詳細については、「 Azure Maps の天気予報サービス」を参照してください。 NULL を指定できます。
longPhrase	string	長い要約フレーズ。フレーズの長さは60+文字です。
shortPhrase	string	短い要約フレーズ。フレーズの長さは約 25 文字です。
startMinute	integer (int32)	サマリーが適用される最初の 1 分間。
totalMinutes	integer (int32)	サマリーが適用される分数。

JsonFormat

列挙

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

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

MinuteForecastResult

Object

名前	型	説明
intervalSummaries	IntervalSummary[]	予測の各間隔のサマリー情報。サマリーは、降水が開始および停止する各潜在的な間隔を分類します。
intervals	ForecastInterval[]	予測の各間隔の予測データ。
summary	MinuteForecastSummary	予測期間全体のフレーズの概要。

MinuteForecastSummary

Object

予測期間全体のフレーズの概要。

名前	型	説明
briefPhrase	string	次の120分間のまとめフレーズ。フレーズの長さは約 60 文字です。
briefPhrase60	string	次の 60 分間のまとめフレーズ。フレーズの長さは約 60 文字です。
iconCode	IconCode (int32)	`Phrase` プロパティで記述される現在の気象条件に対応する画像を表す数値。詳細については、「 Azure Maps の天気予報サービス」を参照してください。 NULL を指定できます。
longPhrase	string	次の120分間の長い要約フレーズ。フレーズの長さは60+文字です。
shortPhrase	string	次の120分間の短い要約フレーズ。フレーズの長さは約 25 文字です。

PrecipitationType

列挙

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

値	説明
Ice	Ice
Mix	Mix
Rain	Rain
Snow	Snow

次の方法で共有

Weather - Get Minute Forecast

URI パラメーター

要求ヘッダー

応答

セキュリティ

AADToken

Notes

スコープ

subscription-key

SAS Token

例

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

要求のサンプル

応答のサンプル

定義

ColorValue

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ForecastInterval

IconCode

IntervalSummary

JsonFormat

MinuteForecastResult

MinuteForecastSummary

PrecipitationType