次の方法で共有


Render - Get Map Tile

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

Get Map Tiles API を使用すると、ユーザーはベクター形式またはラスター形式のマップ タイルを要求でき、通常はマップ コントロールまたは SDK に統合できます。 サポートされているタイルタイプには、Azure Mapsの道路タイルやリアルタイムの気象レーダータイルがあります。 デフォルトでは、Azure Maps Web 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が提供するすぐに使えるタイルセットは以下の通りです。 たとえば、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)

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

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

LocalizedMapView

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の認証管理Manage certificationをご覧ください。

応答

名前 説明
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 とスコープに対するアクセス制御が可能なオブジェクトを介してアプリケーションをモデル化するためのソリューションを提供します。

注記

  • このセキュリティ定義要求アプリケーションがどのAzure Mapsリソースにアクセスを要求しているかを示すためにx-ms-client-idヘッダーを使用します。 これは、Maps 管理 APIから取得できます。

Authorization URLはAzureパブリッククラウドインスタンス専用です。 ソブリンクラウドは固有の認可URLとMicrosoft Entra IDの設定を持っています。 * Azureロールベースのアクセス制御は、Azureポータル、PowerShell、CLI、Azure SDKs、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 Mapsリソースを作成する際に、Azureポータル、PowerShell、CLI、Azure SDKs、REST APIを通じてAzure管理プレーンを通じてプロビジョニングされます。

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

公開されているアプリケーションについては、このキーを安全に保存できるAzure Maps REST APIのサーバー間アクセスを利用することを推奨します。

型: apiKey
/: header

SAS Token

これは共有アクセス署名トークンで、Azure MapsリソースのList SAS操作からAzureポータル、PowerShell、CLI、Azure SDKs、REST APIを通じてAzure管理プレーンを経由して作成されます。

このトークンにより、どのアプリケーションも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 パラメーター ("ユーザーリージョン" パラメーターとも呼ばれます) を使用すると、地政学的に紛争が生じしている地域の特定の国/地域の正しいマップを表示できます。 このようなリージョンのビューは国や地域によって異なります。また、View パラメーターを使用すると、アプリケーションがサービスを提供する国/地域で必要なビューにアプリケーションを準拠できます。 既定では、要求で定義していない場合でも、View パラメーターは "Unified" に設定されます。 ユーザーの場所を特定し、その場所に対して View パラメーターを正しく設定するのは、ユーザーの責任です。 または、要求の IP アドレスに基づいてマップ データを返す 'View=Auto' を設定することもできます。 Azure MapsのViewパラメータは、地図、画像、その他のデータ、第三者コンテンツがAzure Mapsを通じて公開されている国・地域の適用法、地図に関する法律を遵守して使用されなければなりません。 例: view=IN。

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

MapTileSize

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

TilesetID

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

ErrorAdditionalInfo

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

名前 説明
info

object

追加情報。

type

string

追加情報の種類。

ErrorDetail

エラーの詳細。

名前 説明
additionalInfo

ErrorAdditionalInfo[]

エラーの追加情報。

code

string

エラー コード。

details

ErrorDetail[]

エラーの詳細。

message

string

エラー メッセージ。

target

string

エラーターゲット。

ErrorResponse

エラー応答

名前 説明
error

ErrorDetail

エラー オブジェクト。

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

アメリカUnited States

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

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