静的地図画像取得
/map_image [GET] [POST]
基本情報
概要
- パラメータに指定された場所・範囲・ズーム値の静的地図画像を取得します
- パラメータにて設定された図形描画(線・円・アイコン)を地図画像上に描画します
URL
https://{HOST}/{CID}/v1/map_image
※Rakuten RapidAPIの場合はURL体系が異なります
出力形式
- PNG
対応言語
- ja
本 API を使用する際は、 利用規約の表示について にある規約を含めてください。
パラメータ
パラメータ名 | 必須 | 概要 | 型名 | デフォルト値 | 上下限/選択値 | 備考 |
---|---|---|---|---|---|---|
center | (✔) | 表示中心緯度経度 | カンマ区切りの数値 | BODYにpathを指定している場合は指定不要です | ||
zoom | (✔) | ズーム値 | 数値 | 最小値:6 最大値:19 |
BODYにpathを指定している場合は指定不要です | |
height | ✔ | 表示サイズ(高さ)(単位:px) | 数値 | 最小値:1 最大値:999 |
||
width | ✔ | 表示サイズ(幅)(単位:px) | 数値 | 最小値:1 最大値:999 |
||
use_traffic | 渋滞情報元 | 文字列 | vics:VICS提供の道路交通情報 probe:プローブから生成された道路交通情報 |
ピリオド区切りで複数指定が可能 ※VICS / プローブのご利用は、オプション機能のため、別途契約が必要となります (Rakuten RapidAPIでは利用不可) ※vicsを指定した場合は、リクエストヘッダー「x-ntj-uid」、または、パラメータ「uid」を必ず設定してください |
||
uid | (✔) | VICS使用時のユーザー識別子 | 文字列 | 1文字以上50文字以内 | ※VICS / プローブのご利用は、オプション機能のため、別途契約が必要となります (Rakuten RapidAPIでは利用不可) ※パラメータ「use_traffic」で「vics」を指定した場合は、リクエストヘッダー「x-ntj-uid」、または、パラメータ「uid」を必ず設定してください |
|
datum | 緯度経度の測地系 | 文字列 | wgs84 | wgs84:世界測地系 tokyo:旧日本測地系 |
||
coord_unit | 出力データに含まれる緯度経度の単位 | 文字列 | degree | degree:度表記の10進法 millisec:ミリ秒表記 |
パラメータ構成例
- 溜池山王駅を中心に、ズーム値 10 ・画像サイズ 300x300 の地図を取得
/map_image?center=35.668583,139.744714&zoom=10&height=300&width=300
POST の BODY に含める情報
JSON 形式で図形情報を指定します。
指定出来るパラメータは以下の通りです。
名称 | 概要 |
---|---|
marker | アイコン描画 |
path | 線描画 |
circle | 円描画 |
marker の JSON 表現
プロパティ名 | 必須 | 概要 | 型名 | デフォルト値 | 備考 |
---|---|---|---|---|---|
icon | ✔ | 描画するアイコン画像(画像形式:png) | 文字列 | アイコン画像へのURL | |
size | ✔ | アイコン画像の表示サイズ(単位:px) | 文字列 | 「幅x高さ」の形式で指定してください 指定例:50x50 |
|
centers | ✔ | 描画の中心点 | 配列 (文字列) |
複数指定することにより同じアイコンを複数描画出来ます | |
position | 描画位置 | 文字列 | bottom | 以下のいずれかの指定が可能です bottom :下 bottom_left :左下 bottom_right :右下 left :左 center :中央 right :右 top :上 top_left :左上 top_right :右上 |
marker の指定例
{ "marker" : [ { "icon" : "https://example.co.jp/icon.png", "size" : "50x50", "position" : "center", "centers" : [[35.68956761,139.70070036],[34.34815651,139.51650034]] }, ... ] }
アイコン画像はpng形式のみ指定可能です。
path の JSON 表現
プロパティ名 | 必須 | 概要 | 型名 | デフォルト値 | 備考 |
---|---|---|---|---|---|
coords | ✔ | 形状点列 | 配列 (文字列) |
ポリゴンとする場合は初期点を最後に追加してください | |
width | 線の太さ(単位:px) | 数値 | 1 | ||
color | 線の色 | 文字列 | #000000 | RGB形式で指定してください | |
opacity | 線の透過度 | 数値 | 1 | 値が 0 に近づくほど透過されます 最小値:0 最大値:1 |
|
fillcolor | 塗りつぶしの色 | 文字列 | #000000 | RGB形式で指定してください | |
fillopacity | 塗りつぶしの透過度 | 数値 | 1 | 値が 0 に近づくほど透過されます 最小値:0 最大値:1 |
path の指定例
{ "path" : [ { "coords" : [[35.68956761,139.70070036],[34.34815651,139.51650034],[34.34615501,139.51634807],[34.34655418,139.51633260]], "width": 2, "color" : "#FFFFFF", "opacity" : 0.8, "fillcolor" : "#FF0000", "fillopacity" : 0.2 }, ... ] }
circle の JSON 表現
プロパティ名 | 必須 | 概要 | 型名 | デフォルト値 | 備考 |
---|---|---|---|---|---|
centers | ✔ | 中心点 | 配列 (文字列) |
複数指定することにより同じ円を複数描画出来ます | |
radius | ✔ | 円の半径(単位:m) | 数値 | ||
width | 線の太さ(単位:px) | 数値 | 1 | ||
color | 線の色 | 文字列 | #000000 | RGB形式で指定してください | |
opacity | 線の透過度 | 数値 | 1 | 値が 0 に近づくほど透過されます 最小値:0 最大値:1 |
|
fillcolor | 塗りつぶしの色 | 文字列 | #000000 | RGB形式で指定してください | |
fillopacity | 塗りつぶしの透過度 | 数値 | 1 | 値が 0 に近づくほど透過されます 最小値:0 最大値:1 |
circle の指定例
{ "circle" : [ { "centers" : [[35.68956761,139.70070036],[34.34815651,139.51650034]], "radius" : 50 , "width" : 2, "color" : "#FFFFFF", "opacity" : 1, "fillcolor" : "#FF0000", "fillopacity" : 0.2 }, ... ] }
POST の BODY 全体の例
{ "marker" : [ { "icon" : "https://example.co.jp/icon.png", "size" : "50x50", "position":"center", "centers" : [[35.68956761,139.70070036],[34.34815651,139.51650034]] } ], "path" : [ { "coords" : [[35.68956761,139.70070036],[34.34815651,139.51650034],[34.34615501,139.51634807],[34.34655418,139.51633260]], "width": 2, "color" : "#FFFFFF", "opacity" : 1.0, "fillcolor" : "#FF0000" } ], "circle" : [ { "centers" : [[35.68956761,139.70070036],[34.34815651,139.51650034]], "radius" : 50 , "width" : 2, "color" : "#FFFFFF", "opacity" : 0.6, "fillcolor" : "#FF0000", "fillopacity" : 0.7 }, { "centers" : [[35.84639105,138.03547303]], "radius" : 100 , "width" : 5, "color" : "#00A0FF", "opacity" : 1 } ] }
BODYの例を使用する際の注意点
上記のBODYの記述例を使用する際は、markerのiconにて指定しているURLを実際に存在する画像URLに変更してからご利用ください。
レスポンス
PNG 拡張子の画像ファイルが返却されます。