Weather - Get Daily Historical Actuals

リファレンス

サービス:: Maps

API バージョン:: 1.1

過去の毎日の実際の観測温度、降水量、降雪、雪深などの気候データを取得するために使用します。

API は Get Daily Historical Actuals 、過去の実際の観測温度、降水量、降雪、雪の深さ、冷却/暖房度の日情報などの気候データを特定の座標位置で返す HTTP GET 要求です。データは、1 つの API 要求で最大 31 日間、指定された日付範囲に対して要求されます。一般に、履歴データは、場所によっては過去 5 年から 40 年以上前まで利用できる場合があります。

GET https://atlas.microsoft.com/weather/historical/actuals/daily/json?api-version=1.1&query={query}&startDate={startDate}&endDate={endDate}

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

GET https://atlas.microsoft.com/weather/historical/actuals/daily/json?api-version=1.1&query={query}&startDate={startDate}&endDate={endDate}&unit={unit}

URI パラメーター

名前	/	必須	型	説明
format	path	True	JsonFormat	応答の目的の形式。サポートされているのは `json` 形式のみです。
api-version	query	True	string	Azure Maps API のバージョン番号。
endDate	query	True	string date	ISO 8601 形式の終了日 (2019-10-28 など)。サポートされる日付範囲は 1 から 31 カレンダー日であるため、startDate と endDate を指定してください。最大 31 日を超えないようにしてください (つまり、startDate=2012-01-01&endDate=2012-01-31)。
query	query	True	number[]	緯度の後に経度 (例: "47.641268,-122.125679" など) で構成されるコンマ区切り文字列として指定された該当するクエリ。
startDate	query	True	string date	ISO 8601 形式の開始日 (2019-10-27 など)。サポートされる日付範囲は 1 から 31 カレンダー日であるため、startDate と endDate を指定してください。最大 31 日を超えないようにしてください (つまり、startDate=2012-01-01&endDate=2012-01-31)。
unit	query		WeatherDataUnit	メトリック単位または帝国単位のいずれかでデータを返すように指定します。既定値はメトリックです。

要求ヘッダー

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

応答

名前	型	説明
200 OK	DailyHistoricalActualsResult	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 を使用すると、複数のユースケースでアプリケーションを構成ベースで設定できます。

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 で 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 リソースの List SAS 操作から作成される共有アクセス署名トークンです。

このトークンを使用すると、すべてのアプリケーションが Azure ロールベースのアクセス制御を使用してアクセスし、特定のトークンに使用される有効期限、レート、およびリージョンに対するきめ細かい制御が許可されます。言い換えると、SAS トークンを使用して、アプリケーションが共有キーよりもセキュリティで保護された方法でアクセスを制御できます。

公開されているアプリケーションの場合、 Map アカウントリソースで許可される配信元の特定のリストを構成して、レンダリングの不正使用を制限し、SAS トークンを定期的に更新することをお勧めします。

型: apiKey
/: header

例

Successful Daily Historical Actuals Request

要求のサンプル

HTTP

GET https://atlas.microsoft.com/weather/historical/actuals/daily/json?api-version=1.1&query=40.78,-77.89&startDate=2012-01-20&endDate=2012-01-22

応答のサンプル

状態コード:: 200

{
  "results": [
    {
      "date": "2012-01-20T00:00:00-04:00",
      "temperature": {
        "maximum": {
          "value": -6.1,
          "unit": "C",
          "unitType": 17
        },
        "minimum": {
          "value": -11.1,
          "unit": "C",
          "unitType": 17
        },
        "average": {
          "value": -8.6,
          "unit": "C",
          "unitType": 17
        }
      },
      "degreeDaySummary": {
        "heating": {
          "value": 27,
          "unit": "C",
          "unitType": 17
        },
        "cooling": {
          "value": 0,
          "unit": "C",
          "unitType": 17
        }
      },
      "precipitation": {
        "value": 10.9,
        "unit": "mm",
        "unitType": 3
      },
      "snowfall": {
        "value": 12.19,
        "unit": "cm",
        "unitType": 4
      },
      "snowDepth": {
        "value": 15.2,
        "unit": "cm",
        "unitType": 4
      }
    },
    {
      "date": "2012-01-21T00:00:00-04:00",
      "temperature": {
        "maximum": {
          "value": -1.7,
          "unit": "C",
          "unitType": 17
        },
        "minimum": {
          "value": -8.9,
          "unit": "C",
          "unitType": 17
        },
        "average": {
          "value": -5.3,
          "unit": "C",
          "unitType": 17
        }
      },
      "degreeDaySummary": {
        "heating": {
          "value": 24,
          "unit": "C",
          "unitType": 17
        },
        "cooling": {
          "value": 0,
          "unit": "C",
          "unitType": 17
        }
      },
      "precipitation": {
        "value": 0,
        "unit": "mm",
        "unitType": 3
      },
      "snowfall": {
        "value": 0.51,
        "unit": "cm",
        "unitType": 4
      },
      "snowDepth": {
        "value": 12.7,
        "unit": "cm",
        "unitType": 4
      }
    },
    {
      "date": "2012-01-22T00:00:00-04:00",
      "temperature": {
        "maximum": {
          "value": 0,
          "unit": "C",
          "unitType": 17
        },
        "minimum": {
          "value": -7.2,
          "unit": "C",
          "unitType": 17
        },
        "average": {
          "value": -3.6,
          "unit": "C",
          "unitType": 17
        }
      },
      "degreeDaySummary": {
        "heating": {
          "value": 22,
          "unit": "C",
          "unitType": 17
        },
        "cooling": {
          "value": 0,
          "unit": "C",
          "unitType": 17
        }
      },
      "precipitation": {
        "value": 0,
        "unit": "mm",
        "unitType": 3
      },
      "snowfall": {
        "value": 0,
        "unit": "cm",
        "unitType": 4
      },
      "snowDepth": {
        "value": 10.2,
        "unit": "cm",
        "unitType": 4
      }
    }
  ]
}

定義

名前	説明
DailyHistoricalActuals
DailyHistoricalActualsResult
DegreeDaySummary
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
JsonFormat	応答の目的の形式。サポートされているのは `json` 形式のみです。
UnitType	表示される単位の種類に関連付けられている数値 ID 値。単位変換に使用できます。詳細については、「 Azure Maps の Weather サービス」を参照してください。
WeatherDataUnit	メトリック単位または帝国単位のいずれかでデータを返すように指定します。既定値はメトリックです。
WeatherUnit	気象に関連する特定の単位の特定の値。
WeatherUnitMaxMinAvg	返される温度値。

DailyHistoricalActuals

名前	型	説明
date	string	ISO 8601 形式で表示されている現在の観測値の日時 (2019-10-27T19:39:57-08:00 など)。
degreeDaySummary	DegreeDaySummary	暖房または冷却の程度の日情報の概要。次数の日は、場所の寒さや暖かさの測定値です。 1 日の次数は、ある場所に対して記録された平均 (高気温と低気温の平均) を標準温度 65 °C/ 18 °C と比較します。
precipitation	WeatherUnit	落ちている沈殿量(液体換算)。
snowDepth	WeatherUnit	雪の深さ。
snowfall	WeatherUnit	降った雪の量。
temperature	WeatherUnitMaxMinAvg	温度の値。

DailyHistoricalActualsResult

名前	型	説明
nextLink	string	は、返される機能の次のページへのリンクです。最後のページの場合、このフィールドはありません。
results	DailyHistoricalActuals[]	要求された各日の履歴実績。

DegreeDaySummary

名前	型	説明
cooling	WeatherUnit	平均温度が 65 度 F/ 18°C を超える度数。
heating	WeatherUnit	平均温度が 65 度 F/ 18°C 未満の度数。

ErrorAdditionalInfo

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

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

ErrorDetail

エラーの詳細。

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

ErrorResponse

エラー応答

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

JsonFormat

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

名前	型	説明
json	string	JavaScript オブジェクト表記データ交換形式

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

WeatherDataUnit

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

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

WeatherUnit

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

名前	型	説明
unit	string	戻り値の単位の型。
unitType	UnitType	表示される単位の種類に関連付けられている数値 ID 値。単位変換に使用できます。詳細については、「 Azure Maps の Weather サービス」を参照してください。
value	number	丸められた値。

WeatherUnitMaxMinAvg

返される温度値。

名前	型	説明
average	WeatherUnit	期間の平均気温。
maximum	WeatherUnit	期間の最高温度。
minimum	WeatherUnit	期間の最低温度。

次の方法で共有