Cómo navegar por una ruta de un solo destino

Sigue esta guía para trazar una ruta dentro de tu app usando el SDK de Navigation para Android. En esta guía, se supone que ya integraste Navigation SDK en tu app, como se describe en Configura tu proyecto.

Resumen

1. Agrega un elemento de IU a tu app, ya sea como fragmento de navegación o como una vista de navegación. Este elemento de la IU agrega el mapa interactivo y la navegación paso a paso de navegación del navegador a tu actividad.
2. Solicita permisos de ubicación. Tu app debe solicitar el permiso de ubicación para determinar la ubicación del dispositivo.
3. Inicializa el SDK con la clase NavigationApi.

4. Establece un destino y controla la navegación paso a paso con la clase Navigator. Esto implica tres pasos:

   • Establece el destino con setDestination().
   • Inicia la navegación con startGuidance().
   • Usa getSimulator(). para simular el progreso del vehículo a lo largo de la ruta para probar, depurar y demostrar tu app.

5. Compila y ejecuta tu app.

Consulta el código

package com.example.navsdksingledestination;

import android.content.pm.PackageManager;
import android.os.Bundle;
import android.util.Log;
import android.widget.Toast;
import androidx.annotation.NonNull;
import androidx.appcompat.app.AppCompatActivity;
import androidx.core.app.ActivityCompat;
import androidx.core.content.ContextCompat;
import com.google.android.gms.maps.GoogleMap.CameraPerspective;
import com.google.android.libraries.navigation.ListenableResultFuture;
import com.google.android.libraries.navigation.NavigationApi;
import com.google.android.libraries.navigation.Navigator;
import com.google.android.libraries.navigation.RoutingOptions;
import com.google.android.libraries.navigation.SimulationOptions;
import com.google.android.libraries.navigation.SupportNavigationFragment;
import com.google.android.libraries.navigation.Waypoint;

/**
 * An activity that displays a map and a navigation UI, guiding the user from their current location
 * to a single, given destination.
 */
public class NavigationActivitySingleDestination extends AppCompatActivity {

  private static final String TAG = NavigationActivitySingleDestination.class.getSimpleName();
  private Navigator mNavigator;
  private SupportNavigationFragment mNavFragment;
  private RoutingOptions mRoutingOptions;

  // Define the Sydney Opera House by specifying its place ID.
  private static final String SYDNEY_OPERA_HOUSE = "ChIJ3S-JXmauEmsRUcIaWtf4MzE";

  // Set fields for requesting location permission.
  private static final int PERMISSIONS_REQUEST_ACCESS_FINE_LOCATION = 1;
  private boolean mLocationPermissionGranted;

  @Override
  protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    setContentView(R.layout.activity_main);

    // Initialize the Navigation SDK.
    initializeNavigationSdk();
  }

  /**
   * Starts the Navigation SDK and sets the camera to follow the device's location. Calls the
   * navigateToPlace() method when the navigator is ready.
   */
  private void initializeNavigationSdk() {
    /*
     * Request location permission, so that we can get the location of the
     * device. The result of the permission request is handled by a callback,
     * onRequestPermissionsResult.
     */
    if (ContextCompat.checkSelfPermission(
            this.getApplicationContext(), android.Manifest.permission.ACCESS_FINE_LOCATION)
        == PackageManager.PERMISSION_GRANTED) {
      mLocationPermissionGranted = true;
    } else {
      ActivityCompat.requestPermissions(
          this,
          new String[] {android.Manifest.permission.ACCESS_FINE_LOCATION},
          PERMISSIONS_REQUEST_ACCESS_FINE_LOCATION);
    }

    if (!mLocationPermissionGranted) {
      displayMessage(
          "Error loading Navigation SDK: " + "The user has not granted location permission.");
      return;
    }

    // Get a navigator.
    NavigationApi.getNavigator(
        this,
        new NavigationApi.NavigatorListener() {
          /** Sets up the navigation UI when the navigator is ready for use. */
          @Override
          public void onNavigatorReady(Navigator navigator) {
            displayMessage("Navigator ready.");
            mNavigator = navigator;
            mNavFragment =
                (SupportNavigationFragment)
                    getSupportFragmentManager().findFragmentById(R.id.navigation_fragment);

            // Set the last digit of the car's license plate to get route restrictions
            // in supported countries. (optional)
            // mNavigator.setLicensePlateRestrictionInfo(getLastDigit(), "BZ");

            // Set the camera to follow the device location with 'TILTED' driving view.
            mNavFragment.getMapAsync(
                googleMap -> googleMap.followMyLocation(CameraPerspective.TILTED));

            // Set the travel mode (DRIVING, WALKING, CYCLING, or TWO_WHEELER).
            mRoutingOptions = new RoutingOptions();
            mRoutingOptions.travelMode(RoutingOptions.TravelMode.DRIVING);

            // Navigate to a place, specified by Place ID.
            navigateToPlace(SYDNEY_OPERA_HOUSE, mRoutingOptions);
          }

          /**
           * Handles errors from the Navigation SDK.
           *
           * @param errorCode The error code returned by the navigator.
           */
          @Override
          public void onError(@NavigationApi.ErrorCode int errorCode) {
            switch (errorCode) {
              case NavigationApi.ErrorCode.NOT_AUTHORIZED:
                displayMessage(
                    "Error loading Navigation SDK: Your API key is "
                        + "invalid or not authorized to use the Navigation SDK.");
                break;
              case NavigationApi.ErrorCode.TERMS_NOT_ACCEPTED:
                displayMessage(
                    "Error loading Navigation SDK: User did not accept "
                        + "the Navigation Terms of Use.");
                break;
              case NavigationApi.ErrorCode.NETWORK_ERROR:
                displayMessage("Error loading Navigation SDK: Network error.");
                break;
              case NavigationApi.ErrorCode.LOCATION_PERMISSION_MISSING:
                displayMessage(
                    "Error loading Navigation SDK: Location permission " + "is missing.");
                break;
              default:
                displayMessage("Error loading Navigation SDK: " + errorCode);
            }
          }
        });
  }

  /**
   * Requests directions from the user's current location to a specific place (provided by the
   * Google Places API).
   */
  private void navigateToPlace(String placeId, RoutingOptions travelMode) {
    Waypoint destination;
    try {
      destination = Waypoint.builder().setPlaceIdString(placeId).build();
    } catch (Waypoint.UnsupportedPlaceIdException e) {
      displayMessage("Error starting navigation: Place ID is not supported.");
      return;
    }

    // Create a future to await the result of the asynchronous navigator task.
    ListenableResultFuture<Navigator.RouteStatus> pendingRoute =
        mNavigator.setDestination(destination, travelMode);

    // Define the action to perform when the SDK has determined the route.
    pendingRoute.setOnResultListener(
        new ListenableResultFuture.OnResultListener<Navigator.RouteStatus>() {
          @Override
          public void onResult(Navigator.RouteStatus code) {
            switch (code) {
              case OK:
                // Hide the toolbar to maximize the navigation UI.
                if (getActionBar() != null) {
                  getActionBar().hide();
                }

                // Enable voice audio guidance (through the device speaker).
                mNavigator.setAudioGuidance(Navigator.AudioGuidance.VOICE_ALERTS_AND_GUIDANCE);

                // Simulate vehicle progress along the route for demo/debug builds.
                if (BuildConfig.DEBUG) {
                  mNavigator
                      .getSimulator()
                      .simulateLocationsAlongExistingRoute(
                          new SimulationOptions().speedMultiplier(5));
                }

                // Start turn-by-turn guidance along the current route.
                mNavigator.startGuidance();
                break;
              // Handle error conditions returned by the navigator.
              case NO_ROUTE_FOUND:
                displayMessage("Error starting navigation: No route found.");
                break;
              case NETWORK_ERROR:
                displayMessage("Error starting navigation: Network error.");
                break;
              case ROUTE_CANCELED:
                displayMessage("Error starting navigation: Route canceled.");
                break;
              default:
                displayMessage("Error starting navigation: " + String.valueOf(code));
            }
          }
        });
  }

  /** Handles the result of the request for location permissions. */
  @Override
  public void onRequestPermissionsResult(
      int requestCode, @NonNull String[] permissions, @NonNull int[] grantResults) {
    mLocationPermissionGranted = false;
    switch (requestCode) {
      case PERMISSIONS_REQUEST_ACCESS_FINE_LOCATION:
        {
          // If request is canceled, the result arrays are empty.
          if (grantResults.length > 0 && grantResults[0] == PackageManager.PERMISSION_GRANTED) {
            mLocationPermissionGranted = true;
          }
        }
    }
  }

  /**
   * Shows a message on screen and in the log. Used when something goes wrong.
   *
   * @param errorMessage The message to display.
   */
  private void displayMessage(String errorMessage) {
    Toast.makeText(this, errorMessage, Toast.LENGTH_LONG).show();
    Log.d(TAG, errorMessage);
  }
}

Agrega un elemento de la IU a tu app

En esta sección, se describen dos formas en las que puedes agregar el mapa interactivo y la IU para mostrar la navegación paso a paso. En la mayoría de los casos, recomendamos usar SupportNavigationFragment, que es un wrapper NavigationView, en lugar de interactuar directamente con NavigationView. Para obtener más información, consulta Prácticas recomendadas para la interacción con el mapa de navegación.

Cómo usar un fragmento de Navigation

SupportNavigationFragment es el componente de la IU que muestra el resultado visual de la navegación, incluido un mapa interactivo y las instrucciones paso a paso. Puedes declarar el fragmento en tu archivo de diseño XML como se muestra a continuación:

<?xml version="1.0" encoding="utf-8"?>
<fragment xmlns:android="http://schemas.android.com/apk/res/android"
    android:name="com.google.android.libraries.navigation.SupportNavigationFragment"
    android:id="@+id/navigation_fragment"
    android:layout_width="match_parent"
    android:layout_height="match_parent"/>

Como alternativa, puedes construir el fragmento de manera programática, como se describe en la documentación de Android, con FragmentActivity.getSupportFragmentManager().

Cómo usar una vista de navegación

Como alternativa a un fragmento, el componente de la IU para mostrar un mapa de navegación también está disponible como NavigationView.

Solicita un permiso de ubicación

En esta sección, se muestra cómo solicitar el permiso de ubicación precisa. Para obtener más detalles, consulta la guía sobre Permisos de Android.

1. Agrega el permiso como componente secundario del elemento <manifest> en tu Android manifest:

   <manifest xmlns:android="http://schemas.android.com/apk/res/android"
       package="com.example.navsdksingledestination">
       <uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
   </manifest>
   

2. Solicitar permisos de tiempo de ejecución en tu app para darle al usuario la oportunidad para otorgar o rechazar el permiso de ubicación. El siguiente código verifica si el usuario otorgó el permiso de ubicación precisa. Si no lo hizo, se solicita autorización:

   if (ContextCompat.checkSelfPermission(this.getApplicationContext(),
           android.Manifest.permission.ACCESS_FINE_LOCATION)
               == PackageManager.PERMISSION_GRANTED) {
       mLocationPermissionGranted = true;
   } else {
       ActivityCompat.requestPermissions(this,
               new String[] { android.Manifest.permission.ACCESS_FINE_LOCATION },
               PERMISSIONS_REQUEST_ACCESS_FINE_LOCATION);
   }
   
   if (!mLocationPermissionGranted) {
       displayMessage("Error loading Navigation SDK: "
               + "The user has not granted location permission.");
       return;
   }
   

3. Anula la devolución de llamada onRequestPermissionsResult() para controlar el resultado de la solicitud de permiso:

   @Override
   public void onRequestPermissionsResult(int requestCode, @NonNull String permissions[],
                                          @NonNull int[] grantResults) {
       mLocationPermissionGranted = false;
       switch (requestCode) {
           case PERMISSIONS_REQUEST_ACCESS_FINE_LOCATION: {
               // If request is canceled, the result arrays are empty.
               if (grantResults.length > 0
                       && grantResults[0] == PackageManager.PERMISSION_GRANTED) {
                   mLocationPermissionGranted = true;
               }
           }
       }
   }
   

Inicializa el SDK de Navigation

El NavigationApi proporciona una lógica de inicialización que autoriza a la app a usar Google la navegación. En esta sección, se explica cómo inicializar el navegador, junto con algunas otras configuraciones que puedes habilitar para tu app:

1. Inicializa el SDK de Navigation y anula la devolución de llamada de onNavigatorReady() para iniciar la navegación cuando el navegador esté listo.

2. Opcional. Configura la app para que las notificaciones de instrucciones y los servicios en segundo plano se cierren cuando el usuario descarte la app de su dispositivo. Esta elección depende de tu modelo de negocio. Te recomendamos que uses el comportamiento predeterminado del navegador, que sigue mostrando la guía de giros y las actualizaciones de ubicación incluso cuando se descarta la app. Si, en cambio, deseas apagar actualizaciones de navegación y ubicación cuando el usuario final descartó la aplicación, usaría esta configuración.

3. Opcional. Habilita las restricciones viales en los países admitidos. Establece el último dígito de la matrícula. Esta llamada solo se debe realizar una vez: las solicitudes de instrucciones posteriores seguirán usándola. Esta llamada solo funciona en regiones compatibles. Consulta los países compatibles con el SDK de Navigation.

   NavigationApi.getNavigator(this, new NavigationApi.NavigatorListener() {
               /**
                * Sets up the navigation UI when the navigator is ready for use.
                */
               @Override
               public void onNavigatorReady(Navigator navigator) {
                   displayMessage("Navigator ready.");
                   mNavigator = navigator;
                   mNavFragment = (NavigationFragment) getFragmentManager()
                           .findFragmentById(R.id.navigation_fragment);
   
                   // Optional. Disable the guidance notifications and shut down the app
                   // and background service when the user closes the app.
                   // mNavigator.setTaskRemovedBehavior(Navigator.TaskRemovedBehavior.QUIT_SERVICE)
   
                   // Optional. Set the last digit of the car's license plate to get
                   // route restrictions for supported countries.
                   // mNavigator.setLicensePlateRestrictionInfo(getLastDigit(), "BZ");
   
                   // Set the camera to follow the device location with 'TILTED' driving view.
                   mNavFragment.getCamera().followMyLocation(Camera.Perspective.TILTED);
   
                   // Set the travel mode (DRIVING, WALKING, CYCLING, TWO_WHEELER, or TAXI).
                   mRoutingOptions = new RoutingOptions();
                   mRoutingOptions.travelMode(RoutingOptions.TravelMode.DRIVING);
   
                   // Navigate to a place, specified by Place ID.
                   navigateToPlace(SYDNEY_OPERA_HOUSE, mRoutingOptions);
               }
   
               /**
                * Handles errors from the Navigation SDK.
                * @param errorCode The error code returned by the navigator.
                */
               @Override
               public void onError(@NavigationApi.ErrorCode int errorCode) {
                   switch (errorCode) {
                       case NavigationApi.ErrorCode.NOT_AUTHORIZED:
                           displayMessage("Error loading Navigation SDK: Your API key is "
                                   + "invalid or not authorized to use the Navigation SDK.");
                           break;
                       case NavigationApi.ErrorCode.TERMS_NOT_ACCEPTED:
                           displayMessage("Error loading Navigation SDK: User did not accept "
                                   + "the Navigation Terms of Use.");
                           break;
                       case NavigationApi.ErrorCode.NETWORK_ERROR:
                           displayMessage("Error loading Navigation SDK: Network error.");
                           break;
                       case NavigationApi.ErrorCode.LOCATION_PERMISSION_MISSING:
                           displayMessage("Error loading Navigation SDK: Location permission "
                                   + "is missing.");
                           break;
                       default:
                           displayMessage("Error loading Navigation SDK: " + errorCode);
                   }
               }
           });
   

Establece un destino

La clase Navigator proporciona control sobre la configuración, el inicio y la detención de un recorrido de navegación.

Con el Navigator que obtuviste en la sección anterior, establece un destino Waypoint para este viaje. Después de calcular las instrucciones, SupportNavigationFragment muestra una polilínea que representa la ruta en el mapa y un marcador en el destino.

    private void navigateToPlace(String placeId, RoutingOptions travelMode) {
        Waypoint destination;
        try {
            destination = Waypoint.builder().setPlaceIdString(placeId).build();
        } catch (Waypoint.UnsupportedPlaceIdException e) {
            displayMessage("Error starting navigation: Place ID is not supported.");
            return;
        }

        // Create a future to await the result of the asynchronous navigator task.
        ListenableResultFuture<Navigator.RouteStatus> pendingRoute =
                mNavigator.setDestination(destination, travelMode);

        // Define the action to perform when the SDK has determined the route.
        pendingRoute.setOnResultListener(
                new ListenableResultFuture.OnResultListener<Navigator.RouteStatus>() {
                    @Override
                    public void onResult(Navigator.RouteStatus code) {
                        switch (code) {
                            case OK:
                                // Hide the toolbar to maximize the navigation UI.
                                if (getActionBar() != null) {
                                    getActionBar().hide();
                                }

                                // Enable voice audio guidance (through the device speaker).
                                mNavigator.setAudioGuidance(
                                        Navigator.AudioGuidance.VOICE_ALERTS_AND_GUIDANCE);

                                // Simulate vehicle progress along the route for demo/debug builds.
                                if (BuildConfig.DEBUG) {
                                    mNavigator.getSimulator().simulateLocationsAlongExistingRoute(
                                            new SimulationOptions().speedMultiplier(5));
                                }

                                // Start turn-by-turn guidance along the current route.
                                mNavigator.startGuidance();
                                break;
                            // Handle error conditions returned by the navigator.
                            case NO_ROUTE_FOUND:
                                displayMessage("Error starting navigation: No route found.");
                                break;
                            case NETWORK_ERROR:
                                displayMessage("Error starting navigation: Network error.");
                                break;
                            case ROUTE_CANCELED:
                                displayMessage("Error starting navigation: Route canceled.");
                                break;
                            default:
                                displayMessage("Error starting navigation: "
                                        + String.valueOf(code));
                        }
                    }
                });
    }

Compila y ejecuta tu app

1. Conecta un dispositivo Android a tu computadora. Sigue las instrucciones de Android Studio para ejecutar apps en un dispositivo de hardware. Como alternativa, puedes configurar un dispositivo virtual con el Administrador de dispositivos virtuales de Android (AVD). Al elegir un emulador, asegúrate de seleccionar una imagen que incluya las APIs de Google.
2. En Android Studio, haz clic en la opción de menú Run o en el ícono del botón de reproducción. Selecciona un dispositivo según se solicite.

Sugerencias para mejorar la experiencia del usuario

• El usuario debe aceptar las Condiciones del Servicio de Navegación de Google antes del navegación esté disponible. Esta aceptación solo se requiere una vez. De forma predeterminada, el SDK solicita la aceptación la primera vez que se invoca el navegador. Si lo prefieres, puedes activar el diálogo de las Condiciones del Servicio de Navigation en un punto inicial del flujo de UX de tu app, como durante el registro o el acceso, con TermsAndConditionsCheckOption.
• Para mejorar significativamente la calidad de la navegación y la precisión de la hora de llegada estimada, utiliza IDs de lugar para inicializar un punto de referencia en lugar de una latitud o longitud coordenadas.
• En este ejemplo, se obtiene el punto de referencia de destino a partir de un ID de lugar específico para el Ópera de Sídney. Puedes usar el buscador de IDs de lugar para obtener los IDs de lugares de otras ubicaciones específicas.