Configura tu proyecto

Sigue esta guía para integrar el SDK de Navigation para iOS en una app para iOS.

Requisitos previos

  • Antes de comenzar a usar el SDK de Navigation para iOS, debes tener un proyecto con una cuenta de facturación y el SDK de Maps para iOS habilitado. Recomendamos crear varios propietarios de proyecto y administradores de facturación para que tu equipo siempre tenga a alguien disponible con estos roles. Para obtener más información, consulta Configura tu proyecto de Google Cloud.
  • Si quieres compilar un proyecto con el SDK de Navigation para iOS, necesitas la versión 15.0 de Xcode o una posterior.
  • La versión de iOS de destino mínima para el SDK de Navigation es 15.0.

Paso 1: Instala el SDK

Swift Package Manager

El SDK de Navigation se puede instalar a través de Swift Package Manager. Para agregar el SDK, asegúrate de haber quitado todas las dependencias existentes del SDK de Navigation.

Para agregar el SDK a un proyecto nuevo o existente, sigue estos pasos:

  1. Abre tu código project o workspace de Xcode y ve a File > Add Package Dependencies.
  2. Ingresa https://github.com/googlemaps/ios-navigation-sdk como la URL, presiona Intro para extraer el paquete y haz clic en "Add Package".
  3. Para instalar un version específico, configura el campo Dependency Rule en una de las opciones basadas en la versión. Para proyectos nuevos, te recomendamos especificar la versión más reciente y usar la opción "Versión exacta". Cuando termines, haz clic en "Add Package".
  4. En la ventana Choose Package Products, verifica que se agregue GoogleNavigation al destino main designado. Cuando termines, haz clic en "Add Package".
  5. Para verificar la instalación, navega al panel General de tu destino. En Frameworks, bibliotecas y contenido incorporado, deberías ver los paquetes instalados. También puedes consultar la sección "Package Dependencies" de "Project Navigator" para verificar el paquete y su versión.

Para actualizar el package de un proyecto existente, sigue estos pasos:

  1. Si actualizas desde una versión anterior a la 9.0.0, debes quitar las siguientes dependencias: GoogleMapsBase, GoogleMapsCore y GoogleMapsM4B después de la actualización. No quites la dependencia para GoogleMaps. Para obtener más información, consulta las Notas de la versión 9.0.0.

    En los parámetros de configuración del proyecto Xcode, busca Frameworks, bibliotecas y contenido incorporado. Usa el signo menos(-) para quitar el siguiente marco de trabajo:

    • GoogleMapsBase (solo para actualizaciones de versiones anteriores a la 9.0.0)
    • GoogleMapsCore (solo para actualizaciones de versiones anteriores a la 9.0.0)
    • GoogleMapsM4B (solo para actualizaciones de versiones anteriores a la 9.0.0)
  2. En Xcode, ve a “File > Packages > Update To Latest Package Versions”.
  3. Para verificar la instalación, ve a la sección Package Dependencies de Project Navigator para verificar el paquete y su versión.

Para quitar dependencias del SDK de Navigation existentes que se agregaron con CocoaPods, sigue estos pasos:

  1. Cierra tu espacio de trabajo de Xcode. Abre la terminal y ejecuta el siguiente comando:
    sudo gem install cocoapods-deintegrate cocoapods-clean 
    pod deintegrate 
    pod cache clean --all
  2. Quita Podfile, Podfile.resolved y el workspace de Xcode si no los usas para nada que no sea CocoaPods.

Si quieres quitar de forma manual el SDK de Navigation para iOS existente, sigue estos pasos:
  1. En los parámetros de configuración del proyecto Xcode, busca Frameworks, bibliotecas y contenido incorporado. Usa el signo menos(-) para quitar el siguiente framework:
    • GoogleMaps.xcframework
    • GoogleMapsBase.xcframework
    • GoogleMapsCore.xcframework
    • GoogleNavigation.xcframework
  2. Desde el directorio de nivel superior de tu proyecto de Xcode, quita el paquete GoogleMaps.

CocoaPods

El SDK de Navigation para iOS está disponible como un pod de CocoaPods. CocoaPods es un administrador de dependencias de código abierto para proyectos de Swift y Objective-C de Cocoa.

Si todavía no tienes la herramienta CocoaPods, instálala en macOS ejecutando el siguiente comando desde la terminal. Para obtener más información, consulta la guía de introducción de CocoaPods.

sudo gem install cocoapods

Crea un Podfile para el SDK de Navigation para iOS y úsalo a fin de instalar la API y sus dependencias:

  1. Si aún no tienes un proyecto de Xcode, créalo y guárdalo en tu máquina local. Si es la primera vez que realizas desarrollos en iOS, haz lo siguiente:
    1. Crea un proyecto nuevo
    2. Selecciona la plantilla iOS > App.
    3. En la pantalla de opciones del proyecto, haz lo siguiente:
      1. Ingresa el nombre del proyecto en Project Name.
      2. Registra el valor del campo Identificador de paquete. Puedes usar ese valor para restringir tu clave de API a continuación.
      3. Configura la Interface del proyecto como Storyboard.
      4. En Lenguaje, selecciona Swift o Objective-C.
  2. Crea un archivo llamado Podfile en el directorio de tu proyecto. Este archivo define las dependencias de tu proyecto.
  3. Edita el archivo Podfile y agrega tus dependencias junto con sus versions. A continuación, se muestra un ejemplo en el que se incluye la dependencia que necesitas para el SDK de Navigation para iOS: # Número de referencia de instalación de CocoaPods
    source 'https://github.com/CocoaPods/Specs.git'
    
    platform :ios, '15.0'
    
    target 'YOUR_APPLICATION_TARGET_NAME_HERE' do
      pod 'GoogleNavigation', '9.0.0'
    end
            
    Asegúrate de ejecutar pod outdated con regularidad para detectar versiones más recientes. Si es necesario, actualiza a la versión más reciente.
  4. Guarda el Podfile.
  5. Abre una terminal y ve al directorio que contiene Podfile:

    cd <path-to-project>
  6. Ejecuta el comando pod install. Esto instala las APIs especificadas en el Podfile, junto con cualquier dependencia.

    pod install
  7. Cierra Xcode. Luego, haz doble clic en el archivo .xcworkspace de tu proyecto para abrirlo y que se inicie Xcode. A partir de este momento, usa el archivo .xcworkspace para abrir el proyecto.

Para actualizar la API de un proyecto existente, sigue estos pasos:

  1. Abre una terminal y ve al directorio del proyecto que contiene el Podfile.
  2. Ejecuta el comando pod update. Esto actualiza todas las APIs especificadas en el Podfile a la versión más reciente.

Instalación manual

En esta guía, se muestra cómo agregar manualmente los XCFrameworks que contienen el SDK de Navigation para iOS y el SDK de Maps para iOS a tu proyecto, y configurar los parámetros de compilación en Xcode. Un XCFramework es un paquete binario que puedes usar en varias plataformas, incluidas máquinas que usan el chipset M1

Sigue estos pasos a fin de instalar XCFrameworks para el SDK de Navigation para iOS y el SDK de Maps para iOS:

  1. Descarga los siguientes archivos binarios y de recursos del SDK:
  2. Ejecuta Xcode y abre un proyecto existente o crea uno nuevo. Si es la primera vez que usas iOS, crea un proyecto nuevo y selecciona la plantilla de app para iOS.
  3. Quita todas las referencias existentes de Maps, Navigation y Places del proyecto.
  4. Arrastra los siguientes XCFrameworks a tu proyecto, en Frameworks, bibliotecas y contenido incorporado, para instalar los SDK de Maps y Navigation (cuando se te solicite, selecciona Copy items if needed):
    • GoogleMaps.xcframework
    • GoogleMapsBase.xcframework
    • GoogleMapsCore.xcframework
    • GoogleNavigation.xcframework
  5. Arrastra GoogleMaps.bundle desde GoogleMapsResources que descargaste al directorio de nivel superior de tu proyecto de Xcode. Cuando se te solicite, asegúrate de seleccionar la opción Copy items if needed.
  6. Arrastra GoogleNavigation.bundle desde GoogleNavigationResources que descargaste al directorio de nivel superior de tu proyecto de Xcode. Cuando se te solicite, asegúrate de que la opción Copy items into destination group's folder esté seleccionada.
  7. Selecciona tu proyecto en el navegador de proyectos y elige el destino de la aplicación.
  8. Abre la pestaña Build Fases y, en Link Binary with Libraries, agrega los siguientes frameworks y bibliotecas:
    • Accelerate.framework
    • AudioToolbox.framework
    • AVFoundation.framework
    • Contacts.framework
    • CoreData.framework
    • CoreGraphics.framework
    • CoreImage.framework
    • CoreLocation.framework
    • CoreTelephony.framework
    • CoreText.framework
    • GLKit.framework
    • ImageIO.framework
    • libc++.tbd
    • libxml2.tbd
    • libz.tbd
    • Metal.framework
    • OpenGLES.framework
    • QuartzCore.framework
    • Security.framework
    • SystemConfiguration.framework
    • UIKit.framework
    • UserNotifications.framework
    • WebKit.framework
  9. En el destino de tu aplicación, selecciona la pestaña Funciones, activa los Modos en segundo plano y habilita los siguientes modos:
    • Audio, AirPlay y pantalla en pantalla
    • Actualizaciones de ubicación
  10. Elige tu proyecto, en lugar de un destino específico, y abre la pestaña Build Settings. En la sección Otras marcas del vinculador, agrega ‑ObjC para debug y release. Si esta configuración no es visible, cambia el filtro en la barra Build Settings de Basic a All.
  11. Abre Info.plist y agrega los siguientes pares clave-valor:
    • Clave: NSLocationWhenInUseUsageDescription (Privacidad: Ubicación cuando se usa la descripción de uso)
      Valor: "Esta app necesita permiso para usar tu ubicación para la navegación paso a paso".
    • Clave: NSLocationAlwaysAndWhenInUseUsageDescription (Privacidad: Ubicación siempre y cuando se utiliza la descripción de uso)
      Valor: "Esta app necesita permiso para usar tu ubicación para la navegación paso a paso".

Paso 2: Inspecciona el archivo de manifiesto de privacidad de Apple

Apple requiere detalles de privacidad para las apps que se encuentran en la App Store. Visita la página de detalles de privacidad de la App Store de Apple para obtener actualizaciones y más información.

El archivo de manifiesto de privacidad de Apple se incluye en el paquete de recursos del SDK. Para verificar que se haya incluido el archivo de manifiesto de privacidad y para inspeccionar su contenido, crea un archivo de tu app y genera un informe de privacidad a partir del archivo.

Paso 3: Agrega una clave de API a tu proyecto

En los siguientes ejemplos, se muestra cómo agregar la clave de API a tu proyecto en Xcode:

Swift

Agrega tu clave de API a AppDelegate.swift de la siguiente manera:

  1. Agrega las siguientes declaraciones de importación:
    import GoogleMaps
    import GoogleNavigation
  2. Agrega lo siguiente a tu método application(_:didFinishLaunchingWithOptions:):
    GMSServices.provideAPIKey("YOUR_API_KEY")

Objective‑C

Agrega tu clave de API a AppDelegate.m de la siguiente manera:

  1. Agrega las siguientes declaraciones de importación:
    @import GoogleMaps;
    @import GoogleNavigation;
  2. Agrega lo siguiente a tu método application:didFinishLaunchingWithOptions::
    [GMSServices provideAPIKey:@"YOUR_API_KEY"];

Paso 4: Agrega un mapa

En este código, se muestra cómo agregar un mapa simple a un objeto ViewController existente, incluidas algunas opciones de configuración iniciales para la navegación.

Para poder habilitar la navegación, el usuario debe aceptar los Términos y Condiciones. Para solicitarle al usuario, llama a GMSNavigationServices.showTermsAndConditionsDialogIfNeeded() y verifica si se aceptaron las condiciones. Si el usuario rechaza las condiciones, mapView.isNavigationEnabled = true no tendrá ningún efecto y mapView.navigator será nulo.

Swift

import UIKit
import GoogleNavigation

class ViewController: UIViewController {

  var mapView: GMSMapView!
  var locationManager: CLLocationManager!

  override func loadView() {
    locationManager = CLLocationManager()
    locationManager.requestAlwaysAuthorization()

    let camera = GMSCameraPosition.camera(withLatitude: 47.67, longitude: -122.20, zoom: 14)
    mapView = GMSMapView.map(withFrame: CGRect.zero, camera: camera)

    // Show the terms and conditions.
    let companyName = "Ride Sharing Co."
    GMSNavigationServices.showTermsAndConditionsDialogIfNeeded(
      withCompanyName: companyName) { termsAccepted in
      if termsAccepted {
        // Enable navigation if the user accepts the terms.
        self.mapView.isNavigationEnabled = true
      } else {
        // Handle the case when the user rejects the terms and conditions.
      }
    }

    view = mapView
  }

  // TODO: Add navigation code.

}

Objective‑C

#import "ViewController.h"
@import GoogleNavigation;

@interface ViewController ()
@end

@implementation ViewController
GMSMapView *_mapView;
CLLocationManager *_locationManager;

-   (void)loadView {

  _locationManager = [[CLLocationManager alloc] init];
  [_locationManager requestAlwaysAuthorization];

  GMSCameraPosition *camera = [GMSCameraPosition cameraWithLatitude:47.67
                                                          longitude:-122.20
                                                               zoom:14];
  _mapView = [GMSMapView mapWithFrame:CGRectZero camera:camera];

  // Show the terms and conditions.
  NSString *companyName = @"Ride Sharing Co.";
  [GMSNavigationServices
    showTermsAndConditionsDialogIfNeededWithCompanyName:companyName
    callback:^(BOOL termsAccepted) {
     if (termsAccepted) {
       // Enable navigation if the user accepts the terms.
       _mapView.navigationEnabled = YES;
     } else {
       // Handle the case when the user rejects the terms and conditions.
     }
   }];

  self.view = _mapView;
}

// TODO: Add navigation code.

@end

Ejecuta tu aplicación. Deberías ver un mapa centrado en Kirkland, Washington. Si no puedes ver el mapa, confirma que hayas proporcionado la clave de API correcta.

Si eres cliente de servicios de movilidad

Si eres cliente de servicios de movilidad, consulta la documentación de movilidad. Para obtener más información sobre el registro de transacciones, consulta Cómo configurar la facturación. Para obtener información sobre cómo agregar IDs de transacción a tu implementación del SDK de Navigation, consulta Cómo asociar tu uso del servicio a las transacciones de movilidad.