Timezone - Get Timezone By Coordinates

指定した緯度と経度のペアの現在、履歴、および将来のタイムゾーン情報を取得するために使用します。
Get Timezone By Coordinates API は、指定した緯度と経度のペアの現在、履歴、および将来のタイム ゾーン情報を返す HTTP GET 要求です。 さらに、この API は、太陽の日を観察する地域を除き、特定の場所の日の入りと日の出の時間を提供します。

GET {endpoint}/timezone/byCoordinates/json?api-version=1.0&query={query}
GET {endpoint}/timezone/byCoordinates/json?api-version=1.0&options={options}&timeStamp={timeStamp}&transitionsFrom={transitionsFrom}&transitionsYears={transitionsYears}&query={query}

URI パラメーター

名前 / 必須 説明
endpoint
path True

string

format
path True

JsonFormat

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

api-version
query True

string

minLength: 1

この操作に使用する API バージョン。

query
query True

number[]

タイム ゾーン情報が要求されるポイントの座標。 このパラメーターは、座標のペアを含む座標のリストです (緯度、長)。 このエンドポイントが直接呼び出されると、座標は、コンマで区切られた座標を含む 1 つの文字列として渡されます。

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 (int32)

または、エイリアス "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セキュリティの使用についての詳細は、Azure Mapsの認証管理Manage certificationをご覧ください。

Accept-Language

string

タイムゾーン名を返す言語コードを指定します。 言語コードが指定されていない場合、応答は "EN" になります。 詳細については、サポートされている言語の を参照してください。

応答

名前 説明
200 OK

TimezoneResult

要求は成功しました。

Other Status Codes

ErrorResponse

予期しないエラー応答。

セキュリティ

AadToken

これらはMicrosoft Entra OAuth 2.0フローです。 Azureロールベースアクセス制御と組み合わせることで、Azure Maps REST APIへのアクセス制御に利用できます。 Azure ロールベースのアクセス制御は、1つ以上の Azure Maps リソースアカウントまたはサブリソースへのアクセスを指定するために使用されます。 任意のユーザー、グループ、またはサービスプリンシパルは、組み込みの役割や1つ以上のREST API権限からなるカスタムロールを通じてアクセス権Azure Maps付与されます。\n\nシナリオを実装するには、authentication conceptsを見ることをお勧めします。 まとめると、このセキュリティ定義は、特定のAPIやスコープでアクセス制御が可能なオブジェクトを通じてアプリケーションをモデリングするソリューションを提供します。\n\n#### 注記\n* このセキュリティ定義要求x-ms-client-idヘッダーを使用してアプリケーションがどのAzure Mapsリソースへのアクセスを要求しているかを示します。 これはMaps管理APIから取得可能です。\n* \nAuthorization URLはAzureパブリッククラウドインスタンス専用です。 ソブリンクラウドは固有の認可URLとMicrosoft Entra IDの設定を持っています。 \n* \nAzureロールベースのアクセス制御は、Azure管理プレーンから、Azureポータル、PowerShell、CLI、Azure SDK、REST APIを通じて構成されます。\n* \nAzure MapsWeb SDKは、複数のユースケース向けにアプリケーションの設定を可能にします。\n* Microsoft ID プラットフォームの詳細については、Microsoft ID プラットフォーム概要をご覧ください。

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

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

subscription-key

これは共有キーで、AzureポータルでCreate a Azure Maps accountを行うか、PowerShell、CLI、Azure SDK、REST APIを使ってプロビジョニングされます。\n\n このキーがあれば、どのアプリケーションでもすべてのREST APIにアクセスできます。 つまり、この鍵は発行された口座のマスターキーとして使うことができます。\n\n 公開されているアプリケーションについては、confidential client applications方式を用いてREST API Azure Mapsにアクセスし、鍵を安全に保存できるようにすることをお勧めします。

型: apiKey
/: header

SAS Token

これは共有アクセス署名トークンで、Azure MapsリソースのList SAS操作からAzureポータル、PowerShell、CLI、Azure SDK、REST APIを通じてAzure管理プレーンを経由して作成されます。\n\n このトークンにより、どのアプリケーションでもAzureでアクセスが許可されますロールベースのアクセス制御や、特定のトークンの有効期限、速度、使用領域の細かい制御。 言い換えれば、SASトークンは共有鍵よりも安全な方法でアクセスを制御するために使えます。\n\n 公開されているアプリケーションについては、 Mapアカウントリソース 上で許可された発信元の特定のリストを設定し、レンダリングの乱用を制限し、SASトークンを定期的に更新することを推奨します。

型: apiKey
/: header

Successfully retrieve timezone by coordinates

要求のサンプル

GET {endpoint}/timezone/byCoordinates/json?api-version=1.0&options=all&query=47,-122

応答のサンプル

{
  "referenceUtcTimestamp": "2019-06-17T22:16:59.0765556Z",
  "timeZones": [
    {
      "aliases": [
        "US/Pacific",
        "US/Pacific-New"
      ],
      "countries": [
        {
          "code": "US",
          "name": "United States"
        }
      ],
      "id": "America/Los_Angeles",
      "names": {
        "daylight": "Pacific Daylight Time",
        "generic": "Pacific Time",
        "iso6391LanguageCode": "en",
        "standard": "Pacific Standard Time"
      },
      "referenceTime": {
        "daylightSavings": "01:00:00",
        "posixTz": "PST+8PDT,M3.2.0,M11.1.0",
        "posixTzValidYear": 2019,
        "standardOffset": "-08:00:00",
        "sunrise": "2019-06-17T05:12:21.267-07:00",
        "sunset": "2019-06-17T21:05:18.017-07:00",
        "tag": "PDT",
        "wallTime": "2019-06-17T15:16:59.0765556-07:00"
      },
      "representativePoint": {
        "latitude": 34.05222222222222,
        "longitude": -118.24277777777777
      },
      "timeTransitions": [
        {
          "daylightSavings": "01:00:00",
          "standardOffset": "-08:00:00",
          "tag": "PDT",
          "utcEnd": "2019-11-03T09:00:00Z",
          "utcStart": "2019-03-10T10:00:00Z"
        },
        {
          "daylightSavings": "00:00:00",
          "standardOffset": "-08:00:00",
          "tag": "PST",
          "utcEnd": "2020-03-08T10:00:00Z",
          "utcStart": "2019-11-03T09:00:00Z"
        },
        {
          "daylightSavings": "01:00:00",
          "standardOffset": "-08:00:00",
          "tag": "PDT",
          "utcEnd": "2020-11-01T09:00:00Z",
          "utcStart": "2020-03-08T10:00:00Z"
        }
      ]
    }
  ],
  "version": "2019a"
}

定義

名前 説明
CountryRecord

国/地域レコード。

ErrorAdditionalInfo

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

ErrorDetail

エラーの詳細。

ErrorResponse

すべてのAzure Resource Manager APIで失敗した操作に対してエラー詳細を返す共通のエラー応答です。 (これは、OData エラー応答形式にも従います)。

JsonFormat

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

ReferenceTime

現地時刻に有効な詳細。

RepresentativePoint

代表的なポイント プロパティ

TimeTransition

タイムゾーンの移行を表しています。

TimezoneId

タイムゾーンID情報。

TimezoneNames

タイムゾーン名オブジェクト。

TimezoneOptions

結果にはタイムゾーン情報のオプションが表示されました。

TimezoneResult

このオブジェクトは、成功したタイムゾーンの ID 呼び出しまたは座標による呼び出しから返されます

CountryRecord

国/地域レコード。

名前 説明
code

string

ISO-3166 国/地域の 2 文字の国/地域コード。

name

string

国/地域名

ErrorAdditionalInfo

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

名前 説明
info

object

追加情報。

type

string

追加情報の種類。

ErrorDetail

エラーの詳細。

名前 説明
additionalInfo

ErrorAdditionalInfo[]

エラーの追加情報。

code

string

エラー コード。

details

ErrorDetail[]

エラーの詳細。

message

string

エラー メッセージ。

target

string

エラーターゲット。

ErrorResponse

すべてのAzure Resource Manager APIで失敗した操作に対してエラー詳細を返す共通のエラー応答です。 (これは、OData エラー応答形式にも従います)。

名前 説明
error

ErrorDetail

エラー オブジェクト。

JsonFormat

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

説明
json

JavaScript オブジェクト表記データ交換形式 する

ReferenceTime

現地時刻に有効な詳細。

名前 説明
daylightSavings

string

ReferenceUTCTimestampで有効な時間を分単位で節約できます。

posixTz

string

タイム ゾーン環境変数の設定に使用される POSIX 文字列。

posixTzValidYear

integer (int32)

この POSIX 文字列が有効な年。 注: POSIX 文字列は、指定された年にのみ有効です。

standardOffset

string

ReferenceUTCTimestampで有効な UTC オフセット。

sunrise

string (date-time)

Tag プロパティに示すように、指定されたタイム ゾーンの日の出は、呼び出しが byCoordinatesされたときにのみ設定されます。 日の出は ISO 8601 形式で記述されています。 Timezone API では、要求されたリージョンで日の出と日の入りの時刻が返されないことに注意してください。

sunset

string (date-time)

Tag プロパティに示すように、指定されたタイム ゾーンでのサンセット。呼び出しが byCoordinates場合にのみ設定されます。 サンセットは、ISO 8601 形式で記述されています。 Timezone API では、要求されたリージョンで日の出と日の入りの時刻が返されないことに注意してください。

tag

string

参照タイムスタンプで有効なタイム ゾーン名 (つまり、夏時間が有効かどうかに応じて PST または PDT)。

wallTime

string

Tag プロパティに示すように、特定のタイム ゾーンでの現在の壁の時刻。

RepresentativePoint

代表的なポイント プロパティ

名前 説明
latitude

number (float)

Latitude プロパティ

longitude

number (float)

Longitude プロパティ

TimeTransition

タイムゾーンの移行を表しています。

名前 説明
daylightSavings

string

DaylightSavings プロパティ

standardOffset

string

StandardOffset プロパティ

tag

string

Tag プロパティ

utcEnd

string (date-time)

この移行期間の終了日、終了時刻

utcStart

string (date-time)

この移行期間の開始日、開始時刻

TimezoneId

タイムゾーンID情報。

名前 説明
aliases

string[]

タイム ゾーン ID エイリアスの配列。 [options]=zoneinfo またはすべての場合にのみ返されます。

注: null である可能性があります。

countries

CountryRecord[]

国/地域レコードの配列。 [options]=zoneinfo またはすべての場合にのみ返されます。

id

string

Id プロパティ

names

TimezoneNames

タイムゾーン名オブジェクト。

referenceTime

ReferenceTime

現地時刻に有効な詳細。

representativePoint

RepresentativePoint

代表的なポイント プロパティ

timeTransitions

TimeTransition[]

タイム ゾーン DST は、[transitionsFrom] からタイムスタンプ + 1 年に遷移します。

TimezoneNames

タイムゾーン名オブジェクト。

名前 説明
daylight

string

夏時間の名前

generic

string

属名

iso6391LanguageCode

string

名前の ISO 639-1 言語コード

standard

string

標準名

TimezoneOptions

結果にはタイムゾーン情報のオプションが表示されました。

説明
none

結果に zoneinfo や遷移を含めないでください。

zoneInfo

結果に追加のタイムゾーン情報を含めます。

transitions

結果に遷移情報を含めます(現在、遷移の数は 250 に制限されています)。

all

結果に zoneinfo と transitions の両方を含めます。

TimezoneResult

このオブジェクトは、成功したタイムゾーンの ID 呼び出しまたは座標による呼び出しから返されます

名前 説明
referenceUtcTimestamp

string (date-time)

Reference Utc Timestamp プロパティ

timeZones

TimezoneId[]

TimeZoneId 配列

version

string

バージョン プロパティ