Weather - Get Current Conditions

リファレンス

Service:: Maps

API Version:: 1.1

現在の条件を取得する

適用対象: 価格レベルを参照してください。

現在の条件の取得サービスは、特定の座標位置の降水量、温度、風などの詳細な現在の気象条件を返します。また、特定の場所での過去 6 時間または 24 時間の観測値も取得できます。応答で返される基本情報には、観測日時、気象条件の簡単な説明、気象アイコン、降水量インジケーターフラグ、温度などの詳細が含まれます。 RealFeel™ の気温と UV の指数などの追加情報も返されます。

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

With optional parameters:

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

URI パラメーター

Name	In	Required	Type	Description
format	path	True	JsonFormat	応答の目的の形式。サポートされているのは `json` 形式のみです。
api-version	query	True	string	Azure Maps API のバージョン番号。
query	query	True	array	緯度の後に経度 (例: 47.641268,-122.125679) で構成されるコンマ区切り文字列として指定された該当するクエリ。
details	query		string	現在の条件の完全な詳細を返します。使用可能な値は次のとおりです。 `true` - 完全な詳細を返します。既定では、すべての詳細が返されます。 `false` - 観測日時、気象語句、アイコンコード、降水量インジケーターフラグ、温度を含む、現在の条件データの切り捨てられたバージョンを返します。
duration	query		integer	返された気象条件の期間。既定では、最新の気象条件が返されます。既定値は 0 です。サポートされる値は次のとおりです。 `0` - 最新の気象条件を返します。 `6` - 過去 6 時間の気象条件を返します。 `24` - 過去 24 時間の気象条件を返します。
language	query		string	検索結果を返す言語。サポートされている IETF 言語タグの 1 つである必要があります。大文字と小文字は区別されません。指定した言語のデータが特定のフィールドで使用できない場合は、既定の言語が使用されます。詳細については、サポートされている言語を参照してください。
unit	query		WeatherDataUnit	メトリック単位またはフィート単位のいずれかでデータを返すように指定します。既定値はメトリックです。

要求ヘッダー

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

応答

Name	Type	Description
200 OK	CurrentConditionsResult	OK
Other Status Codes	ErrorResponse	予期しないエラーが発生しました。

セキュリティ

AADToken

これらは Azure Active Directory OAuth2 フローです。 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 と Azure Active Directory 構成があります。 * Azure ロールベースのアクセス制御は、Azure portal、PowerShell、CLI、Azure SDK、または REST API を使用して Azure 管理プレーンから構成されます。 * Azure Maps Web SDK を使用すると、複数のユースケースに対するアプリケーションの構成ベースのセットアップが可能になります。

現在、Azure Active Directory v1.0 または v2.0 は職場、学校、ゲストをサポートしていますが、個人用アカウントはサポートしていません。

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
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 にアクセスすることをお勧めします。

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

例

Successfully retrieve detailed current weather conditions for a given coordinate location

Sample Request

HTTP

GET https://atlas.microsoft.com/weather/currentConditions/json?api-version=1.1&query=47.641268,-122.125679

Sample Response

Status code:: 200

{
  "results": [
    {
      "dateTime": "2019-11-14T15:08:00-08:00",
      "phrase": "Cloudy",
      "iconCode": 7,
      "hasPrecipitation": false,
      "isDayTime": true,
      "temperature": {
        "value": 13.7,
        "unit": "C",
        "unitType": 17
      },
      "realFeelTemperature": {
        "value": 13.6,
        "unit": "C",
        "unitType": 17
      },
      "realFeelTemperatureShade": {
        "value": 13.6,
        "unit": "C",
        "unitType": 17
      },
      "relativeHumidity": 75,
      "dewPoint": {
        "value": 9.2,
        "unit": "C",
        "unitType": 17
      },
      "wind": {
        "direction": {
          "degrees": 315,
          "localizedDescription": "NW"
        },
        "speed": {
          "value": 3.6,
          "unit": "km/h",
          "unitType": 7
        }
      },
      "windGust": {
        "speed": {
          "value": 4.9,
          "unit": "km/h",
          "unitType": 7
        }
      },
      "uvIndex": 0,
      "uvIndexPhrase": "Low",
      "visibility": {
        "value": 8,
        "unit": "km",
        "unitType": 6
      },
      "obstructionsToVisibility": "",
      "cloudCover": 95,
      "ceiling": {
        "value": 4359,
        "unit": "m",
        "unitType": 5
      },
      "pressure": {
        "value": 1014.9,
        "unit": "mb",
        "unitType": 14
      },
      "pressureTendency": {
        "localizedDescription": "Steady",
        "code": "S"
      },
      "pastTwentyFourHourTemperatureDeparture": {
        "value": 1.8,
        "unit": "C",
        "unitType": 17
      },
      "apparentTemperature": {
        "value": 16.1,
        "unit": "C",
        "unitType": 17
      },
      "windChillTemperature": {
        "value": 13.9,
        "unit": "C",
        "unitType": 17
      },
      "wetBulbTemperature": {
        "value": 11.4,
        "unit": "C",
        "unitType": 17
      },
      "precipitationSummary": {
        "pastHour": {
          "value": 0.5,
          "unit": "mm",
          "unitType": 3
        },
        "pastThreeHours": {
          "value": 0.8,
          "unit": "mm",
          "unitType": 3
        },
        "pastSixHours": {
          "value": 0.8,
          "unit": "mm",
          "unitType": 3
        },
        "pastNineHours": {
          "value": 0.8,
          "unit": "mm",
          "unitType": 3
        },
        "pastTwelveHours": {
          "value": 0.8,
          "unit": "mm",
          "unitType": 3
        },
        "pastEighteenHours": {
          "value": 0.8,
          "unit": "mm",
          "unitType": 3
        },
        "pastTwentyFourHours": {
          "value": 0.8,
          "unit": "mm",
          "unitType": 3
        }
      },
      "temperatureSummary": {
        "pastSixHours": {
          "minimum": {
            "value": 8.3,
            "unit": "C",
            "unitType": 17
          },
          "maximum": {
            "value": 13.7,
            "unit": "C",
            "unitType": 17
          }
        },
        "pastTwelveHours": {
          "minimum": {
            "value": 5.9,
            "unit": "C",
            "unitType": 17
          },
          "maximum": {
            "value": 13.7,
            "unit": "C",
            "unitType": 17
          }
        },
        "pastTwentyFourHours": {
          "minimum": {
            "value": 5.9,
            "unit": "C",
            "unitType": 17
          },
          "maximum": {
            "value": 13.7,
            "unit": "C",
            "unitType": 17
          }
        }
      }
    }
  ]
}

定義

CurrentConditions
CurrentConditionsResult
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
IconCode	を表示 `iconPhrase`する画像を表す数値。詳細については、 Weather Service の概念を参照してください。
JsonFormat	応答の目的の形式。サポートされているのは `json` 形式のみです。
PastHoursTemperature	過去の時間数に対する温度変動の概要。
PrecipitationSummary
PressureTendency
TemperatureSummary
UnitType	表示される単位の種類に関連付けられている数値 ID 値。単位変換に使用できます。詳細については、 Weather Service の概念を参照してください。
WeatherDataUnit	メトリック単位または帝国単位のいずれかでデータを返すように指定します。既定値はメトリックです。
WeatherUnit	気象に関連する特定の単位の特定の値。
WindDetails	速度と方向を含む風の詳細が返されます。
WindDirection	風向

CurrentConditions

Name	Type	Description
apparentTemperature	WeatherUnit	指定された単位の空気温度、湿度、および風速の組み合わせによって引き起こされる認識される屋外温度。
ceiling	WeatherUnit	指定された単位でのクラウドの上限。天井は、最も低い雲の基部の高さの測定です。
cloudCover	integer	クラウドカバーを表す割合。
dateTime	string	ISO 8601 形式で表示される現在の観測値の日時 (例: 2019-10-27T19:39:57-08:00)。
dewPoint	WeatherUnit	指定した単位の露点温度。露点温度は、飽和に達するために空気を冷却する必要がある温度です。
hasPrecipitation	boolean	降水量の有無を示します。 True は降水量の存在を示し、false は降水量がないことを示します。
iconCode	IconCode	を表示 `iconPhrase`する画像を表す数値。詳細については、 Weather Service の概念を参照してください。
isDayTime	boolean	1 日の時刻を示します。 True は 'day' を示し、false は 'night' を示します。
obstructionsToVisibility	string	表示が制限される原因。
pastTwentyFourHourTemperatureDeparture	WeatherUnit	指定された単位で 24 時間前に観測された温度からの逸脱。
phrase	string	現在の気象条件のフレーズの説明。指定した言語で表示されます。
precipitationSummary	PrecipitationSummary	過去 24 時間の降水量の概要。
pressure	WeatherUnit	指定された単位の気圧。
pressureTendency	PressureTendency	気圧変化。
realFeelTemperature	WeatherUnit	RealFeel™ Temperature が返されます。
realFeelTemperatureShade	WeatherUnit	RealFeel™ Temperature が返されます。日陰での温度の実際の感じを説明します。
relativeHumidity	integer	湿度は、空気中に存在する水蒸気の量であり、同じ温度での飽和に必要な量の割合で表されます。
temperature	WeatherUnit	返される温度。
temperatureSummary	TemperatureSummary	過去 6 時間、12 時間、24 時間の温度変動の概要。
uvIndex	integer	太陽からの紫外線の強さの測定。サポートされる値は次のとおりです。 `0-2` - 太陽の紫外線または平均的な人からの危険が低い。 `3-5` - 保護されていない太陽の露出による危害の中程度のリスク。 `6-7` - 保護されていない太陽の露出による損害のリスクが高い。 `8-10` - 保護されていない太陽の露出による害の非常に高いリスク。 `11+` - 保護されていない太陽の露出による危害の極端なリスク。
uvIndexPhrase	string	に関連付 `uvIndex`けられている語句。
visibility	WeatherUnit	指定した単位での可視性。オブジェクトまたはライトを明確に識別できる距離の測定値。
wetBulbTemperature	WeatherUnit	空気が飽和に達するまで一定の圧力でそれに水を蒸発させることによって冷却することができる温度。
wind	WindDetails	速度と方向を含む風の詳細が返されます。
windChillTemperature	WeatherUnit	風が原因で露出した皮膚の空気温度を認識します。
windGust	WindDetails	風の突風。風の突風は、風の急激な、短い速度の増加です。

CurrentConditionsResult

Name	Type	Description
results	CurrentConditions[]	詳細な現在の気象条件。

ErrorAdditionalInfo

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

Name	Type	Description
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

エラーの詳細。

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラーコード。
details	ErrorDetail[]	エラーの詳細です。
message	string	エラーメッセージ。
target	string	エラーターゲット。

ErrorResponse

エラー応答

Name	Type	Description
error	ErrorDetail	エラーオブジェクト。

IconCode

を表示 iconPhraseする画像を表す数値。詳細については、 Weather Service の概念を参照してください。

Name	Type	Description
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 形式のみです。

Name	Type	Description
json	string	JavaScript オブジェクト表記データ交換形式

PastHoursTemperature

過去の時間数に対する温度変動の概要。

Name	Type	Description
maximum	WeatherUnit	maximum
minimum	WeatherUnit	minimum

PrecipitationSummary

Name	Type	Description
pastEighteenHours	WeatherUnit	過去 18 時間に落ちた降水量 (液体相当) の量。
pastHour	WeatherUnit	過去 1 時間に低下した降水量 (液体相当) の量。
pastNineHours	WeatherUnit	過去 9 時間に減少した降水量 (液体相当) の量。
pastSixHours	WeatherUnit	過去 6 時間に落ちた降水量 (液体相当) の量。メトリックとインペリアル値が含まれます。
pastThreeHours	WeatherUnit	過去 3 時間に低下した降水量 (液体相当) の量。
pastTwelveHours	WeatherUnit	過去 12 時間に低下した降水量 (液体相当) の量。
pastTwentyFourHours	WeatherUnit	過去 24 時間に低下した降水量 (液体相当) の量。

PressureTendency

Name	Type	Description
code	string	言語に関係なく、圧力傾向コード。 F=Falling、S=Steady、R=Rising のいずれか。
localizedDescription	string	指定された言語での圧力傾向の説明

TemperatureSummary

Name	Type	Description
pastSixHours	PastHoursTemperature	過去 6 時間の温度変動の概要。
pastTwelveHours	PastHoursTemperature	過去 12 時間の温度変動の概要。
pastTwentyFourHours	PastHoursTemperature	過去 24 時間の温度変動の概要。

UnitType

表示される単位の種類に関連付けられている数値 ID 値。単位変換に使用できます。詳細については、 Weather Service の概念を参照してください。

Name	Type	Description
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

WeatherDataUnit

メトリック単位または帝国単位のいずれかでデータを返すように指定します。既定値はメトリックです。

Name	Type	Description
imperial	string	帝国単位でデータを返します。帝国系の単位の例としては、華氏とマイルがあります。
metric	string	メトリック単位でデータを返します。メトリックシステムの単位の例としては、摂氏とキロメートルがあります。

WeatherUnit

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

Name	Type	Description
unit	string	戻り値の単位の型。
unitType	UnitType	表示される単位の種類に関連付けられている数値 ID 値。単位変換に使用できます。詳細については、 Weather Service の概念を参照してください。
value	number	丸められた値。

WindDetails

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

Name	Type	Description
direction	WindDirection	風向
speed	WeatherUnit	指定された単位での風の速度。

WindDirection

風向

Name	Type	Description
degrees	integer	方位角の風向(真北から始まり、時計回りの方向に続く)。北は 0 度、東は 90 度、南は 180 度、西は 270 度です。指定できる値は 0 ~ 359 です。
localizedDescription	string	指定した言語での方向の省略形。