Cómo configurar tu proyecto de Android Studio

En esta página, se explica cómo integrar el SDK de Navigation en tu proyecto de desarrollo.

Agrega el SDK de Navigation a tu proyecto

El SDK de Navigation está disponible a través del repositorio de Maven de Google. Puedes agregar el SDK a tu proyecto con la configuración de build.gradle de Gradle o de pom.xml de Maven.

  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 a tu build.gradle a nivel del módulo:

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

    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>

  2. Si tienes dependencias que usan el SDK de Maps, debes excluirlas en cada dependencia declarada que dependa del SDK de Maps.

    Gradle

    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>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>

Configura la compilación

Después de crear el proyecto, puedes configurar los parámetros para compilar y usar el SDK de Navigation de forma correcta.

Actualiza las propiedades locales

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

Actualiza las propiedades de Gradle

  • En la carpeta Gradle Scripts, abre el archivo gradle.properties y agrega lo siguiente si aún no está presente:

    1. android.useAndroidX=true
    2. android.enableJetifier=true

Actualiza 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 y cumplir con los requisitos del SDK de Navigation. Considera configurar también las opciones de optimización.

    Configuración obligatoria para el SDK de Navigation

    1. Establece minSdkVersion en 23 o un valor superior.
    2. Establece targetSdkVersion en 34 o un valor superior.
    3. Agrega un parámetro de configuración dexOptions que aumente el javaMaxHeapSize.
    4. Establece la ubicación de las bibliotecas adicionales.
    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.

    Configuración opcional para disminuir el tiempo de compilación

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

    Se agregó expansión de sintaxis para la compatibilidad con Java 8

    • Si compilas tu app con el complemento de Android para Gradle 4.0.0 o una versión posterior, el complemento extiende la compatibilidad para usar varias APIs del lenguaje Java 8. Consulta Compatibilidad con expansión de sintaxis de Java 8 para obtener más información. Consulta el siguiente fragmento de ejemplo de la secuencia de comandos de compilación para ver cómo compilar y las opciones de dependencia.
    • Te recomendamos que uses Gradle 8.4, la versión 8.3.0 del complemento de Android para Gradle y la biblioteca de expansión de sintaxis com.android.tools:desugar_jdk_libs_nio:2.0.3. Esta configuración es compatible con el SDK de Navigation para Android 6.0.0 y versiones posteriores.
    • La biblioteca de expansión de sintaxis debe estar habilitada para el módulo app y cualquier módulo que dependa directamente del 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 ver conjuntos de dependencias actualizados, ya que la versión del SDK de Navigation que usas puede estar un poco por delante o por detrás de esta documentación.

apply plugin: 'com.android.application'

ext {
    navSdk = "__NAVSDK_VERSION__"
}

android {
    compileSdk 33
    buildToolsVersion='28.0.3'

    defaultConfig {
        applicationId "<your id>"
        // Navigation SDK supports SDK 23 and later.
        minSdkVersion 23
        targetSdkVersion 34
        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 {
        // Flag to enable support for the new language APIs
        coreLibraryDesugaringEnabled true
        // Sets Java compatibility to Java 8
        sourceCompatibility JavaVersion.VERSION_1_8
        targetCompatibility JavaVersion.VERSION_1_8
    }
}

repositories {
    // Navigation SDK for Android and other libraries are hosted on Google's Maven repository.
    google()
}

dependencies {
    // Include the Google Navigation SDK.
    // Note: remember to exclude Google Play service Maps SDK from your transitive
    // dependencies to avoid duplicate copies of the Google Maps SDK.
    api "com.google.android.libraries.navigation:navigation:${navSdk}"

    // Declare other dependencies for your app here.

    annotationProcessor "androidx.annotation:annotation:1.7.0"
    coreLibraryDesugaring 'com.android.tools:desugar_jdk_libs_nio:2.0.3'
}

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 tu archivo build.gradle.kts o build.gradle de nivel superior y agrega el siguiente código al elemento dependencies en buildscript.

    Kotlin

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

    Groovy

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

    Kotlin

    plugins {
    // ...
    id("com.google.android.libraries.mapsplatform.secrets-gradle-plugin")
}

    Groovy

    plugins {
    // ...
    id 'com.google.android.libraries.mapsplatform.secrets-gradle-plugin'
}
  3. En tu archivo build.gradle.kts o build.gradle a nivel del módulo, asegúrate de que targetSdk y compileSdk estén establecidos 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 agrega el siguiente código. Reemplaza YOUR_API_KEY por tu clave de API. Almacena tu clave en este archivo, ya que secrets.properties no se registra en un sistema de control de versión. 
    NAV_API_KEY=YOUR_API_KEY
  6. Guarda el archivo.

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

    NAV_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 si no se encuentra el archivo secrets.properties, de modo que no fallen las compilaciones. 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.kts or build.gradle 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.

    Kotlin

    secrets {
    // To add your Maps API key to this project:
    // 1. If the secrets.properties file does not exist, create it in the same folder as the local.properties file.
    // 2. Add this line, where YOUR_API_KEY is your API key:
    //        MAPS_API_KEY=YOUR_API_KEY
    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.*"
}

    Groovy

    secrets {
    // To add your Maps API key to this project:
    // 1. If the secrets.properties file does not exist, create it in the same folder as the local.properties file.
    // 2. Add this line, where YOUR_API_KEY is your API key:
    //        MAPS_API_KEY=YOUR_API_KEY
    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 app

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

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

  • NOTICE.txt
  • LICENSES.txt

Si eres cliente de Mobility o Fleet Engine Deliveries

Si eres cliente de Mobility o Fleet Engine Deliveries, obtén información sobre la facturación en la documentación de Mobility. Para obtener más información sobre cómo registrar transacciones, consulta Cómo configurar la facturación, Cómo registrar transacciones facturables, Informes y Cómo registrar transacciones facturables (Android).