Timezone - Get Timezone By Coordinates

リファレンス

Service:: Maps

API Version:: 1.0

を使用して、指定した緯度と経度のペアの現在、履歴、および将来のタイムゾーン情報を取得します。

Get Timezone By Coordinates API は、指定された緯度と経度のペアの現在、履歴、および将来のタイムゾーン情報を返す HTTP GET 要求です。さらに、API は、特定の場所に対して日の入りと日の出の時刻を提供します。

GET https://atlas.microsoft.com/timezone/byCoordinates/json?api-version=1.0&query={query}

With optional parameters:

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	JsonFormat	応答の目的の形式。サポートされているのは `json` 形式のみです。
api-version	query	True	string	Azure Maps API のバージョン番号。
query	query	True	number[]	タイムゾーン情報が要求されるポイントの座標。このパラメーターは座標の一覧であり、座標のペア (緯度、長) を含みます。このエンドポイントが直接呼び出されると、座標はコンマで区切られた座標を含む単一の文字列として渡されます。
options	query		TimezoneOptions	または、エイリアス "o" を使用します。結果で返される情報の種類に使用できるオプション。
timeStamp	query		string date-time	または、エイリアス "stamp" または "s" を使用します。参照時間を省略すると、API は要求を提供するマシン時間を使用します。
transitionsFrom	query		string date-time	または、エイリアス "tf" を使用します。夏時間 (DST) の切り替えが要求される開始日は、"options" = all または "options" = transitions の場合にのみ適用されます。
transitionsYears	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	TimezoneResult	OK
Other Status Codes	ErrorResponse	予期しないエラーが発生しました。

セキュリティ

AADToken

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

Microsoft ID プラットフォームの詳細については、「Microsoft ID プラットフォームの概要」を参照してください。

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

Scopes

名前	説明
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

これは、Azure portalでAzure Maps アカウントをCreateするとき、または 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 timezone by coordinates

Sample Request

HTTP

GET https://atlas.microsoft.com/timezone/byCoordinates/json?api-version=1.0&options=all&query=47,-122

Sample Response

Status code:: 200

{
  "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"
        }
      ]
    }
  ]
}

定義

名前	説明
CountryRecord	国/地域レコード。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
JsonFormat	応答の目的の形式。サポートされているのは `json` 形式のみです。
ReferenceTime	ローカル時刻に有効な詳細。
RepresentativePoint	代表的なポイントプロパティ
TimeTransition
TimezoneId
TimezoneNames	タイムゾーン名オブジェクト。
TimezoneOptions	または、エイリアス "o" を使用します。結果で返される情報の種類に使用できるオプション。
TimezoneResult	このオブジェクトは、成功したタイムゾーンの ID 呼び出しまたは座標による呼び出しから返されます

CountryRecord

国/地域レコード。

名前	型	説明
Code	string	ISO-3166 国/地域の 2 文字の国/地域コード。
Name	string	country/region Name

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 オブジェクト表記データ交換形式

ReferenceTime

ローカル時刻に有効な詳細。

名前	型	説明
DaylightSavings	string	で有効な時間を分単位で節約できます `ReferenceUTCTimestamp`。
PosixTz	string	タイムゾーン環境変数の設定に使用される POSIX 文字列。
PosixTzValidYear	integer	この POSIX 文字列が有効な年。注: POSIX 文字列は、指定された年にのみ有効です。
StandardOffset	string	で有効な `ReferenceUTCTimestamp`UTC オフセット。
Sunrise	string	プロパティに示すように、指定されたタイムゾーンで日の出。`Tag` 日の出はISO8601形式で記述されます。 (呼び出しが byCoordinates の場合にのみ設定されます)
Sunset	string	プロパティに示すように、指定されたタイムゾーンでの `Tag` サンセット。サンセットは、ISO8601形式で記述されます。(呼び出しが byCoordinates の場合にのみ設定されます)
Tag	string	参照タイムスタンプで有効なタイムゾーン名 (夏時間が有効かどうかに応じて PST または PDT)。
WallTime	string	プロパティに示すように、特定のタイムゾーンの現在の壁の `Tag` 時刻。

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	CountryRecord[]	国/地域レコードの配列。 [options]=zoneinfo または all の場合にのみ返されます。
Id	string	Id プロパティ
Names	TimezoneNames	タイムゾーン名オブジェクト。
ReferenceTime	ReferenceTime	ローカル時刻に有効な詳細。
RepresentativePoint	RepresentativePoint	代表的なポイントプロパティ
TimeTransitions	TimeTransition[]	タイムゾーン 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[]	TimeZoneId 配列
Version	string	Version プロパティ