次の方法で共有


Render - Get Map Tile

ベクター形式またはラスター形式でマップ タイルを要求する場合に使用します。

ユーザーが Get Map Tiles ベクター形式またはラスター形式のマップ タイルを要求できるようにする HTTP GET 要求の API は、通常、マップ コントロールまたは SDK に統合されます。 要求できるタイルの例としては、Azure Maps の道路タイル、リアルタイムの天気予報レーダー タイル、 または Azure Maps Creator を使用して作成されたマップ タイルがあります。 既定では、Azure Maps では、Web マップ コントロール (Web SDK) と Android SDK にベクター タイルが使用されます。

GET https://atlas.microsoft.com/map/tile?api-version=2024-04-01&tilesetId={tilesetId}&zoom={zoom}&x={x}&y={y}
GET https://atlas.microsoft.com/map/tile?api-version=2024-04-01&tilesetId={tilesetId}&zoom={zoom}&x={x}&y={y}&timeStamp={timeStamp}&tileSize={tileSize}&language={language}&view={view}

URI パラメーター

名前 / 必須 説明
api-version
query True

string

Azure Maps API のバージョン番号。 現在のバージョンは 2024-04-01 です。

tilesetId
query True

TilesetID

タイルセットは、事前設定されたズーム レベルで、正方形のタイルの均一なグリッドに分割されたラスターまたはベクター データのコレクションです。 すべてのタイルセットには、要求を行うときに使用する tilesetId があります。 Azure Maps Creator を使用して作成されたタイルセットの tilesetId は、Tileset Create API を使用して生成されます。 Azure Maps によって提供されるすぐに使用できるタイルセットを次に示します。 たとえば、microsoft.base です。

x
query True

integer

int32

ズーム グリッド上のタイルの X 座標。 値は [0, 2zoom -1] の範囲内である必要があります。

詳細については、「 ズーム レベルとタイル グリッド 」を参照してください。

y
query True

integer

int32

ズーム グリッド上のタイルの Y 座標。 値は [0, 2zoom -1] の範囲内である必要があります。

詳細については、「 ズーム レベルとタイル グリッド 」を参照してください。

zoom
query True

integer

int32

目的のタイルのズーム レベル。

詳細については、「 ズーム レベルとタイル グリッド 」を参照してください。

language
query

string

検索結果を返す言語。 サポートされている IETF 言語タグの 1 つである必要があります。大文字と小文字は区別されません。 指定した言語のデータが特定のフィールドで使用できない場合は、既定の言語が使用されます。

詳細については、「 サポートされている言語 」を参照してください。

tileSize
query

MapTileSize

返されるマップ タイルのサイズ (ピクセル単位)。

timeStamp
query

string

date-time

要求されたタイルの目的の日付と時刻。 このパラメーターは、 ISO 8601 で定義されているように、標準の日時形式 (例: 2019-11-14T16:03:00-08:00) で指定する必要があります。 このパラメーターは、tilesetId パラメーターが次のいずれかの値に設定されている場合にのみサポートされます。

  • microsoft.weather.infrared.main: 過去 3 時間までのタイルを提供しています。 タイルは 10 分間隔で使用できます。 timeStamp 値を最も近い 10 分の時間枠に丸めます。
  • microsoft.weather.radar.main: 過去 1.5 時間までのタイルと、今後最大 2 時間のタイルを提供します。 タイルは 5 分間隔で使用できます。 timeStamp 値を最も近い 5 分の時間枠に丸めます。
view
query

LocalizedMapView

View パラメーター ("user region" パラメーターとも呼ばれます) を使用すると、地政学的に紛争が発生している地域の特定の国/地域の正しいマップを表示できます。 このようなリージョンのビューは国や地域によって異なり、View パラメーターを使用すると、アプリケーションが提供する国/地域に必要なビューにアプリケーションを準拠できます。 既定では、要求で定義していない場合でも、View パラメーターは "Unified" に設定されます。 ユーザーの場所を特定し、その場所を正しく View パラメーターを設定するのはユーザーの責任です。 または、要求の IP アドレスに基づいてマップ データを返す 'View = Auto' を設定することもできます。 Azure Maps の View パラメーターは、マップ、画像、その他のデータ、および Azure Maps 経由でアクセスする権限を持つ第三者のコンテンツが利用可能になる国/地域のマッピングに関する法律を含む、適用される法律に準拠して使用する必要があります。 例: view=IN。

詳細については、「 サポートされているビュー 」を参照し、使用可能なビューを参照してください。

要求ヘッダー

名前 必須 説明
x-ms-client-id

string

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

応答

名前 説明
200 OK

object

成功した API 呼び出しから返されたタイル。

Media Types: "application/json", "image/jpeg", "image/png", "image/pbf", "application/vnd.mapbox-vector-tile"

ヘッダー

Content-Type: string

Other Status Codes

ErrorResponse

予期しないエラーが発生しました。

Media Types: "application/json", "image/jpeg", "image/png", "image/pbf", "application/vnd.mapbox-vector-tile"

セキュリティ

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

型: 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、PowerShell、CLI、Azure SDK、または REST API を使用して Azure 管理プレーンを使用して Azure Maps リソース を作成するときにプロビジョニングされる共有キーです。

このキーを使用すると、すべてのアプリケーションがすべての REST API にアクセスすることが許可されます。 つまり、これらは現在、発行先のアカウントのマスター キーとして扱うことができます。

公開されているアプリケーションの場合、このキーを安全に格納できる Azure Maps REST API のサーバー間アクセスを使用することをお勧めします。

型: apiKey
/: header

SAS Token

これは、Azure portal、PowerShell、CLI、Azure SDK、または REST API を介して Azure 管理プレーンを介して、Azure Maps リソース の List SAS 操作から作成される共有アクセス署名トークンです。

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

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

型: apiKey
/: header

Successful Tile Request

要求のサンプル

GET https://atlas.microsoft.com/map/tile?api-version=2024-04-01&tilesetId=microsoft.base&zoom=6&x=10&y=22

応答のサンプル

Content-Type: application/vnd.mapbox-vector-tile
"binary image string"

定義

名前 説明
ErrorAdditionalInfo

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

ErrorDetail

エラーの詳細。

ErrorResponse

エラー応答

LocalizedMapView

View パラメーター ("user region" パラメーターとも呼ばれます) を使用すると、地政学的に紛争が発生している地域の特定の国/地域の正しいマップを表示できます。 このようなリージョンのビューは国や地域によって異なります。また、View パラメーターを使用すると、アプリケーションがサービスを提供する国/地域に必要なビューにアプリケーションを準拠できます。 既定では、View パラメーターは、要求で定義していない場合でも "Unified" に設定されます。 ユーザーの場所を特定し、その場所を正しく View パラメーターを設定するのはユーザーの責任です。 または、要求の IP アドレスに基づいてマップ データを返す 'View = Auto' を設定することもできます。 Azure Maps の View パラメーターは、マップ、画像、その他のデータ、および Azure Maps 経由でアクセスする権限を持つサード パーティのコンテンツが利用可能になる国/地域のマッピングに関する法律を含む、適用される法律に準拠して使用する必要があります。 例: view=IN。

詳細については、「 サポートされているビュー」 を参照し、使用可能なビューを参照してください。

MapTileSize

返されるマップ タイルのサイズ (ピクセル単位)。

TilesetID

タイルセットは、事前設定されたズーム レベルで、正方形のタイルの均一なグリッドに分割されたラスターまたはベクター データのコレクションです。 すべてのタイルセットには、要求を行うときに使用する tilesetId があります。 Azure Maps Creator を使用して作成されたタイルセットの tilesetId は、Tileset Create API を使用して生成されます。 Azure Maps によって提供されるすぐに使用できるタイルセットを次に示します。 たとえば、microsoft.base です。

ErrorAdditionalInfo

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

名前 説明
info

object

追加情報。

type

string

追加情報の種類。

ErrorDetail

エラーの詳細。

名前 説明
additionalInfo

ErrorAdditionalInfo[]

エラーの追加情報。

code

string

エラー コード。

details

ErrorDetail[]

エラーの詳細です。

message

string

エラー メッセージ。

target

string

エラーのターゲット。

ErrorResponse

エラー応答

名前 説明
error

ErrorDetail

error オブジェクト。

LocalizedMapView

View パラメーター ("user region" パラメーターとも呼ばれます) を使用すると、地政学的に紛争が発生している地域の特定の国/地域の正しいマップを表示できます。 このようなリージョンのビューは国や地域によって異なります。また、View パラメーターを使用すると、アプリケーションがサービスを提供する国/地域に必要なビューにアプリケーションを準拠できます。 既定では、View パラメーターは、要求で定義していない場合でも "Unified" に設定されます。 ユーザーの場所を特定し、その場所を正しく View パラメーターを設定するのはユーザーの責任です。 または、要求の IP アドレスに基づいてマップ データを返す 'View = Auto' を設定することもできます。 Azure Maps の View パラメーターは、マップ、画像、その他のデータ、および Azure Maps 経由でアクセスする権限を持つサード パーティのコンテンツが利用可能になる国/地域のマッピングに関する法律を含む、適用される法律に準拠して使用する必要があります。 例: view=IN。

詳細については、「 サポートされているビュー」 を参照し、使用可能なビューを参照してください。

名前 説明
AE

string

アラブ首長国連邦、AE

AR

string

アルゼンチン (アルゼンチン ビュー)

Auto

string

要求の IP アドレスに基づいてマップ データを返します。

BH

string

バーレーン (アラビアのビュー)

IN

string

インド (インド ビュー)

IQ

string

イラク (アラビアのビュー)

JO

string

ヨルダン (アラビアのビュー)

KW

string

クウェート (アラビアのビュー)

LB

string

レバノン (アラビアのビュー)

MA

string

モロッコ (モロッコのビュー)

OM

string

オマーン (アラビアのビュー)

PK

string

パキスタン (パキスタンのビュー)

PS

string

パレスチナ自治政府 (アラビアのビュー)

QA

string

カタール (アラビアのビュー)

SA

string

サウジアラビア (アラビアのビュー)

SY

string

シリア (アラビアのビュー)

Unified

string

統一されたビュー (その他)

YE

string

イエメン (アラビアのビュー)

MapTileSize

返されるマップ タイルのサイズ (ピクセル単位)。

名前 説明
256

string

256 x 256 ピクセルのタイルを返します。

512

string

512 x 512 ピクセルのタイルを返します。

TilesetID

タイルセットは、事前設定されたズーム レベルで、正方形のタイルの均一なグリッドに分割されたラスターまたはベクター データのコレクションです。 すべてのタイルセットには、要求を行うときに使用する tilesetId があります。 Azure Maps Creator を使用して作成されたタイルセットの tilesetId は、Tileset Create API を使用して生成されます。 Azure Maps によって提供されるすぐに使用できるタイルセットを次に示します。 たとえば、microsoft.base です。

名前 説明
microsoft.base

string

ベース マップは、道路、自然フィーチャ、人工地物、およびそれらのフィーチャのラベルをベクター タイルに表示する標準マップです。

ズーム レベル 0 ~ 22 をサポートします。 形式: vector (pbf)。

microsoft.base.darkgrey

string

ダークグレーのスタイルを持つすべてのレイヤー。

ズーム レベル 0 ~ 22 をサポートします。 形式: ラスター (png)。

microsoft.base.hybrid

string

ベクター タイルに道路、境界、ラベルのデータを表示します。

ズーム レベル 0 ~ 22 をサポートします。 形式: vector (pbf)。

microsoft.base.hybrid.darkgrey

string

濃い灰色のスタイルで道路、境界、ラベルデータ。

ズーム レベル 0 ~ 22 をサポートします。 形式: ラスター (png)。

microsoft.base.hybrid.road

string

メイン スタイルの道路、境界、ラベル データ。

ズーム レベル 0 ~ 22 をサポートします。 形式: ラスター (png)。

microsoft.base.labels

string

ベクター タイル内の道路、自然フィーチャ、人工フィーチャのラベルを表示します。

ズーム レベル 0 ~ 22 をサポートします。 形式: vector (pbf)。

microsoft.base.labels.darkgrey

string

濃い灰色のスタイルでデータにラベルを付けます。

ズーム レベル 0 ~ 22 をサポートします。 形式: ラスター (png)。

microsoft.base.labels.road

string

メイン スタイルでデータにラベルを付けます。

ズーム レベル 0 ~ 22 をサポートします。 形式: ラスター (png)。

microsoft.base.road

string

メイン スタイルを持つすべてのレイヤー。

ズーム レベル 0 ~ 22 をサポートします。 形式: ラスター (png)。

microsoft.imagery

string

衛星と航空画像の組み合わせ。 S1 価格 SKU でのみ使用できます。

ズーム レベル 1 ~ 19 をサポートします。 形式: ラスター (jpeg)。

microsoft.terra.main

string

影付きのレリーフとテラ レイヤー。

ズーム レベル 0 ~ 6 をサポートします。 形式: ラスター (png)。

microsoft.traffic.absolute

string

ベクトル内の絶対トラフィック タイル

microsoft.traffic.absolute.main

string

メインスタイルのラスターの絶対トラフィックタイル。

microsoft.traffic.delay

string

ベクター内のトラフィック タイル

microsoft.traffic.delay.main

string

メイン スタイルのラスターのトラフィック タイル

microsoft.traffic.incident

string

ベクター内のインシデント タイル

microsoft.traffic.reduced.main

string

メイン スタイルのラスターのトラフィック タイルを減らしました

microsoft.traffic.relative

string

ベクター内の相対トラフィック タイル

microsoft.traffic.relative.dark

string

ダーク スタイルのラスター内の相対トラフィック タイル。

microsoft.traffic.relative.main

string

メイン スタイルのラスター内の相対トラフィック タイル。

microsoft.weather.infrared.main

string

天気赤外線タイル。 最新の赤外線衛星画像は、温度によって雲を示しています。 詳細については、「 Azure Maps Weather Services のカバレッジ」を参照してください。 返されるサテライト データの詳細については、「 Azure Maps の Weather サービス」を参照してください。

ズーム レベル 0 ~ 15 をサポートします。 形式: ラスター (png)。

microsoft.weather.radar.main

string

気象レーダー タイル。 雨、雪、氷、混合条件の領域を含む最新の気象レーダー画像。 Azure Maps Weather サービスのカバレッジの詳細については、「 Azure Maps Weather Services のカバレッジ」を参照してください。 レーダー データの詳細については、「 Azure Maps の Weather サービス」を参照してください。

ズーム レベル 0 ~ 15 をサポートします。 形式: ラスター (png)。