Cette page a été traduite par l'API Cloud Translation.

Class DirectionFinder

Permet de récupérer des itinéraires entre des lieux.
L'exemple ci-dessous montre comment utiliser cette classe pour obtenir les itinéraires de Times Square à Central Park, en s'arrêtant d'abord à Lincoln Center, tracer les emplacements et le parcours sur une carte, puis 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 passer, à l'aide d'un point (lat/lng).
`addWaypoint(address)`	`DirectionFinder`	Ajoute un point de cheminement que le parcours doit emprunter, à l'aide d'une adresse.
`clearWaypoints()`	`DirectionFinder`	Efface l'ensemble actuel de points de repère.
`getDirections()`	`Object`	Récupère l'itinéraire en utilisant le point de départ, la destination et les autres options définies.
`setAlternatives(useAlternatives)`	`DirectionFinder`	Indique si d'autres itinéraires doivent être renvoyés au lieu du seul itinéraire le mieux classé (par défaut, la valeur est "false").
`setArrive(time)`	`DirectionFinder`	Définit l'heure d'arrivée souhaitée (le cas échéant).
`setAvoid(avoid)`	`DirectionFinder`	Indique si certains types de restrictions doivent être évités.
`setDepart(time)`	`DirectionFinder`	Définit l'heure de départ souhaitée (le cas échéant).
`setDestination(latitude, longitude)`	`DirectionFinder`	Définit le point d'arrivée pour lequel calculer un itinéraire, à l'aide d'un point (lat/lng).
`setDestination(address)`	`DirectionFinder`	Définit l'emplacement de destination pour lequel calculer un itinéraire à l'aide d'une adresse.
`setLanguage(language)`	`DirectionFinder`	Définit la langue à utiliser pour les itinéraires.
`setMode(mode)`	`DirectionFinder`	Définit le mode de transport (par défaut, en voiture).
`setOptimizeWaypoints(optimizeOrder)`	`DirectionFinder`	Indique si l'itinéraire fourni doit être optimisé en réorganisant les points de cheminement dans un ordre plus efficace (par défaut, la valeur 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 le point de départ à partir duquel calculer un itinéraire, à l'aide d'une adresse.
`setRegion(region)`	`DirectionFinder`	Définit une région à utiliser lors de l'interprétation des noms de lieux.

Documentation détaillée

`addWaypoint(latitude, longitude)`

Ajoute un point de cheminement par lequel l'itinéraire doit passer, à 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 cheminement.
`longitude`	`Number`	Longitude du point de cheminement.

Renvois

DirectionFinder : objet DirectionFinder pour faciliter le chaînage des appels.

`addWaypoint(address)`

Ajoute un point de passage que le parcours doit emprunter, à 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 le chaînage des appels.

`clearWaypoints()`

Efface l'ensemble actuel de points de cheminement.

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

Renvois

DirectionFinder : objet DirectionFinder pour faciliter le chaînage des appels

`getDirections()`

Récupère l'itinéraire en utilisant le point de départ, la destination et les autres options définies.

// Logs how long it would take 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 itinéraires, comme décrit ici

Voir aussi

API Google Directions

`setAlternatives(useAlternatives)`

Indique si d'autres itinéraires doivent être renvoyés au lieu du seul itinéraire le mieux classé (par défaut, la valeur est "false"). Si la valeur est "true", le tableau routes de l'objet résultant 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 alternatifs, ou "false" dans le cas contraire

Renvois

DirectionFinder : objet DirectionFinder pour faciliter le chaînage 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`	l'heure d'arrivée ;

Renvois

DirectionFinder : objet DirectionFinder pour faciliter le chaînage des appels

Voir aussi

API Google Directions

`setAvoid(avoid)`

Indique si certains types de restrictions doivent être évités.

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

Paramètres

Nom	Type	Description
`avoid`	`String`	une valeur constante de `Avoid`

Renvois

DirectionFinder : objet DirectionFinder pour faciliter le chaînage 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`	l'heure de départ ;

Renvois

DirectionFinder : objet DirectionFinder pour faciliter le chaînage des appels.

Voir aussi

API Google Directions

`setDestination(latitude, longitude)`

Définit le point d'arrivée pour lequel calculer un itinéraire à 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 point d'arrivée
`longitude`	`Number`	Longitude du lieu d'arrivée

Renvois

DirectionFinder : objet DirectionFinder pour faciliter le chaînage des appels

`setDestination(address)`

Définit le point d'arrivée pour lequel calculer un itinéraire à l'aide d'une adresse.

// 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`	l'adresse de fin ;

Renvois

DirectionFinder : objet DirectionFinder pour faciliter le chaînage des appels

`setLanguage(language)`

Définit la langue à utiliser pour les itinéraires.

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

Paramètres

Nom	Type	Description
`language`	`String`	un identifiant de langue BCP-47

Renvois

DirectionFinder : objet DirectionFinder pour faciliter le chaînage des appels

Voir aussi

Compatibilité des API Google Maps avec les langues

`setMode(mode)`

Définit le mode de transport (par défaut, en voiture).

// 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`	une valeur constante de `Mode`

Renvois

DirectionFinder : objet DirectionFinder pour faciliter le chaînage des appels

Voir aussi

API Google Directions

`setOptimizeWaypoints(optimizeOrder)`

Indique si l'itinéraire fourni doit être optimisé en réorganisant les points de cheminement dans un ordre plus efficace (par défaut, la valeur 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 la commande, ou "false" dans le cas contraire

Renvois

DirectionFinder : objet DirectionFinder pour faciliter le chaînage 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`	la latitude du point de départ ;
`longitude`	`Number`	la longitude du point de départ ;

Renvois

DirectionFinder : objet DirectionFinder pour faciliter le chaînage des appels

`setOrigin(address)`

Définit le point de départ à partir duquel calculer un itinéraire, à l'aide d'une adresse.

// 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`	l'adresse de départ

Renvois

DirectionFinder : instance DirectionFinder pour faciliter le chaînage 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 de région "uk" correspond à "maps.google.co.uk".

// 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 le chaînage des appels

Voir aussi

API Google Directions