Render - Get Map Tile
ベクター形式またはラスター形式でマップ タイルを要求するために使用します。
Get Map Tiles API を使用すると、ユーザーはベクター形式またはラスター形式のマップ タイルを要求でき、通常はマップ コントロールまたは SDK に統合できます。 サポートされているタイルタイプには、Azure Mapsの道路タイルやリアルタイムの気象レーダータイルがあります。 デフォルトでは、Azure Maps Web SDKはウェブマップコントロールのレンダリングにベクタータイルを使用します。
Important
Get Map Tile APIを使用する場合は、必要な地図データ帰属テキストを取得するためにGet Map Attribution APIも呼び出す必要があります。
返された帰属は、 Get Map Tile から取得したタイルがレンダリングされる場所、サードパーティのマップコントロールやカスタムレンダリング実装など、すべての場所に表示されなければなりません。
GET {endpoint}/map/tile?api-version=2024-04-01&tilesetId={tilesetId}&zoom={zoom}&x={x}&y={y}
GET {endpoint}/map/tile?api-version=2024-04-01&tilesetId={tilesetId}&zoom={zoom}&x={x}&y={y}&timeStamp={timeStamp}&tileSize={tileSize}&language={language}&view={view}
URI パラメーター
| 名前 | / | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
endpoint
|
path | True |
string (uri) |
Azure Mapsサービスのホストネーム。 Azureパブリッククラウドには |
|
api-version
|
query | True |
string minLength: 1 |
この操作に使用する API バージョン。 |
|
tileset
|
query | True |
タイルセットは、事前設定されたズーム レベルで、正方形のタイルの均一なグリッドに分割されたラスターまたはベクター データのコレクションです。 すべてのタイルセットには、要求を行うときに使用する tilesetId があります。 Azure Mapsが提供するすぐに使えるタイルセットは以下の通りです。 たとえば、microsoft.base です。 |
|
|
x
|
query | True |
integer (int32) |
ズーム グリッド上のタイルの X 座標。 値は 、[0, 2 詳細については、「ズーム レベルとタイル グリッドの」を参照してください。 |
|
y
|
query | True |
integer (int32) |
ズーム グリッド上のタイルの Y 座標。 値は 、[0, 2 詳細については、「ズーム レベルとタイル グリッドの」を参照してください。 |
|
zoom
|
query | True |
integer (int32) |
目的のタイルのズーム レベル。 詳細については、「ズーム レベルとタイル グリッドの」を参照してください。 |
|
language
|
query |
string |
検索結果を返す言語。 サポートされている IETF 言語タグの 1 つである必要があります。大文字と小文字は区別されません。 指定した言語のデータが特定のフィールドで使用できない場合は、既定の言語が使用されます。 詳細については、サポートされている言語の を参照してください。 |
|
|
tile
|
query |
返されるマップ タイルのサイズ (ピクセル単位)。 |
||
|
time
|
query |
string (date-time) |
要求されたタイルの目的の日付と時刻。 このパラメーターは、標準の日時形式 (2019-11-14T16:03:00-08:00 など) ISO 8601で定義されている形式で指定する必要があります。 このパラメーターは、tilesetId パラメーターが以下のいずれかの値に設定されている場合にのみサポートされます。
|
|
|
view
|
query |
View パラメーター ("ユーザーリージョン" パラメーターとも呼ばれます) を使用すると、地政学的に紛争が生じしている地域の特定の国/地域の正しいマップを表示できます。 このようなリージョンのビューは国や地域によって異なります。また、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セキュリティの使用についての詳細は、Azure Maps |
応答
| 名前 | 型 | 説明 |
|---|---|---|
| 200 OK |
string |
要求は成功しました。 Media Types: "application/json", "image/jpeg", "image/png", "image/pbf", "application/vnd.mapbox-vector-tile" |
| Other Status Codes |
予期しないエラー応答。 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 とスコープに対するアクセス制御が可能なオブジェクトを介してアプリケーションをモデル化するためのソリューションを提供します。
Note
- このセキュリティ定義 使用して、アプリケーションがアクセスを要求している 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 |
subscription-key
これは、Azure portal で、または PowerShell、CLI、Azure SDK、または REST API を使用して Azure Maps アカウント を作成 場合にプロビジョニングされる共有キーです。
このキーを使用すると、すべてのアプリケーションがすべての REST API にアクセスできます。 つまり、このキーは、発行されたアカウントのマスター キーとして使用できます。
パブリックに公開されているアプリケーションの場合は、キーを安全に格納できるように、機密クライアント アプリケーション アプローチを使用して Azure Maps REST API にアクセスすることをお勧めします。
型:
apiKey
/:
header
SAS Token
これは、Azure portal、PowerShell、CLI、Azure SDK、または REST API を介して Azure 管理プレーンを介して、Azure Maps リソース のリスト SAS 操作から作成される Shared Access Signature トークンです。
このトークンを使用すると、すべてのアプリケーションは、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"
定義
| 名前 | 説明 |
|---|---|
|
Error |
リソース管理エラーの追加情報。 |
|
Error |
エラーの詳細。 |
|
Error |
すべてのAzure Resource Manager APIで失敗した操作に対してエラー詳細を返す共通のエラー応答です。 (これは、OData エラー応答形式にも従います)。 |
|
Localized |
View パラメーター ("ユーザーリージョン" パラメーターとも呼ばれます) を使用すると、地政学的に紛争が生じしている地域の特定の国/地域の正しいマップを表示できます。 このようなリージョンのビューは国や地域によって異なります。また、View パラメーターを使用すると、アプリケーションがサービスを提供する国/地域で必要なビューにアプリケーションを準拠できます。 既定では、要求で定義していない場合でも、View パラメーターは "Unified" に設定されます。 ユーザーの場所を特定し、その場所に対して View パラメーターを正しく設定するのは、ユーザーの責任です。 または、要求の IP アドレスに基づいてマップ データを返す 'View=Auto' を設定することもできます。 Azure MapsのViewパラメータは、地図、画像、その他のデータ、第三者コンテンツがAzure Mapsを通じて公開されている国・地域の適用法、地図に関する法律を遵守して使用されなければなりません。 例: view=IN。 詳細については、サポートされているビューの を参照し、使用可能なビューを参照してください。 |
|
Map |
返されるマップ タイルのサイズ (ピクセル単位)。 |
| TilesetID |
タイルセットは、事前設定されたズーム レベルで、正方形のタイルの均一なグリッドに分割されたラスターまたはベクター データのコレクションです。 すべてのタイルセットには、要求を行うときに使用する tilesetId があります。 Azure Mapsが提供するすぐに使えるタイルセットは以下の通りです。 たとえば、microsoft.base です。 |
ErrorAdditionalInfo
リソース管理エラーの追加情報。
| 名前 | 型 | 説明 |
|---|---|---|
| info |
追加情報。 |
|
| type |
string |
追加情報の種類。 |
ErrorDetail
エラーの詳細。
| 名前 | 型 | 説明 |
|---|---|---|
| additionalInfo |
エラーの追加情報。 |
|
| code |
string |
エラー コード。 |
| details |
エラーの詳細。 |
|
| message |
string |
エラー メッセージ。 |
| target |
string |
エラーターゲット。 |
ErrorResponse
すべてのAzure Resource Manager APIで失敗した操作に対してエラー詳細を返す共通のエラー応答です。 (これは、OData エラー応答形式にも従います)。
| 名前 | 型 | 説明 |
|---|---|---|
| error |
エラー オブジェクト。 |
LocalizedMapView
View パラメーター ("ユーザーリージョン" パラメーターとも呼ばれます) を使用すると、地政学的に紛争が生じしている地域の特定の国/地域の正しいマップを表示できます。 このようなリージョンのビューは国や地域によって異なります。また、View パラメーターを使用すると、アプリケーションがサービスを提供する国/地域で必要なビューにアプリケーションを準拠できます。 既定では、要求で定義していない場合でも、View パラメーターは "Unified" に設定されます。 ユーザーの場所を特定し、その場所に対して View パラメーターを正しく設定するのは、ユーザーの責任です。 または、要求の IP アドレスに基づいてマップ データを返す 'View=Auto' を設定することもできます。 Azure MapsのViewパラメータは、地図、画像、その他のデータ、第三者コンテンツがAzure Mapsを通じて公開されている国・地域の適用法、地図に関する法律を遵守して使用されなければなりません。 例: view=IN。
詳細については、サポートされているビューの を参照し、使用可能なビューを参照してください。
| 値 | 説明 |
|---|---|
| AE |
アラブ首長国連邦、AE |
| AR |
アルゼンチン (アルゼンチン ビュー) |
| BH |
バーレーン (アラビアのビュー) |
| IN |
インド (インド ビュー) |
| IQ |
イラク (アラビアのビュー) |
| JO |
ヨルダン (アラビアのビュー) |
| KW |
クウェート (アラビアのビュー) |
| LB |
レバノン (アラビアのビュー) |
| MA |
モロッコ (モロッコのビュー) |
| OM |
オマーン (アラビアのビュー) |
| PK |
パキスタン (パキスタンのビュー) |
| PS |
パレスチナ自治政府 (アラビアのビュー) |
| QA |
カタール (アラビアのビュー) |
| SA |
サウジアラビア (アラビアのビュー) |
| SY |
シリア (アラビアのビュー) |
| US |
アメリカ米国 |
| YE |
イエメン (アラビアのビュー) |
| Auto |
要求の IP アドレスに基づいてマップ データを返します。 |
| Unified |
統一されたビュー (その他) |
MapTileSize
返されるマップ タイルのサイズ (ピクセル単位)。
| 値 | 説明 |
|---|---|
| 256 |
256 x 256 ピクセルのタイルを返します。 |
| 512 |
512 x 512 ピクセルのタイルを返します。 |
TilesetID
タイルセットは、事前設定されたズーム レベルで、正方形のタイルの均一なグリッドに分割されたラスターまたはベクター データのコレクションです。 すべてのタイルセットには、要求を行うときに使用する tilesetId があります。 Azure Mapsが提供するすぐに使えるタイルセットは以下の通りです。 たとえば、microsoft.base です。
| 値 | 説明 |
|---|---|
| microsoft.base |
ベース マップは、道路、自然フィーチャ、人工地物、およびベクター タイル内のそれらのフィーチャのラベルを表示する標準マップです。 ズーム レベル 0 ~ 22 をサポートします。 形式: vector (pbf)。 |
| microsoft.base.labels |
ベクター タイル内の道路、自然フィーチャ、人工フィーチャのラベルを表示します。 ズーム レベル 0 ~ 22 をサポートします。 形式: vector (pbf)。 |
| microsoft.base.hybrid |
道路、境界、ラベルのデータをベクター タイルに表示します。 ズーム レベル 0 ~ 22 をサポートします。 形式: vector (pbf)。 |
| microsoft.terra.main |
影付きレリーフとテラレイヤー。 ズーム レベル 0 ~ 6 をサポートします。 形式: ラスター (png)。 |
| microsoft.base.road |
私たちのメインスタイルを持つすべてのレイヤー。 ズーム レベル 0 ~ 22 をサポートします。 形式: ラスター (png)。 |
| microsoft.base.darkgrey |
濃い灰色のスタイルを持つすべてのレイヤー。 ズーム レベル 0 ~ 22 をサポートします。 形式: ラスター (png)。 |
| microsoft.base.labels.road |
メイン スタイルでデータにラベルを付けます。 ズーム レベル 0 ~ 22 をサポートします。 形式: ラスター (png)。 |
| microsoft.base.labels.darkgrey |
濃い灰色のスタイルでデータにラベルを付けます。 ズーム レベル 0 ~ 22 をサポートします。 形式: ラスター (png)。 |
| microsoft.base.hybrid.road |
メイン スタイルの道路、境界、ラベルのデータ。 ズーム レベル 0 ~ 22 をサポートします。 形式: ラスター (png)。 |
| microsoft.base.hybrid.darkgrey |
濃い灰色のスタイルの道路、境界、ラベルのデータ。 ズーム レベル 0 ~ 22 をサポートします。 形式: ラスター (png)。 |
| microsoft.imagery |
衛星画像または航空写真の組み合わせ。 S1 および G2 価格 SKU でのみ使用できます。 ズーム レベル 1 ~ 19 をサポートします。 形式: ラスター (png)。 |
| microsoft.weather.radar.main |
気象レーダー タイル。 雨、雪、氷、混合条件の領域を含む最新の気象レーダー画像。 Azure Maps気象サービスの報道の詳細については、Azure Maps気象サービスの報道をご覧ください。 レーダーデータの詳細については、Azure Maps<>の ズーム レベル 0 ~ 15 をサポートします。 形式: ラスター (png)。 |
| microsoft.weather.infrared.main |
赤外線タイルの天気。 最新の赤外線衛星画像は、その温度によって雲を示しています。 詳細については、Azure Maps気象サービスのカバレッジをご覧ください。 衛星データの詳細については、Azure Maps ズーム レベル 0 ~ 15 をサポートします。 形式: ラスター (png)。 |
| microsoft.traffic.absolute |
ベクトル内の絶対トラフィック タイル |
| microsoft.traffic.absolute.main |
メイン スタイルのラスター内の絶対トラフィック タイル。 |
| microsoft.traffic.relative |
ベクター内の相対トラフィック タイル |
| microsoft.traffic.relative.main |
メイン スタイルのラスター内の相対トラフィック タイル。 |
| microsoft.traffic.relative.dark |
ダーク スタイルのラスター内の相対トラフィック タイル。 |
| microsoft.traffic.delay |
ベクター内のトラフィック タイル |
| microsoft.traffic.delay.main |
メイン スタイルのラスター内のトラフィック タイル |
| microsoft.traffic.reduced.main |
メイン スタイルのラスター内のトラフィック タイルの削減 |
| microsoft.traffic.incident |
ベクター内のインシデント タイル |