Class DirectionFinder

DirectionFinder

地点間のルートを取得できます。
以下の例は、このクラスを使用してタイムズ スクエアから まずリンカーン センターに停車するセントラル パークが、場所と道を地図上にプロットして、 メールで送信されます。

// Get the directions.
var directions = Maps.newDirectionFinder()
    .setOrigin('Times Square, New York, NY')
    .addWaypoint('Lincoln Center, New York, NY')
    .setDestination('Central Park, New York, NY')
    .setMode(Maps.DirectionFinder.Mode.DRIVING)
    .getDirections();
var route = directions.routes[0];

// Set up marker styles.
var markerSize = Maps.StaticMap.MarkerSize.MID;
var markerColor = Maps.StaticMap.Color.GREEN
var markerLetterCode = 'A'.charCodeAt();

// Add markers to the map.
var map = Maps.newStaticMap();
for (var i = 0; i < route.legs.length; i++) {
  var leg = route.legs[i];
  if (i == 0) {
    // Add a marker for the start location of the first leg only.
    map.setMarkerStyle(markerSize, markerColor, String.fromCharCode(markerLetterCode));
    map.addMarker(leg.start_location.lat, leg.start_location.lng);
    markerLetterCode++;
  }
  map.setMarkerStyle(markerSize, markerColor, String.fromCharCode(markerLetterCode));
  map.addMarker(leg.end_location.lat, leg.end_location.lng);
  markerLetterCode++;
}

// Add a path for the entire route.
map.addPath(route.overview_polyline.points);

// Send the map in an email.
var toAddress = Session.getActiveUser().getEmail();
MailApp.sendEmail(
  toAddress,
  'Directions',
  'Please open: ' + map.getMapUrl() + '&key=YOUR_API_KEY', {
    htmlBody: 'See below.<br/><img src="cid:mapImage">',
    inlineImages: {
      mapImage: Utilities.newBlob(map.getMapImage(), 'image/png')
    }
  }
);

関連情報

• Google Directions API

メソッド

メソッド	戻り値の型	概要
addWaypoint(latitude, longitude)	DirectionFinder	地点（緯度/経度）を使用して、ルートが通過する地点を追加します。
addWaypoint(address)	DirectionFinder	住所を使用して、ルートが通過する地点を追加します。
clearWaypoints()	DirectionFinder	現在のウェイポイント セットをクリアします。
getDirections()	Object	出発地、目的地、その他のオプションを使用してルートを取得します。
setAlternatives(useAlternatives)	DirectionFinder	最もランクの高いルートだけでなく、代替ルートを返すかどうかを設定します。 route（デフォルトは false）にします。
setArrive(time)	DirectionFinder	希望する到着時刻を設定します（該当する場合）。
setAvoid(avoid)	DirectionFinder	特定の種類の制限を回避するかどうかを設定します。
setDepart(time)	DirectionFinder	希望する出発時刻を設定します（該当する場合）。
setDestination(latitude, longitude)	DirectionFinder	ルートを計算する目的地を地点（緯度/経度）で設定します。
setDestination(address)	DirectionFinder	住所を使用してルートを計算する目的地を設定します。
setLanguage(language)	DirectionFinder	ルートに使用する言語を設定します。
setMode(mode)	DirectionFinder	移動手段を設定します（デフォルトは車です）。
setOptimizeWaypoints(optimizeOrder)	DirectionFinder	ウェイポイントを並べ替えて指定したルートを最適化するかどうかを設定します。 効率的な順序です（デフォルトは false）。
setOrigin(latitude, longitude)	DirectionFinder	ルートを計算する始点の位置を点（緯度/経度）で設定します。
setOrigin(address)	DirectionFinder	住所を使用してルートを計算する出発地を設定します。
setRegion(region)	DirectionFinder	ロケーション名を解釈するときに使用する地域を設定します。

詳細なドキュメント

addWaypoint(latitude, longitude)

地点（緯度/経度）を使用して、ルートが通過する地点を追加します。

// Creates a DirectionFinder with a wapoint at Lincoln Center.
var directionFinder = Maps.newDirectionFinder().addWaypoint(40.772628, -73.984243);

パラメータ

名前	型	説明
latitude	Number	地点の緯度。
longitude	Number	地点の経度。

戻る

DirectionFinder - 呼び出しのチェーンを容易にする DirectionFinder オブジェクト。

---

addWaypoint(address)

住所を使用して、ルートが通過する地点を追加します。

// Creates a DirectionFinder with a wapoint at Lincoln Center.
var directionFinder = Maps.newDirectionFinder().addWaypoint('Lincoln Center, New York, NY');

パラメータ

名前	型	説明
address	String	住所。

戻る

DirectionFinder - 呼び出しのチェーンを容易にする DirectionFinder オブジェクト。

---

clearWaypoints()

現在のウェイポイント セットをクリアします。

var directionFinder = Maps.newDirectionFinder()
// ...
// Do something interesting here ...
// ...
// Remove all waypoints added with addWaypoint().
directionFinder.clearWaypoints();

戻る

DirectionFinder - 呼び出しのチェーンを容易にする DirectionFinder オブジェクト

---

getDirections()

出発地、目的地、その他のオプションを使用してルートを取得します。

// Logs how long it would take to walk from Times Square to Central Park.
var directions = Maps.newDirectionFinder()
    .setOrigin('Times Square, New York, NY')
    .setDestination('Central Park, New York, NY')
    .setMode(Maps.DirectionFinder.Mode.WALKING)
    .getDirections();
Logger.log(directions.routes[0].legs[0].duration.text);

戻る

Object - ルートのセットを含む JSON オブジェクト（こちらを参照）

関連情報

• Google Directions API

---

setAlternatives(useAlternatives)

最もランクの高いルートだけでなく、代替ルートを返すかどうかを設定します。 route（デフォルトは false）にします。true の場合、結果のオブジェクトの routes 配列が 複数のエントリが含まれます。

// Creates a DirectionFinder with alernative routes enabled.
var directionFinder = Maps.newDirectionFinder().setAlternatives(true);

パラメータ

名前	型	説明
useAlternatives	Boolean	代替ルートを返す場合は true、それ以外の場合は false

戻る

DirectionFinder - 呼び出しのチェーンを容易にする DirectionFinder オブジェクト

---

setArrive(time)

希望する到着時刻を設定します（該当する場合）。

// Creates a DirectionFinder with an arrival time of 2 hours from now.
var now = new Date();
var arrive = new Date(now.getTime() + (2 * 60 * 60 * 1000));
var directionFinder = Maps.newDirectionFinder().setArrive(arrive);

パラメータ

名前	型	説明
time	Date	到着時刻

戻る

DirectionFinder - 呼び出しのチェーンを容易にする DirectionFinder オブジェクト

関連情報

• Google Directions API

---

setAvoid(avoid)

特定の種類の制限を回避するかどうかを設定します。

// Creates a DirectionFinder that avoid highways.
var directionFinder = Maps.newDirectionFinder().setAvoid(Maps.DirectionFinder.Avoid.HIGHWAYS);

パラメータ

名前	型	説明
avoid	String	Avoid の定数値

戻る

DirectionFinder - 呼び出しのチェーンを容易にする DirectionFinder オブジェクト

関連情報

• Google Directions API

---

setDepart(time)

希望する出発時刻を設定します（該当する場合）。

// Creates a DirectionFinder with a departure time of 1 hour from now.
var now = new Date();
var depart = new Date(now.getTime() + (1 * 60 * 60 * 1000));
var directionFinder = Maps.newDirectionFinder().setDepart(depart);

パラメータ

名前	型	説明
time	Date	出発時刻

戻る

DirectionFinder - 呼び出しのチェーンを容易にする DirectionFinder オブジェクト。

関連情報

• Google Directions API

---

setDestination(latitude, longitude)

ルートを計算する目的地を地点（緯度/経度）で設定します。

// Creates a DirectionFinder with the destination set to Central Park.
var directionFinder = Maps.newDirectionFinder().setDestination(40.777052, -73.975464);

パラメータ

名前	型	説明
latitude	Number	目的地の緯度
longitude	Number	到着地の経度

戻る

DirectionFinder - 呼び出しのチェーンを容易にする DirectionFinder オブジェクト

---

setDestination(address)

住所を使用してルートを計算する目的地を設定します。

// Creates a DirectionFinder with the destination set to Central Park.
var directionFinder = Maps.newDirectionFinder().setDestination('Central Park, New York, NY');

パラメータ

名前	型	説明
address	String	終了アドレス

戻る

DirectionFinder - 呼び出しのチェーンを容易にする DirectionFinder オブジェクト

---

setLanguage(language)

ルートに使用する言語を設定します。

// Creates a DirectionFinder with the language set to French.
var directionFinder = Maps.newDirectionFinder().setLanguage('fr');

パラメータ

名前	型	説明
language	String	BCP-47 言語識別子

戻る

DirectionFinder - 呼び出しのチェーンを容易にする DirectionFinder オブジェクト

関連情報

• Google Maps API での言語サポート

---

setMode(mode)

移動手段を設定します（デフォルトは車です）。

// Creates a DirectionFinder with the mode set to walking.
var directionFinder = Maps.newDirectionFinder().setMode(Maps.DirectionFinder.Mode.WALKING);

パラメータ

名前	型	説明
mode	String	Mode の定数値

戻る

DirectionFinder - 呼び出しのチェーンを容易にする DirectionFinder オブジェクト

関連情報

• Google Directions API

---

setOptimizeWaypoints(optimizeOrder)

ウェイポイントを並べ替えて指定したルートを最適化するかどうかを設定します。 効率的な順序です（デフォルトは false）。

// Creates a DirectionFinder with wapoint optimization enabled.
var directionFinder = Maps.newDirectionFinder().setOptimizeWaypoints(true);

パラメータ

名前	型	説明
optimizeOrder	Boolean	順序を最適化する場合は true、それ以外の場合は false

戻る

DirectionFinder - 呼び出しのチェーンを容易にする DirectionFinder オブジェクト

関連情報

• Google Directions API

---

setOrigin(latitude, longitude)

ルートを計算する始点の位置を点（緯度/経度）で設定します。

// Creates a DirectionFinder with the origin set to Times Square.
var directionFinder = Maps.newDirectionFinder().setOrigin(40.759011, -73.984472);

パラメータ

名前	型	説明
latitude	Number	出発地の緯度
longitude	Number	出発地の経度

戻る

DirectionFinder - 呼び出しのチェーンを容易にする DirectionFinder オブジェクト

---

setOrigin(address)

住所を使用してルートを計算する出発地を設定します。

// Creates a DirectionFinder with the origin set to Times Square.
var directionFinder = Maps.newDirectionFinder().setOrigin('Times Square, New York, NY');

パラメータ

名前	型	説明
address	String	開始アドレス

戻る

DirectionFinder - 呼び出しのチェーンを容易にする DirectionFinder インスタンス

---

setRegion(region)

ロケーション名を解釈するときに使用するリージョンを設定します。サポートされている地域コードは Google マップでサポートされている国別コード トップレベル ドメインです。たとえば、地域コード「uk」は、対応する 「maps.google.co.uk」

// Creates a DirectionFinder with the region set to France.
var directionFinder = Maps.newDirectionFinder().setRegion('fr');

パラメータ

名前	型	説明
region	String	使用するリージョン コード

戻る

DirectionFinder - 呼び出しのチェーンを容易にする DirectionFinder オブジェクト

関連情報

• Google Directions API