Timezone - Get Timezone By Coordinates
を使用して、指定した緯度と経度のペアの現在、履歴、および将来のタイム ゾーン情報を取得します。
Get Timezone By Coordinates
API は、指定された緯度と経度のペアの現在、履歴、および将来のタイム ゾーン情報を返す HTTP GET
要求です。 さらに、API は、特定の場所に対して日の入りと日の出の時刻を提供します。
GET https://atlas.microsoft.com/timezone/byCoordinates/json?api-version=1.0&query={query}
GET https://atlas.microsoft.com/timezone/byCoordinates/json?api-version=1.0&options={options}&timeStamp={timeStamp}&transitionsFrom={transitionsFrom}&transitionsYears={transitionsYears}&query={query}
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
format
|
path | True |
応答の目的の形式。 サポートされているのは |
|
api-version
|
query | True |
string |
Azure Maps API のバージョン番号。 |
query
|
query | True |
number[] |
タイム ゾーン情報が要求されるポイントの座標。 このパラメーターは座標のリストであり、座標のペア (緯度、長) が含まれます。 このエンドポイントが直接呼び出されると、座標は、コンマで区切られた座標を含む 1 つの文字列として渡されます。 |
options
|
query |
または、エイリアス "o" を使用します。 結果で返される情報の種類に使用できるオプション。 |
||
time
|
query |
string date-time |
または、エイリアス "stamp" または "s" を使用します。 参照時刻を省略すると、API は要求を提供するマシン時間を使用します。 |
|
transitions
|
query |
string date-time |
または、エイリアス "tf" を使用します。 夏時間 (DST) の切り替えが要求される開始日は、"options" = all または "options" = transitions の場合にのみ適用されます。 |
|
transitions
|
query |
integer |
または、エイリアス "ty" を使用します。 DST 切り替えが要求される "transitionsFrom" からの年数は、"options" = all または "options" = transitions の場合にのみ適用されます。 |
要求ヘッダー
名前 | 必須 | 型 | 説明 |
---|---|---|---|
x-ms-client-id |
string |
Microsoft Entra ID セキュリティ モデルと組み合わせて使用するアカウントを指定します。 これは Azure Maps アカウントの一意の ID を表し、Azure Maps 管理プレーン アカウント API から取得できます。 Azure Maps で Microsoft Entra ID セキュリティを使用するには、ガイダンスについては、次 の記事を 参照してください。 |
|
Accept-Language |
string |
タイムゾーン名を返す言語コードを指定します。 言語コードが指定されていない場合、応答は "EN" になります。 詳細については、「 サポートされている言語 」を参照してください。 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
OK |
|
Other Status Codes |
予期しないエラーが発生しました。 |
セキュリティ
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
例
Successfully retrieve timezone by coordinates
要求のサンプル
GET https://atlas.microsoft.com/timezone/byCoordinates/json?api-version=1.0&options=all&query=47,-122
応答のサンプル
{
"Version": "2019a",
"ReferenceUtcTimestamp": "2019-06-17T22:16:59.0765556Z",
"TimeZones": [
{
"Id": "America/Los_Angeles",
"Aliases": [
"US/Pacific",
"US/Pacific-New"
],
"Countries": [
{
"Name": "United States",
"Code": "US"
}
],
"Names": {
"ISO6391LanguageCode": "en",
"Generic": "Pacific Time",
"Standard": "Pacific Standard Time",
"Daylight": "Pacific Daylight Time"
},
"ReferenceTime": {
"Tag": "PDT",
"StandardOffset": "-08:00:00",
"DaylightSavings": "01:00:00",
"WallTime": "2019-06-17T15:16:59.0765556-07:00",
"PosixTzValidYear": 2019,
"PosixTz": "PST+8PDT,M3.2.0,M11.1.0",
"Sunrise": "2019-06-17T05:12:21.267-07:00",
"Sunset": "2019-06-17T21:05:18.017-07:00"
},
"RepresentativePoint": {
"Latitude": 34.05222222222222,
"Longitude": -118.24277777777777
},
"TimeTransitions": [
{
"Tag": "PDT",
"StandardOffset": "-08:00:00",
"DaylightSavings": "01:00:00",
"UtcStart": "2019-03-10T10:00:00Z",
"UtcEnd": "2019-11-03T09:00:00Z"
},
{
"Tag": "PST",
"StandardOffset": "-08:00:00",
"DaylightSavings": "00:00:00",
"UtcStart": "2019-11-03T09:00:00Z",
"UtcEnd": "2020-03-08T10:00:00Z"
},
{
"Tag": "PDT",
"StandardOffset": "-08:00:00",
"DaylightSavings": "01:00:00",
"UtcStart": "2020-03-08T10:00:00Z",
"UtcEnd": "2020-11-01T09:00:00Z"
}
]
}
]
}
定義
名前 | 説明 |
---|---|
Country |
国/地域レコード。 |
Error |
リソース管理エラーの追加情報。 |
Error |
エラーの詳細。 |
Error |
エラー応答 |
Json |
応答の目的の形式。 サポートされているのは |
Reference |
ローカル時刻に有効な詳細。 |
Representative |
代表的なポイント プロパティ |
Time |
|
Timezone |
|
Timezone |
タイムゾーン名オブジェクト。 |
Timezone |
または、エイリアス "o" を使用します。 結果で返される情報の種類に使用できるオプション。 |
Timezone |
このオブジェクトは、成功したタイムゾーンの ID 呼び出しまたは座標による呼び出しから返されます |
CountryRecord
国/地域レコード。
名前 | 型 | 説明 |
---|---|---|
Code |
string |
ISO-3166 国/地域の 2 文字の国/地域コード。 |
Name |
string |
country/region Name |
ErrorAdditionalInfo
リソース管理エラーの追加情報。
名前 | 型 | 説明 |
---|---|---|
info |
object |
追加情報。 |
type |
string |
追加情報の種類。 |
ErrorDetail
エラーの詳細。
名前 | 型 | 説明 |
---|---|---|
additionalInfo |
エラーの追加情報。 |
|
code |
string |
エラー コード。 |
details |
エラーの詳細です。 |
|
message |
string |
エラー メッセージ。 |
target |
string |
エラーのターゲット。 |
ErrorResponse
エラー応答
名前 | 型 | 説明 |
---|---|---|
error |
error オブジェクト。 |
JsonFormat
応答の目的の形式。 サポートされているのは json
形式のみです。
名前 | 型 | 説明 |
---|---|---|
json |
string |
ReferenceTime
ローカル時刻に有効な詳細。
名前 | 型 | 説明 |
---|---|---|
DaylightSavings |
string |
で有効な時間を分単位で節約できます |
PosixTz |
string |
タイム ゾーン環境変数の設定に使用される POSIX 文字列。 |
PosixTzValidYear |
integer |
この POSIX 文字列が有効な年。 注: POSIX 文字列は、指定された年にのみ有効です。 |
StandardOffset |
string |
で有効な |
Sunrise |
string |
プロパティに示すように、指定されたタイム ゾーンで日の出。 |
Sunset |
string |
プロパティに示すように、指定されたタイム ゾーンでの |
Tag |
string |
参照タイムスタンプで有効なタイム ゾーン名 (夏時間が有効かどうかに応じて PST または PDT)。 |
WallTime |
string |
プロパティに示すように、特定のタイム ゾーンの現在の壁の |
RepresentativePoint
代表的なポイント プロパティ
名前 | 型 | 説明 |
---|---|---|
Latitude |
number |
Latitude プロパティ |
Longitude |
number |
Longitude プロパティ |
TimeTransition
名前 | 型 | 説明 |
---|---|---|
DaylightSavings |
string |
DaylightSavings プロパティ |
StandardOffset |
string |
StandardOffset プロパティ |
Tag |
string |
Tag プロパティ |
UtcEnd |
string |
この切り替え期間の終了日、終了時刻 |
UtcStart |
string |
開始日、この移行期間の開始時刻 |
TimezoneId
名前 | 型 | 説明 |
---|---|---|
Aliases |
string[] |
タイム ゾーン ID エイリアスの配列。 [options]=zoneinfo または all の場合にのみ返されます。 注: null を指定できます。 |
Countries |
国/地域レコードの配列。 [options]=zoneinfo または all の場合にのみ返されます。 |
|
Id |
string |
Id プロパティ |
Names |
タイムゾーン名オブジェクト。 |
|
ReferenceTime |
ローカル時刻に有効な詳細。 |
|
RepresentativePoint |
代表的なポイント プロパティ |
|
TimeTransitions |
タイム ゾーン DST は[transitionsFrom] からタイムスタンプ + 1 年に遷移します。 |
TimezoneNames
タイムゾーン名オブジェクト。
名前 | 型 | 説明 |
---|---|---|
Daylight |
string |
夏時間の名前 |
Generic |
string |
Generic Name |
ISO6391LanguageCode |
string |
名前の ISO 639-1 言語コード |
Standard |
string |
標準の名前 |
TimezoneOptions
または、エイリアス "o" を使用します。 結果で返される情報の種類に使用できるオプション。
名前 | 型 | 説明 |
---|---|---|
all |
string |
結果に zoneinfo と遷移の両方を含めます。 |
none |
string |
結果に zoneinfo や遷移を含めないでください。 |
transitions |
string |
結果に遷移情報を含めます (遷移の数は現在 250 に制限されています)。 |
zoneInfo |
string |
結果に追加のタイム ゾーン情報を含めます。 |
TimezoneResult
このオブジェクトは、成功したタイムゾーンの ID 呼び出しまたは座標による呼び出しから返されます
名前 | 型 | 説明 |
---|---|---|
ReferenceUtcTimestamp |
string |
参照 Utc Timestamp プロパティ |
TimeZones |
TimeZoneId 配列 |
|
Version |
string |
Version プロパティ |