Configura tu proyecto (versión 4.99 y anteriores)

En esta guía, se enumeran los requisitos de configuración de compilación para usar el SDK de Navigation para Android. En las instrucciones, se asume que tienes instalado un IDE de Android y que estás familiarizado con el desarrollo de Android.

Requisitos mínimos para usar el SDK de Navigation

Estos requisitos se aplican al SDK de Navigation para Android 4.99 y versiones anteriores.

  • Un proyecto de la consola de Google Cloud con el SDK de Navigation habilitado Para obtener información sobre el aprovisionamiento, comunícate con tu representante de Google Maps Platform.

  • Tu app debe orientarse al nivel de API 30 o uno superior.

  • Para ejecutar una app compilada con el SDK de Navigation, el dispositivo Android debe tener instalados y habilitados los Servicios de Google Play.

  • Se deben agregar a la app el texto de atribuciones y licencias.

Configura tus proyectos: proyecto de la consola de Cloud y proyecto de Android

Antes de compilar o probar una app, debes crear un proyecto de la consola de Cloud y agregar las credenciales de la clave de API. El proyecto debe tener aprovisionamiento para acceder al SDK de Navigation. Todas las claves dentro del proyecto de la consola de Cloud tienen el mismo acceso al SDK de Navigation. Una clave puede tener más de un proyecto de desarrollo asociado. Si ya tienes un proyecto de la consola, puedes agregar una clave a tu proyecto actual.

Para configurar

  1. En tu navegador web favorito, accede a la consola de Cloud y crea un proyecto de la consola de Cloud.
  2. En tu IDE, como Android Studio, crea un proyecto de desarrollo de apps para Android y anota el nombre del paquete.
  3. Comunícate con tu representante de Google Maps Platform para proporcionarle acceso al SDK de Navigation para tu proyecto de la consola de Cloud.
  4. En el panel de la consola de Cloud en tu navegador web, crea credenciales para generar una clave de API con restricciones.
  5. En la página de claves de API, haz clic en Apps para Android en el área Restricciones de aplicaciones.
  6. Haz clic en Agregar el nombre del paquete y la huella digital y, luego, ingresa el nombre del paquete de tu proyecto de desarrollo y la huella digital SHA-1 para esa clave.
  7. Haz clic en Guardar.

Cómo agregar el SDK de Navigation a tu proyecto

El SDK de Navigation está disponible a través de Maven o como un paquete AAR. Después de crear tu proyecto de desarrollo, puedes integrar el SDK a él mediante uno de los siguientes enfoques.

A continuación, se usa el repositorio Maven de google(), que es la forma más sencilla y recomendada de agregar el SDK de Navigation a tu proyecto.

  1. Agrega la siguiente dependencia a tu configuración de Gradle o Maven y reemplaza el marcador de posición VERSION_NUMBER por la versión deseada del SDK de Navigation para Android.

    Gradle

    Agrega lo siguiente al build.gradle a nivel del módulo:

    dependencies {
  ...
  implementation 'com.google.android.libraries.navigation:navigation:VERSION_NUMBER'
}

    Si actualizas desde el repositorio de Maven original, ten en cuenta que los nombres del grupo y del artefacto cambiaron, y ya no se necesita el complemento com.google.cloud.artifactregistry.gradle-plugin.

    Además, agrega lo siguiente a tu build.gradle de nivel superior:

    allprojects {
   ...
   // Required: you must exclude the Google Play service Maps SDK from
   // your transitive dependencies. This is to ensure there won't be
   // multiple copies of Google Maps SDK in your binary, as the Navigation
   // SDK already bundles the Google Maps SDK.
   configurations {
       implementation {
           exclude group: 'com.google.android.gms', module: 'play-services-maps'
       }
   }
}

    Maven

    Agrega lo siguiente a tu pom.xml:

    <dependencies>
  ...
  <dependency>
    <groupId>com.google.android.libraries.navigation</groupId>
    <artifactId>navigation</artifactId>
    <version>VERSION_NUMBER</version>
  </dependency>
</dependencies>

    Si tienes dependencias que usan el SDK de Maps, debes excluir la dependencia de cada dependencia declarada que se base en el SDK de Maps.

    <dependencies>
  <dependency>
  <groupId>project.that.brings.in.maps</groupId>
  <artifactId>MapsConsumer</artifactId>
  <version>1.0</version>
    <exclusions>
      <!-- Navigation SDK already bundles Maps SDK. You must exclude it to prevent duplication-->
      <exclusion>  <!-- declare the exclusion here -->
        <groupId>com.google.android.gms</groupId>
        <artifactId>play-services-maps</artifactId>
      </exclusion>
    </exclusions>
  </dependency>
</dependencies>

Usar el SDK de Maven para Navigation antes de la versión 4.5 o con el SDK de Driver

El SDK de Navigation seguirá disponible en el repositorio original de Maven hasta el resto de las versiones v4. Es la misma biblioteca, pero tiene las mismas actualizaciones que la versión anterior y proporciona compatibilidad con el SDK de Driver y otras bibliotecas durante la transición. El uso de esta dependencia requiere acceder a tu proyecto de la nube a través de gcloud durante la compilación.

  1. Configura tu entorno para acceder al repositorio Maven de Google como se describe en la sección Requisitos previos de la documentación del SDK para consumidores. El acceso al SDK de Navigation se controla mediante un grupo de lugares de trabajo.

  2. Agrega la siguiente dependencia a tu configuración de Gradle o Maven y reemplaza el marcador de posición VERSION_NUMBER por la versión deseada del SDK de Navigation.

    Gradle

    Agrega lo siguiente al build.gradle a nivel del módulo:

    dependencies {
  ...
  implementation 'com.google.android.maps:navsdk:VERSION_NUMBER'
}

    Además, agrega lo siguiente a tu build.gradle de nivel superior:

    allprojects {
   ...
   // Required: you must exclude the Google Play service Maps SDK from
   // your transitive dependencies. This is to ensure there won't be
   // multiple copies of Google Maps SDK in your binary, as the Navigation
   // SDK already bundles the Google Maps SDK.
   configurations {
       implementation {
           exclude group: 'com.google.android.gms', module: 'play-services-maps'
       }
   }
}

    Maven

    Agrega lo siguiente a tu pom.xml:

    <dependencies>
  ...
  <dependency>
    <groupId>com.google.android.maps</groupId>
    <artifactId>navsdk</artifactId>
    <version>VERSION_NUMBER</version>
  </dependency>
</dependencies>

    Si tienes dependencias que usan el SDK de Maps, debes excluir la dependencia de cada dependencia declarada que se base en el SDK de Maps.

    <dependencies>
  <dependency>
  <groupId>project.that.brings.in.maps</groupId>
  <artifactId>MapsConsumer</artifactId>
  <version>1.0</version>
    <exclusions>
      <!-- Navigation SDK already bundles Maps SDK. You must exclude it to prevent duplication-->
      <exclusion>  <!-- declare the exclusion here -->
        <groupId>com.google.android.gms</groupId>
        <artifactId>play-services-maps</artifactId>
      </exclusion>
    </exclusions>
  </dependency>
</dependencies>

El SDK de Navigation también está disponible como un paquete AAR. Después de crear el proyecto de desarrollo, puedes integrar el SDK. En estas instrucciones, se da por sentado el uso de Android Studio para tu IDE.

  1. Descarga la versión más reciente del SDK de Navigation desde la Google Drive compartida y descomprímela. Si no tienes acceso, comunícate con tu representante.

  2. En Android Studio, abre un proyecto y agrega el paquete de los Servicios de Google Play con SDK Manager.

  3. En el directorio de archivos ZIP, copia libs/google_navigation_navmap.aar en el directorio app/libs de tu proyecto.

  4. Agrega lo siguiente al build.gradle a nivel del módulo:

    implementation(name: 'google_navigation_navmap', ext: 'aar')

    Además, agrega lo siguiente a tu build.gradle de nivel superior:

    allprojects {
    ...
    // Required: you must exclude the Google Play service Maps SDK from
    // your transitive dependencies. This is to ensure there won't be
    // multiple copies of Google Maps SDK in your binary, as the Navigation
    // SDK already bundles the Google Maps SDK.
    configurations {
        implementation {
            exclude group: 'com.google.android.gms', module: 'play-services-maps'
        }
    }
}

Configura la compilación

Después de crear el proyecto, puedes establecer la configuración para una compilación exitosa y el uso del SDK de Navigation.

Actualizar propiedades locales

  • En la carpeta Gradle Scripts, abre el archivo local.properties y agrega android.useDeprecatedNdk=true.

Cómo actualizar la secuencia de comandos de compilación de Gradle

  • Abre el archivo build.gradle (Module:app) y usa los siguientes lineamientos para actualizar la configuración a fin de cumplir con los requisitos del SDK de Navigation. Además, considera configurar las opciones de optimización.

    Configuración obligatoria para el SDK de Navigation

    1. Establece minSdkVersion en 23 o más.
    2. Establece targetSdkVersion en 30 o más.
    3. Agrega un parámetro de configuración de dexOptions que aumente el javaMaxHeapSize.
    4. Establece la ubicación para otras bibliotecas.
    5. Agrega repositories y dependencies para el SDK de Navigation.
    6. Reemplaza los números de versión de las dependencias por las versiones más recientes disponibles.

    Parámetros de configuración opcionales para reducir el tiempo de compilación

    • Habilita la reducción de código y de recursos con R8/ProGuard para quitar de las dependencias el código y los recursos que no se utilicen. Si el paso de R8/ProGuard tarda demasiado en ejecutarse, considera habilitar multidex en el trabajo de desarrollo.
    • Reduce la cantidad de traducciones de idiomas incluidas en la compilación: configura resConfigs para un idioma durante el desarrollo. Para la compilación final, configura resConfigs para los lenguajes que realmente usas. De forma predeterminada, Gradle incluye cadenas de recursos para todos los idiomas compatibles con el SDK de Navigation.

A continuación, se muestra un ejemplo de la secuencia de comandos de compilación de Gradle para la aplicación. Consulta las apps de ejemplo para buscar conjuntos actualizados de dependencias, ya que la versión del SDK de Navigation que estás usando puede estar un poco adelantada o detrás de esta documentación.

apply plugin: 'com.android.application'
apply plugin: 'com.google.cloud.artifactregistry.gradle-plugin'

ext {
    androidxVersion = "1.0.0"
    lifecycle_version = "1.1.1"
}

android {
    compileSdkVersion 30
    buildToolsVersion '28.0.3'

    defaultConfig {
        applicationId "<your id>"
        // Navigation SDK supports SDK 23 and later.
        minSdkVersion 23
        targetSdkVersion 30
        versionCode 1
        versionName "1.0"
        // Set this to the languages you actually use, otherwise you'll include resource strings
        // for all languages supported by the Navigation SDK.
        resConfigs "en"
        multiDexEnabled true
    }

    dexOptions {
        // This increases the amount of memory available to the dexer. This is required to build
        // apps using the Navigation SDK.
        javaMaxHeapSize "4g"
    }
    buildTypes {
        // Run ProGuard. Note that the Navigation SDK includes its own ProGuard configuration.
        // The configuration is included transitively by depending on the Navigation SDK.
        // If the ProGuard step takes too long, consider enabling multidex for development work
        // instead.
        all {
            minifyEnabled true
            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
        }
    }
    compileOptions {
        sourceCompatibility JavaVersion.VERSION_1_8
        targetCompatibility JavaVersion.VERSION_1_8
    }
}

// This tells Gradle where to look to find additional libraries - in this case, the
// google_navigation_navmap.aar file.
repositories {
    flatDir {
        dirs 'libs'
    }
    google()

    // Required for accessing the Navigation SDK on Google's Maven repository.
    maven {
        url "artifactregistry://us-west2-maven.pkg.dev/gmp-artifacts/transportation"
    }
}

dependencies {
    // Include the Google Navigation SDK
    implementation 'com.google.android.maps:navsdk:4.4.0'

    // The included AAR file under libs can be used instead of the Maven repository.
    // Uncomment the line below and comment out the previous dependency to use
    // the AAR file instead. Ensure that you add the AAR file to the libs directory.
    // implementation(name: 'google_navigation_navmap', ext: 'aar')

    // These dependencies are required for the Navigation SDK to function
    // properly at runtime.
    implementation 'org.chromium.net:cronet-fallback:69.3497.100'
    // Optional for Cronet users:
    // implementation 'org.chromium.net:cronet-api:69.3497.100'
    implementation 'androidx.appcompat:appcompat:${androidxVersion}'
    implementation 'androidx.cardview:cardview:${androidxVersion}'
    implementation 'com.google.android.material:material:${androidxVersion}'
    implementation 'androidx.mediarouter:mediarouter:${androidxVersion}'
    implementation 'androidx.preference:preference:${androidxVersion}'
    implementation 'androidx.recyclerview:recyclerview:${androidxVersion}'
    implementation 'androidx.legacy:legacy-support-v4:${androidxVersion}'
    implementation 'com.github.bumptech.glide:glide:4.9.0'
    implementation 'com.github.bumptech.glide:okhttp-integration:4.9.0'
    implementation 'android.arch.lifecycle:common-java8:$lifecycle_version'
    implementation 'com.android.support:multidex:1.0.3'
    implementation 'com.google.android.datatransport:transport-api:2.2.0'
    implementation 'com.google.android.datatransport:transport-backend-cct:2.2.0'
    implementation 'com.google.android.datatransport:transport-runtime:2.2.0'
    implementation 'joda-time:joda-time:2.9.9'
    annotationProcessor 'androidx.annotation:annotation:1.1.0'
    annotationProcessor 'com.github.bumptech.glide:compiler:4.9.0'
}

Agrega la clave de API a tu app

En esta sección, se describe cómo almacenar tu clave de API para que tu app pueda hacer referencia a ella de manera más segura. No debes incluir la clave de API en el sistema de control de versión, por lo que te recomendamos almacenarla en el archivo secrets.properties, que se encuentra en el directorio raíz de tu proyecto. Para obtener más información sobre el archivo secrets.properties, consulta los archivos de propiedades de Gradle.

Para optimizar esta tarea, te recomendamos que uses el complemento Secrets Gradle para Android.

Si deseas instalar el complemento Secrets Gradle para Android en tu proyecto de Google Maps, haz lo siguiente:

  1. En Android Studio, abre el archivo build.gradle o build.gradle.kts de nivel superior y agrega el siguiente código al elemento dependencies en buildscript.

    Groovy

    buildscript {
    dependencies {
        classpath "com.google.android.libraries.mapsplatform.secrets-gradle-plugin:secrets-gradle-plugin:2.0.1"
    }
}

    Kotlin

    buildscript {
    dependencies {
        classpath("com.google.android.libraries.mapsplatform.secrets-gradle-plugin:secrets-gradle-plugin:2.0.1")
    }
}
  2. Abre el archivo build.gradle a nivel del módulo y agrega el siguiente código al elemento plugins.

    Groovy

    plugins {
    // ...
    id 'com.google.android.libraries.mapsplatform.secrets-gradle-plugin'
}

    Kotlin

    plugins {
    id("com.google.android.libraries.mapsplatform.secrets-gradle-plugin")
}
  3. En tu archivo build.gradle a nivel del módulo, asegúrate de que targetSdk y compileSdk se hayan establecido en 34.
  4. Guarda el archivo y sincroniza tu proyecto con Gradle.
  5. Abre el archivo secrets.properties en tu directorio de nivel superior y, luego, agrega el siguiente código. Reemplaza YOUR_API_KEY por tu clave de API. Almacena tu clave en ese archivo porque secrets.properties no se registra en un sistema de control de versión. 
    MAPS_API_KEY=YOUR_API_KEY
  6. Guarda el archivo.

  7. Crea el archivo local.defaults.properties en tu directorio principal, en la misma carpeta en la que se encuentra el archivo secrets.properties, y luego agrega el siguiente código.

    MAPS_API_KEY=DEFAULT_API_KEY

    El propósito de este archivo es proporcionar una ubicación de copia de seguridad de la clave de API en caso de que no se encuentre el archivo secrets.properties, de modo que las compilaciones no fallen. Esto puede ocurrir si clonas la app desde un sistema de control de versión que omite secrets.properties y aún no creaste un archivo secrets.properties localmente para proporcionar tu clave de API.

  8. Guarda el archivo.
  9. En tu archivo AndroidManifest.xml, ve a com.google.android.geo.API_KEY y actualiza android:value attribute. Si la etiqueta <meta-data> no existe, créala como un elemento secundario de la etiqueta <application>. 
    <meta-data
    android:name="com.google.android.geo.API_KEY"
    android:value="${MAPS_API_KEY}" />

    Note: com.google.android.geo.API_KEY is the recommended metadata name for the API key. A key with this name can be used to authenticate to multiple Google Maps-based APIs on the Android platform, including the Navigation SDK for Android. For backwards compatibility, the API also supports the name com.google.android.maps.v2.API_KEY. This legacy name allows authentication to the Android Maps API v2 only. An application can specify only one of the API key metadata names. If both are specified, the API throws an exception.

  10. In Android Studio, open your module-level build.gradle or build.gradle.kts file and edit the secrets property. If the secrets property does not exist, add it.

    Edit the properties of the plugin to set propertiesFileName to secrets.properties, set defaultPropertiesFileName to local.defaults.properties, and set any other properties.

    Groovy

    secrets {
    // Optionally specify a different file name containing your secrets.
    // The plugin defaults to "local.properties"
    propertiesFileName = "secrets.properties"

    // A properties file containing default secret values. This file can be
    // checked in version control.
    defaultPropertiesFileName = "local.defaults.properties"

    // Configure which keys should be ignored by the plugin by providing regular expressions.
    // "sdk.dir" is ignored by default.
    ignoreList.add("keyToIgnore") // Ignore the key "keyToIgnore"
    ignoreList.add("sdk.*")       // Ignore all keys matching the regexp "sdk.*"
}

    Kotlin

    secrets {
    // Optionally specify a different file name containing your secrets.
    // The plugin defaults to "local.properties"
    propertiesFileName = "secrets.properties"

    // A properties file containing default secret values. This file can be
    // checked in version control.
    defaultPropertiesFileName = "local.defaults.properties"

    // Configure which keys should be ignored by the plugin by providing regular expressions.
    // "sdk.dir" is ignored by default.
    ignoreList.add("keyToIgnore") // Ignore the key "keyToIgnore"
    ignoreList.add("sdk.*")       // Ignore all keys matching the regexp "sdk.*"
}

Incluye las atribuciones requeridas en tu aplicación

Si usas el SDK de Navigation para Android en tu app, debes incluir texto de atribución y licencias de código abierto como parte de la sección de avisos legales de tu app.

Puedes encontrar el texto de atribución y las licencias de código abierto necesarios en el archivo ZIP del SDK de Navigation para Android:

  • NOTICE.txt
  • LICENSES.txt