タイル地図スクリプト取得(v1)
/v1/map_script [GET]
基本情報
概要
ブラウザ上で動作するタイル地図を制御するJavaScriptファイルを取得します。
URL
https://{HOST}/{CID}/v1/map_script
※APIマーケットの場合はURL体系が異なります
※RapidAPIをご利用の方は
実装のヒント
をご確認ください。
出力形式
- JavaScript
対応言語
- ja, en, ko, zh-CN, zh-TW, th
本 API を使用する際は、お客様のWebサイト内に 利用規約の表示について にある規約文言を記載してください。
地図の表示数について
地図の表示は1画面につき1枚までとなります。
複数枚の表示につきましてはサポート対象外となります。
User-Agentについて
User-Agent(リクエストヘッダー)からブラウザを判別し、最適なスクリプト返却します。
JavaやPythonなどのプログラムからリクエストする際は、アプリケーション側の地図表示で利用するブラウザのUser-Agentを明示的に付与してください。
API コール数のカウントについて
/map_script の実行 1 回につき 1 コールとカウントされます。
地図のスクロール操作やスクリプト内部の関数呼び出しなどはカウントされません。
地図操作について
地図操作のチュートリアルにつきましては Map Tutorial も併せてご覧ください。
パラメータ
パラメータ名 | 必須 | 概要 | 型名 | デフォルト値 | 上下限/選択値 | 備考 |
---|---|---|---|---|---|---|
host | ✔ | サイトのドメイン | 文字列 | ローカル環境から取得する場合は、「localhost」と指定してください サイト上で取得する場合は、ドメイン名を指定してください(パラメータ構成例を参考にしてください) |
||
use_traffic | 渋滞情報元 | 文字列 | vics:VICS提供の道路交通情報 probe:プローブから生成された道路交通情報 |
ピリオド区切りで複数指定が可能 ※VICS / プローブのご利用は、オプション機能のため、別途契約が必要となります (APIマーケットでは利用不可) ※vicsを指定した場合は、リクエストヘッダー「x-ntj-uid」、または、パラメータ「uid」を必ず設定してください |
||
uid | (✔) | VICS使用時のユーザー識別子 | 文字列 | 1文字以上50文字以内 | ※VICS / プローブのご利用は、オプション機能のため、別途契約が必要となります (APIマーケットでは利用不可) ※パラメータ「use_traffic」で「vics」を指定した場合は、リクエストヘッダー「x-ntj-uid」、または、パラメータ「uid」を必ず設定してください |
|
lang | 言語 | 文字列 | ja: 日本語 en: 英語 ko: 韓国語 zh-CN: 中国語(簡体字) zh-TW: 中国語(繁体字) th: タイ語 |
出力する言語を指定します ※多言語オプション申込時のみ利用可能 (APIマーケットでは利用不可) |
パラメータ構成例
- https://example.com/foo/baa.html のサイト上でタイル地図スクリプトを取得
/map_script?host=example.com
測地系について
タイル地図スクリプトは 世界測地系でのみご利用頂けます。
サポートブラウザと差分について
サポートブラウザと差分については以下のとおりです。
基本的には、ブラウザ提供企業がサポートしているバージョンのみサポート対象となっております。
PC
ブラウザ | サポートブラウザの バージョン |
Polyline, Polygone 等の描画方法 |
キーボード 入力対応 |
マルチタッチ 操作対応 |
ズームバー 表示 |
メニュー表示 |
---|---|---|---|---|---|---|
Google Chrome |
最新バージョンのみ | SVG | ○ | - | ○ | ○ |
Firefox | 54.0以上 | SVG | ○ | - | ○ | ○ |
Opera | 最新バージョンのみ | SVG | ○ | - | ○ | ○ |
Internet Explorer |
11 | SVG | ○ | - | ○ | ○ |
Microsoft Edge |
最新バージョンのみ | SVG | ○ | - | ○ | ○ |
safari(Mac) | 最新バージョンのみ | SVG | ○ | - | ○ | ○ |
モバイル
ブラウザ | サポートブラウザの バージョン |
Polyline, Polygone 等の描画方法 |
キーボード 入力対応 |
マルチタッチ 操作対応 |
ズームバー 表示 |
メニュー表示 |
---|---|---|---|---|---|---|
safari | 最新バージョンのみ | SVG | × | ○ | × | × |
Android標準ブラウザ | OS4.4以上 | SVG | × | ○ | × | × |
Google Chrome( for Android ) | 最新バージョンのみ | SVG | × | ○ | × | × |
ブラウザの動作保証について
API では UserAgent を取得してブラウザごとに配信するスクリプトファイルを適宜切り替えています。
Internet Explorer10以前のバージョンは動作保証対象外になります。
互換表示モード(エミュレート)でのご使用も保証対象外になります。