Class DirectionFinder

DirectionFinder

Permet de récupérer des itinéraires entre des lieux.
L'exemple ci-dessous montre comment utiliser cette classe pour obtenir l'itinéraire de Times Square à Central Park, en s'arrêtant d'abord au Lincoln Center, tracer les lieux et l'itinéraire sur une carte, et envoyer la carte par e-mail.

// Get the directions.
const 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();
const route = directions.routes[0];

// Set up marker styles.

let markerLetterCode = 'A'.charCodeAt();

// Add markers to the map.
const map = Maps.newStaticMap();
for (let i = 0; i < route.legs.length; i++) {
  const leg = route.legs[i];
  if (i === 0) {
    // Add a marker for the start location of the first leg only.
    map.setMarkerStyle(
        Maps.StaticMap.MarkerSize.MID,
        Maps.StaticMap.Color.GREEN,
        String.fromCharCode(markerLetterCode),
    );
    map.addMarker(leg.start_location.lat, leg.start_location.lng);
    markerLetterCode++;
  }
  map.setMarkerStyle(
      Maps.StaticMap.MarkerSize.MID,
      Maps.StaticMap.Color.GREEN,
      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.
const 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'),
      },
    },
);

Voir aussi

• API Google Directions

Méthodes

Méthode	Type renvoyé	Brève description
addWaypoint(latitude, longitude)	DirectionFinder	Ajoute un point de cheminement que l'itinéraire doit traverser, à l'aide d'un point (lat/lng).
addWaypoint(address)	DirectionFinder	Ajoute un point de cheminement que l'itinéraire doit traverser, à l'aide d'une adresse.
clearWaypoints()	DirectionFinder	Efface l'ensemble actuel de points de repère.
getDirections()	Object	Obtient les directions en utilisant l'origine, la destination et les autres options définies.
setAlternatives(useAlternatives)	DirectionFinder	Indique si des itinéraires alternatifs doivent être renvoyés, au lieu du seul itinéraire le mieux classé (la valeur par défaut est false).
setArrive(time)	DirectionFinder	Définit l'heure d'arrivée souhaitée (le cas échéant).
setAvoid(avoid)	DirectionFinder	Indique s'il faut éviter certains types de restrictions.
setDepart(time)	DirectionFinder	Définit l'heure de départ souhaitée (le cas échéant).
setDestination(latitude, longitude)	DirectionFinder	Définit le point de terminaison pour lequel calculer les directions, à l'aide d'un point (lat/lng).
setDestination(address)	DirectionFinder	Définit l'adresse de destination pour laquelle calculer l'itinéraire.
setLanguage(language)	DirectionFinder	Définit la langue à utiliser pour les instructions.
setMode(mode)	DirectionFinder	Définit le mode de transport (par défaut, la conduite).
setOptimizeWaypoints(optimizeOrder)	DirectionFinder	Indique s'il faut optimiser l'itinéraire fourni en réorganisant les points de cheminement dans un ordre plus efficace (la valeur par défaut est false).
setOrigin(latitude, longitude)	DirectionFinder	Définit le point de départ à partir duquel calculer l'itinéraire, à l'aide d'un point (lat/lng).
setOrigin(address)	DirectionFinder	Définit l'adresse du point de départ à partir duquel calculer l'itinéraire.
setRegion(region)	DirectionFinder	Définit une région à utiliser pour interpréter les noms de lieux.

Documentation détaillée

addWaypoint(latitude, longitude)

Ajoute un point de cheminement que l'itinéraire doit traverser, à l'aide d'un point (lat/lng).

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

Paramètres

Nom	Type	Description
latitude	Number	Latitude du point de repère.
longitude	Number	Longitude du point de cheminement.

Renvois

DirectionFinder : objet DirectionFinder pour faciliter l'association en chaîne des appels.

---

addWaypoint(address)

Ajoute un point de cheminement que l'itinéraire doit traverser, à l'aide d'une adresse.

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

Paramètres

Nom	Type	Description
address	String	Une adresse.

Renvois

DirectionFinder : objet DirectionFinder pour faciliter l'association en chaîne des appels.

---

clearWaypoints()

Efface l'ensemble actuel de points de repère.

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

Renvois

DirectionFinder : objet DirectionFinder pour faciliter l'association en chaîne des appels.

---

getDirections()

Obtient les directions en utilisant l'origine, la destination et les autres options définies.

// Logs how long it takes to walk from Times Square to Central Park.
const 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);

Renvois

Object : objet JSON contenant l'ensemble des itinéraires pour les directions, comme décrit ici.

Voir aussi

• API Google Directions

---

setAlternatives(useAlternatives)

Indique si des itinéraires bis doivent être renvoyés, au lieu du seul itinéraire le mieux classé (la valeur par défaut est false). Si la valeur est true, le tableau routes de l'objet obtenu peut contenir plusieurs entrées.

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

Paramètres

Nom	Type	Description
useAlternatives	Boolean	true pour renvoyer des itinéraires bis, false dans le cas contraire.

Renvois

DirectionFinder : objet DirectionFinder pour faciliter l'association en chaîne des appels.

---

setArrive(time)

Définit l'heure d'arrivée souhaitée (le cas échéant).

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

Paramètres

Nom	Type	Description
time	Date	Heure d'arrivée.

Renvois

DirectionFinder : objet DirectionFinder pour faciliter l'association en chaîne des appels.

Voir aussi

• API Google Directions

---

setAvoid(avoid)

Indique s'il faut éviter certains types de restrictions.

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

Paramètres

Nom	Type	Description
avoid	String	Valeur constante de Avoid.

Renvois

DirectionFinder : objet DirectionFinder pour faciliter l'association en chaîne des appels.

Voir aussi

• API Google Directions

---

setDepart(time)

Définit l'heure de départ souhaitée (le cas échéant).

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

Paramètres

Nom	Type	Description
time	Date	Heure de départ.

Renvois

DirectionFinder : objet DirectionFinder pour faciliter l'association en chaîne des appels.

Voir aussi

• API Google Directions

---

setDestination(latitude, longitude)

Définit le point de terminaison pour lequel calculer les directions, à l'aide d'un point (lat/lng).

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

Paramètres

Nom	Type	Description
latitude	Number	Latitude du lieu de destination.
longitude	Number	Longitude du lieu de destination.

Renvois

DirectionFinder : objet DirectionFinder pour faciliter l'association en chaîne des appels.

---

setDestination(address)

Définit l'adresse de destination pour laquelle calculer l'itinéraire.

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

Paramètres

Nom	Type	Description
address	String	Adresse de destination.

Renvois

DirectionFinder : objet DirectionFinder pour faciliter l'association en chaîne des appels.

---

setLanguage(language)

Définit la langue à utiliser pour les instructions.

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

Paramètres

Nom	Type	Description
language	String	Identifiant de langue BCP-47.

Renvois

DirectionFinder : objet DirectionFinder pour faciliter l'association en chaîne des appels.

Voir aussi

• Langues disponibles dans les API Google Maps

---

setMode(mode)

Définit le mode de transport (par défaut, la conduite).

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

Paramètres

Nom	Type	Description
mode	String	Valeur constante de Mode.

Renvois

DirectionFinder : objet DirectionFinder pour faciliter l'association en chaîne des appels.

Voir aussi

• API Google Directions

---

setOptimizeWaypoints(optimizeOrder)

Indique s'il faut optimiser l'itinéraire fourni en réorganisant les points de cheminement dans un ordre plus efficace (la valeur par défaut est false).

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

Paramètres

Nom	Type	Description
optimizeOrder	Boolean	true pour optimiser l'ordre ou false dans le cas contraire.

Renvois

DirectionFinder : objet DirectionFinder pour faciliter l'association en chaîne des appels.

Voir aussi

• API Google Directions

---

setOrigin(latitude, longitude)

Définit le point de départ à partir duquel calculer l'itinéraire, à l'aide d'un point (lat/lng).

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

Paramètres

Nom	Type	Description
latitude	Number	Latitude du point de départ.
longitude	Number	Longitude du point de départ.

Renvois

DirectionFinder : objet DirectionFinder pour faciliter l'association en chaîne des appels.

---

setOrigin(address)

Définit l'adresse du point de départ à partir duquel calculer l'itinéraire.

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

Paramètres

Nom	Type	Description
address	String	Adresse de départ.

Renvois

DirectionFinder : instance DirectionFinder pour faciliter l'enchaînement des appels.

---

setRegion(region)

Définit une région à utiliser lors de l'interprétation des noms de lieux. Les codes de région acceptés correspondent aux ccTLD acceptés par Google Maps. Par exemple, le code régional "fr" correspond à "maps.google.fr".

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

Paramètres

Nom	Type	Description
region	String	Code de région à utiliser.

Renvois

DirectionFinder : objet DirectionFinder pour faciliter l'association en chaîne des appels.

Voir aussi

• API Google Directions