Configura un proyecto de Android Studio

En esta página, se explica cómo configurar un proyecto de Android Studio para utilizar el SDK de Maps para Android sin la plantilla de Google Maps que se detalla en la Guía de inicio rápido.

La plantilla de Google Maps configura automáticamente un proyecto de Android Studio nuevo y agrega un mapa básico. Sin embargo, también puedes agregar un mapa a un proyecto de Android que utilice una plantilla de Android Studio diferente. Para ello, debes configurar tu proyecto manualmente y, luego, agregar el mapa.

Paso 1: Configura Android Studio

En este documento, se describe un entorno de desarrollo que utiliza Android Studio Hedgehog y el complemento de Android para Gradle versión 8.2.

Paso 2: Configura el SDK

La biblioteca del SDK de Maps para Android está disponible a través del repositorio de Maven de Google. Para agregar el SDK a tu app, haz lo siguiente:

  1. En el archivo settings.gradle de nivel superior, incluye el portal de complementos de Gradle, el repositorio de Maven de Google y el repositorio central de Maven debajo del bloque pluginManagement. El bloque pluginManagement debe aparecer antes que cualquier otra sentencia en la secuencia de comandos.
    pluginManagement {
        repositories {
            gradlePluginPortal()
            google()
            mavenCentral()
        }
    } 
  2. En el archivo settings.gradle de nivel superior, incluye el repositorio de Maven de Google y el repositorio central de Maven debajo del bloque dependencyResolutionManagement:
    dependencyResolutionManagement {
        repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
        repositories {
            google()
            mavenCentral()
        }
    } 
  3. En el archivo build.gradle a nivel del módulo, agrega la dependencia de Servicios de Google Play para el SDK de Maps para Android.

    Groovy

    dependencies {
    
        // Maps SDK for Android
        implementation 'com.google.android.gms:play-services-maps:18.2.0'
    }

    Kotlin

    dependencies {
    
        // Maps SDK for Android
        implementation("com.google.android.gms:play-services-maps:18.2.0")
    }
  4. En tu archivo build.gradle a nivel del módulo, configura compileSdk y minSdk con los siguientes valores:

    Groovy

    android {
        compileSdk 34
    
        defaultConfig {
            minSdk 19
            // ...
        }
    }

    Kotlin

    android {
        compileSdk = 34
    
        defaultConfig {
            minSdk = 19
            // ...
        }
    }
  5. En la sección buildFeatures de tu archivo build.gradle a nivel del módulo, agrega la clase BuildConfig para acceder a valores de metadatos definidos más adelante en este procedimiento:

    Groovy

    android {
      // ...
      buildFeatures {
        buildConfig true
        // ...
      }
    }

    Kotlin

    android {
      // ...
      buildFeatures {
        buildConfig = true
        // ...
      }
    }

Paso 3: Agrega tu clave de API al proyecto

En esta sección, se describe cómo almacenar tu clave de API para que tu app pueda hacer referencia a ella de manera 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 Maps 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.*"
    }
            

Paso 4: Actualiza el manifiesto de la app

En esta sección, se explica qué parámetros de configuración debes agregar al archivo AndroidManifest.xml.

Número de versión de Servicios de Google Play

Agrega la siguiente declaración en el elemento application. Esto incorporará la versión de Servicios de Google Play con la que se compiló la app.

<meta-data
    android:name="com.google.android.gms.version"
    android:value="@integer/google_play_services_version" />

Permiso de ubicación

Si tu app necesita acceder a la ubicación del usuario, debes solicitar el permiso de ubicación en el archivo AndroidManifest.xml. Las opciones son ACCESS_FINE_LOCATION, que proporciona la ubicación exacta del dispositivo, y ACCESS_COARSE_LOCATION, que es menos precisa. Para obtener más detalles, consulta la guía Datos de ubicación.

Para solicitar el permiso ACCESS_FINE_LOCATION, agrega este código al elemento manifest:

<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION"/>

Permiso de almacenamiento externo

Si planeas utilizar la versión 8.3 o una posterior del SDK de Servicios de Google Play, no necesitas el permiso WRITE_EXTERNAL_STORAGE. Si planeas usar versiones anteriores del SDK de Servicios de Google Play, debes solicitar el permiso WRITE_EXTERNAL_STORAGE en el elemento manifest.

<uses-permission
        android:name="android.permission.WRITE_EXTERNAL_STORAGE" />

Biblioteca Apache HTTP Legacy

Si utilizas com.google.android.gms:play-services-maps:16.0.0 o versiones anteriores, y tu app tiene como objetivo el nivel de API 28 (Android 9.0) o uno posterior, debes incluir la siguiente declaración en el elemento <application> del archivo AndroidManifest.xml. De lo contrario, omite esta declaración.

<uses-library
    android:name="org.apache.http.legacy"
    android:required="false" />

Paso 5: Configura un dispositivo Android

Para ejecutar una app que usa el SDK de Maps para Android, debes implementarla en un dispositivo Android o en un emulador de Android que se base en Android 4.0 o posterior y que incluya las APIs de Google.

  • Si deseas usar un dispositivo Android, sigue las instrucciones que se indican en Cómo ejecutar apps en un dispositivo de hardware.
  • Para usar un emulador de Android, puedes crear un dispositivo virtual y, luego, instalar el emulador usando el Administrador de dispositivos virtuales de Android (AVD) incluido con Android Studio.

Paso 6: Opcionalmente, verifica la compatibilidad de los Servicios de Play

El SDK de Maps para Android requiere que el dispositivo en el que implementas tu aplicación tenga los Servicios de Google Play instalados. Google ofrece un método al que puedes llamar desde tu app para verificar esto. Para obtener más información, consulta Verifica si los Servicios de Google Play están instalados.

Próximos pasos

Una vez que tu proyecto esté configurado, podrás agregar un mapa.