Render - Get Map Static Image

Service:

Maps

API Version:

2022-08-01

0 ~ 20 のズーム レベルを使用して、マップ セクションを含むユーザー定義の四角形の画像をレンダリングする場合に使用します。

マップ イメージでサポートされている解像度の範囲は、1x1 から 8192x8192 です。 マップ タイル サービスで静的イメージ サービスを使用するタイミングを決定する場合は、レンダリングされたマップの操作方法を検討する必要があります。 マップの内容が比較的変更されない場合は、静的マップを選択することをお勧めします。 マップ コンテンツの多くのズーム、パン、変更をサポートする場合は、マップ タイル サービスの方が適しています。

サービスには、追加のデータを含む静的イメージを取得するための Image Composition 機能も用意されています。次の機能を備えたプッシュピンとジオメトリオーバーレイ。

• 複数のプッシュピン スタイルを指定する
• 円、ポリライン、ポリゴン ジオメトリタイプをレンダリングします。

詳細な例については、「 攻略ガイド 」を参照してください。

注 : center パラメーターまたは bbox パラメーターを API に指定する必要があります。

bbox パラメーターを使用する場合にサポートされる Lat と Lon の範囲は次のとおりです。

ズーム レベル	最大ロン範囲	最大緯度範囲
0	360.0	170.0
1	360.0	170.0
2	360.0	170.0
3	360.0	170.0
4	360.0	170.0
5	180.0	85.0
6	90.0	42.5
7	45.0	21.25
8	22.5	10.625
9	11.25	5.3125
10	5.625	2.62625
11	2.8125	1.328125
12	1.40625	0.6640625
13	0.703125	0.33203125
14	0.3515625	0.166015625
15	0.17578125	0.0830078125
16	0.087890625	0.0415039063
17	0.0439453125	0.0207519531
18	0.0219726563	0.0103759766
19	0.0109863281	0.0051879883
20	0.0054931641	0.0025939941

GET https://atlas.microsoft.com/map/static/png?api-version=2022-08-01

With optional parameters:

GET https://atlas.microsoft.com/map/static/png?api-version=2022-08-01&layer={layer}&style={style}&zoom={zoom}&center={center}&bbox={bbox}&height={height}&width={width}&language={language}&view={view}&pins={pins}&path={path}

URI パラメーター

名前	/	必須	型	説明
format	path	True	RasterTileFormat	応答の目的の形式。 使用可能な値: png。
api-version	query	True	string	Azure Maps API のバージョン番号。 現在のバージョンは 2022-08-01 です
bbox	query		number[]	境界ボックス。 使用されるプロジェクション - EPSG:3857。 形式: 'minLon、minLat、maxLon、maxLat' 注: bbox または center は必須パラメーターです。 これらは相互に排他的です。 高さまたは幅で使用しないでください。 Lat と Lon に許可される最大範囲は、このページの上部にあるテーブルのズーム レベルごとに定義されます。
center	query		number[]	中心点の座標。 形式: 'lon,lat' 使用されるプロジェクション EPSG:3857。 経度の範囲: -180 から 180。 緯度の範囲: -85 から 85。 注: center または bbox は必須パラメーターです。 これらは相互に排他的です。
height	query		integer int32	結果の画像の高さ (ピクセル単位)。 範囲は 1 ~ 8192 です。 既定値は 512 です。 bbox では使用しないでください。
language	query		string	検索結果を返す言語。 サポートされている IETF 言語タグの 1 つである必要があります。大文字と小文字は区別されません。 指定した言語のデータが特定のフィールドで使用できない場合は、既定の言語が使用されます。 詳細については、「 サポートされている言語 」を参照してください。
layer	query		StaticMapLayer	要求されたマップ レイヤー。 レイヤーがラベルまたはハイブリッドに設定されている場合、形式は png にする必要があります。
path	query		string[]	パスのスタイルと場所。 必要に応じて、線、多角形、または円を画像に追加するには、このパラメーターを使用します。 パス スタイルは、線と塗りつぶしの外観を表します。 (パイプや句読点などの予約文字が含まれるため、このパラメーターの値を正しく URL エンコードしてください)。 パス パラメーターは、S1 以降Azure Mapsアカウント SKU でサポートされています。 path パラメーターの複数のインスタンスを使用すると、スタイルを使用して複数のジオメトリを指定できます。 要求あたりのパラメーターの数は 10 に制限され、場所の数はパスあたり 100 個に制限されます。 既定のスタイルを使用して半径 100 メートル、緯度 45°N、経度 122°W の中心点を持つ円をレンダリングするには、querystring パラメーターを追加します。 path=ra100||-122 45 経度は緯度より前に来る点に注意してください。 URL エンコードの後、これは次のようになります path=ra100%7C%7C-122+45 ここでの例はすべて、URL エンコードなしの path パラメーターを示しています。わかりやすくするためにします。 線をレンダリングするには、各位置をパイプ文字で区切ります。 たとえば、次を使用します。 path=||-122 45|-119.5 43.2|-121.67 47.12 多角形をレンダリングするには、最後の位置が開始位置と等しい必要があります。 たとえば、次を使用します。 path=||-122 45|-119.5 43.2|-121.67 47.12|-122 45 ラインとポリゴンの位置の経度と緯度の値は、-360 ~ 360 の範囲に設定して、アンチメリディアンを横断するジオメトリをレンダリングできます。 スタイル修飾子 スタイル修飾子を追加することで、パスの外観を変更できます。 これらは、場所の前に追加されます。 スタイル修飾子はそれぞれ 2 文字の名前を持ちます。 これらの短縮名は、URL の長さを短くするために使用されます。 アウトラインの色を変更するには、'lc' スタイル修飾子を使用し、6 桁の 16 進数である HTML/CSS RGB カラー形式を使用して色を指定します (3 桁の形式はサポートされていません)。 たとえば、CSS で #FF1493 として指定する深いピンク色を使用するには、 path=lcFF1493||-122 45|-119.5 43.2 複数のスタイル修飾子を組み合わせて、より複雑なビジュアル スタイルを作成できます。 lc0000FF|lw3|la0.60|fa0.50||-122.2 47.6|-122.2 47.7|-122.3 47.7|-122.3 47.6|-122.2 47.6 スタイル修飾子の概要 修飾子 説明 Range Lc 線の色 000000 から FFFFFF fc 塗りつぶしの色 000000 から FFFFFF la 線のアルファ (不透明度) 0 から 1 fa 塗りつぶしのアルファ (不透明度) 0 から 1 Lw [線の幅] 0 より大きい。 Ra 円の半径 (メートル) 0 より大きい。
pins	query		string[]	プッシュピン のスタイルとインスタンス。 必要に応じて、イメージに画酉を追加するには、このパラメーターを使用します。 プッシュピン スタイルは、画酉の外観を表し、インスタンスは各ピンのプッシュピンの座標とオプションのラベルを指定します。 (パイプや句読点などの予約文字が含まれるため、このパラメーターの値を正しく URL エンコードしてください)。 Azure Maps アカウント S0 SKU では、pin パラメーターの 1 つのインスタンスのみがサポートされます。 他の SKU を使用すると、pin パラメーターの複数のインスタンスで複数のピン スタイルを指定できます。 既定の組み込みプッシュピン スタイルを使用して緯度 45°N と経度 122°W で画酉をレンダリングするには、querystring パラメーターを追加します pins=default||-122 45 経度は緯度より前に来る点に注意してください。 URL エンコードの後、これは次のようになります pins=default%7C%7C-122+45 ここでの例はすべて、わかりやすくするために、URL エンコードを使用しない pin パラメーターを示しています。 複数の場所にピンをレンダリングするには、各場所をパイプ文字で区切ります。 たとえば、次を使用します。 pins=default||-122 45|-119.5 43.2|-121.67 47.12 S0 Azure Maps アカウント SKU では、5 つのプッシュピンのみが許可されます。 他のアカウント SKU には、この制限はありません。 スタイル修飾子 ピンの外観を変更するには、スタイル修飾子を追加します。 これらは、スタイルの後、場所とラベルの前に追加されます。 スタイル修飾子はそれぞれ 2 文字の名前を持ちます。 これらの短縮名は、URL の長さを短くするために使用されます。 プッシュピンの色を変更するには、'co' スタイル修飾子を使用し、6 桁の 16 進数である HTML/CSS RGB カラー形式を使用して色を指定します (3 桁の形式はサポートされていません)。 たとえば、CSS で #FF1493 として指定する深いピンク色を使用するには、 pins=default|coFF1493||-122 45 画酉ラベル ピンにラベルを追加するには、ラベルを座標の直前に単一引用符で囲みます。 たとえば、3 つのピンに値 '1'、'2'、および '3' のラベルを付ける場合は、 pins=default||'1'-122 45|'2'-119.5 43.2|'3'-121.67 47.12 "なし" と呼ばれる組み込みの画酉スタイルがあり、画酉画像は表示されません。 これは、ピン イメージなしでラベルを表示する場合に使用できます。 たとえば、オブジェクトに適用された pins=none||'A'-122 45|'B'-119.5 43.2 プッシュピン ラベルの色を変更するには、'lc' ラベルの色スタイル修飾子を使用します。 たとえば、ピンクのプッシュピンと黒いラベルを使用するには、 pins=default|coFF1493|lc000000||-122 45 ラベルのサイズを変更するには、'ls' ラベル サイズ スタイル修飾子を使用します。 ラベル サイズは、ラベル テキストのおおよその高さをピクセル単位で表します。 たとえば、ラベル サイズを 12 に増やすには、 pins=default|ls12||'A'-122 45|'B'-119 43 ラベルは、画鋲 'label anchor' の中央に配置されます。 アンカーの位置は、組み込みのプッシュピンに対して事前に定義されており、カスタム プッシュピンの上部中央にあります (以下を参照)。 ラベル アンカーをオーバーライドするには、'la' スタイル修飾子を使用し、アンカーの X ピクセル座標と Y ピクセル座標を指定します。 これらの座標は、画酉画像の左上隅を基準にしています。 正の X 値を指定するとアンカーが右に移動し、正の Y 値を指定するとアンカーが下方向に移動します。 たとえば、ラベル アンカーを 10 ピクセル右に配置し、4 ピクセルを画鋲画像の左上隅の上に配置するには、 pins=default|la10 -4||'A'-122 45|'B'-119 43 カスタム プッシュピン カスタム プッシュピン イメージを使用するには、ピン スタイル名として "custom" という単語を使用し、場所とラベル情報の後に URL を指定します。 2 つのパイプ文字を使用して、場所の指定が完了し、URL を開始していることを示します。 たとえば、オブジェクトに適用された pins=custom||-122 45||http://contoso.com/pushpins/red.png URL エンコードの後、これは次のようになります pins=custom%7C%7C-122+45%7C%7Chttp%3A%2F%2Fcontoso.com%2Fpushpins%2Fred.png 既定では、カスタム プッシュピン イメージはピン座標の中央に描画されます。 これは通常、強調表示しようとしている場所が隠れているため、理想的ではありません。 ピン イメージのアンカー位置をオーバーライドするには、'an' スタイル修飾子を使用します。 これは、'la' ラベル アンカー スタイル修飾子と同じ形式を使用します。 たとえば、カスタムピンイメージの左上隅にピンの先端がある場合は、 を使用してアンカーをそのスポットに設定できます。 pins=custom|an0 0||-122 45||http://contoso.com/pushpins/red.png 注: カスタム プッシュピン イメージで "co" カラー修飾子を使用する場合、指定した色はイメージ内のピクセルの RGB チャネルを置き換えますが、アルファ (不透明度) チャネルは変更されません。 通常、これは単色のカスタム イメージでのみ行われます。 スケール、回転、不透明度 'sc' スケール スタイル修飾子を使用して、プッシュピンとそのラベルを大きくまたは小さくすることができます。 これは 0 より大きい値です。 1 の値が標準のスケールです。 1 より大きい値にするとピンが大きくなり、1 より小さい値にすると小さくなります。 たとえば、通常より 50% 大きい画酉を描画するには、 pins=default|sc1.5||-122 45 'ro' 回転スタイル修飾子を使用して、プッシュピンとそのラベルを回転できます。 これは時計回りの回転の角度です。 負の数を使用して反時計回りに回転します。 たとえば、プッシュピンを時計回りに 90 度回転し、そのサイズを 2 倍にするには、 pins=default|ro90|sc2||-122 45 "al" アルファ スタイル修飾子を指定することで、プッシュピンとそのラベルを部分的に透明にすることができます。 これは、画酉の不透明度を示す 0 ~ 1 の範囲の数値です。 ゼロを指定すると、完全に透明になり (表示されません)、1 で完全に不透明になります (既定値)。 たとえば、プッシュピンとそのラベルを 67% だけ不透明にするには、 pins=default|al.67||-122 45 スタイル修飾子の概要 修飾子 説明 Range al アルファ (不透明度) 0 から 1 1 つ アンカーをピン留めする * co ピンの色 000000 から FFFFFF la ラベル アンカー * Lc ラベルの色 000000 から FFFFFF ls ラベル のサイズ 0 より大きい。 ro 回転 -360 から 360 Sc スケール 0 より大きい。 X 座標と Y 座標は、ピン イメージ内の任意の場所、またはその周囲の余白にすることができます。 余白のサイズは、ピンの幅と高さの最小値です。
style	query		MapImageStyle	返されるマップ スタイル。 指定できる値は、メインと濃色です。
view	query		LocalizedMapView	View パラメーター ("user region" パラメーターとも呼ばれます) を使用すると、地政学的に紛争が発生している地域の特定の国/地域の正しいマップを表示できます。 このようなリージョンのビューは国や地域によって異なります。また、View パラメーターを使用すると、アプリケーションがサービスを提供する国/地域に必要なビューにアプリケーションを準拠できます。 既定では、View パラメーターは、要求で定義していない場合でも "Unified" に設定されます。 ユーザーの場所を特定し、その場所を正しく View パラメーターを設定するのはユーザーの責任です。 または、要求の IP アドレスに基づいてマップ データを返す 'View = Auto' を設定することもできます。 Azure Mapsの View パラメーターは、マップ、画像、その他のデータ、Azure Maps経由でアクセスする権限を持つ第三者のコンテンツが利用可能になる国/地域のマッピングに関するものを含む、適用される法律に準拠して使用する必要があります。 例: view=IN。 詳細については、「 サポートされているビュー 」を参照し、使用可能なビューを参照してください。
width	query		integer int32	結果の画像の幅 (ピクセル単位)。 範囲は 1 ~ 8192 です。 既定値は 512 です。 bbox では使用しないでください。
zoom	query		integer int32	マップの目的のズーム レベル。 ズーム値は、0 から 20 (両端を含む) の範囲である必要があります。 既定値は 12 です。 詳細については、「 ズーム レベルとタイル グリッド 」を参照してください。

要求ヘッダー

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

応答

名前	型	説明
200 OK	object	このイメージは、マップの静的イメージの取得に成功した呼び出しから返されます Media Types: "application/json", "image/jpeg", "image/png", "image/pbf", "application/vnd.mapbox-vector-tile" Headers Content-Type: string
Other Status Codes	ErrorResponse	予期しないエラーが発生しました。 Media Types: "application/json", "image/jpeg", "image/png", "image/pbf", "application/vnd.mapbox-vector-tile"

セキュリティ

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

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

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

Type: apiKey
In: header

SAS Token

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

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

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

Type: apiKey
In: header

例

Successful Static Image Request

Sample Request

HTTP

GET https://atlas.microsoft.com/map/static/png?api-version=2022-08-01&layer=basic&style=main&zoom=2&bbox=1.355233,42.982261,24.980233,56.526017

Sample Response

Status code:

200

Content-Type: image/png

Response Body

"{file}"

定義

名前	説明
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
LocalizedMapView	View パラメーター ("user region" パラメーターとも呼ばれます) を使用すると、地政学的に紛争が発生している地域の特定の国/地域の正しいマップを表示できます。 このようなリージョンのビューは国や地域によって異なり、View パラメーターを使用すると、アプリケーションが提供する国/地域に必要なビューにアプリケーションを準拠できます。 既定では、要求で定義していない場合でも、View パラメーターは "Unified" に設定されます。 ユーザーの場所を特定し、その場所を正しく View パラメーターを設定するのはユーザーの責任です。 または、要求の IP アドレスに基づいてマップ データを返す 'View = Auto' を設定することもできます。 Azure Mapsの View パラメーターは、マップ、画像、その他のデータ、Azure Maps経由でアクセスする権限を持つ第三者のコンテンツが利用可能になる国/地域のマッピングに関する法律を含む、適用される法律に準拠して使用する必要があります。 例: view=IN。 詳細については、「 サポートされているビュー 」を参照し、使用可能なビューを参照してください。
MapImageStyle	返されるマップ スタイル。 指定できる値は、メインと濃色です。
RasterTileFormat	応答の目的の形式。 指定できる値: png。
StaticMapLayer	要求されたマップ レイヤー。 レイヤーがラベルまたはハイブリッドに設定されている場合、形式は png にする必要があります。

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	イエメン (アラビアのビュー)

MapImageStyle

返されるマップ スタイル。 指定できる値は、メインと濃色です。

名前	型	説明
dark	string	Azure Maps メイン スタイルの濃い灰色のバージョン
main	string	Azure Maps メイン スタイル

RasterTileFormat

応答の目的の形式。 指定できる値: png。

名前	型	説明
png	string	png 形式の画像。 ズーム レベル 0 ~ 18 をサポートします。

StaticMapLayer

要求されたマップ レイヤー。 レイヤーがラベルまたはハイブリッドに設定されている場合、形式は png にする必要があります。

名前	型	説明
basic	string	ポリゴン、境界線、道路、ラベルを含むすべてのマップ フィーチャを含む画像を返します。
hybrid	string	境界線、道路、ラベルを含む画像を返し、他のタイル (衛星画像など) に重ねてハイブリッド タイルを生成できます。
labels	string	マップのラベル情報のみを示す画像を返します。