Configura un proyecto de Android Studio

Si deseas configurar tu app a fin de usar el SDK de Places para Android, sigue estos pasos. Se requieren para todas las aplicaciones que utilizan el SDK de Places para Android.

Paso 1: Configura Android Studio

  1. Se requiere Android Studio Arctic Fox o una versión posterior. Si aún no lo tienes, descárgalo y, luego, instálalo.
  2. Verifica que estés utilizando la versión 7.0 o posterior del complemento de Android para Gradle en Android Studio.

Paso 2. Configura el SDK

La biblioteca de Places SDK for Android está disponible a través del repositorio 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 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 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 la sección dependencies de tu archivo build.gradle de nivel de módulo, agrega una dependencia al SDK de Places para Android:

    dependencies {
        implementation 'com.google.android.libraries.places:places:3.1.0'
    }
    
  4. En el archivo build.gradle a nivel del módulo, configura compileSdk y minSdk en los siguientes valores:
    android {
        compileSdk 31
    
        defaultConfig {
            minSdk 21
            // ...
        }

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 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 local.properties, que se encuentra en el directorio raíz de tu proyecto. Para obtener más información sobre el archivo local.properties, consulta los archivos de propiedades de Gradle.

A fin de optimizar esta tarea, te recomendamos usar el complemento Secrets Gradle para Android. Para instalar el complemento y almacenar tu clave de API, haz lo siguiente:

  1. En Android Studio, abre el archivo build.gradle a nivel del proyecto y agrega el siguiente código al elemento dependencies en buildscript.
    plugins {
        // ...
        id 'com.google.android.libraries.mapsplatform.secrets-gradle-plugin' version '2.0.1' apply false
    }
  2. A continuación, abre el archivo build.gradle a nivel del módulo y agrega el siguiente código al elemento plugins.
    id 'com.google.android.libraries.mapsplatform.secrets-gradle-plugin'
        
  3. Guarda el archivo y sincroniza tu proyecto con Gradle.
  4. Abre el archivo local.properties en el directorio de nivel de proyecto y, luego, agrega el siguiente código. Reemplaza YOUR_API_KEY por tu clave de API.
    MAPS_API_KEY=YOUR_API_KEY
        
  5. Guarda el archivo.
  6. En tu archivo AndroidManifest.xml, ve a com.google.android.geo.API_KEY y actualiza el android:value attribute de la siguiente manera:
    <meta-data
        android:name="com.google.android.geo.API_KEY"
        android:value="${MAPS_API_KEY}" />
        

Nota: Como se mostró anteriormente, com.google.android.geo.API_KEY es el nombre de metadatos recomendado para la clave de API. Se puede utilizar una clave con este nombre a fin de autenticar varias API basadas en Google Maps en la plataforma de Android, incluido el SDK de Places para Android. Respecto de la retrocompatibilidad, la API también admite el nombre com.google.android.maps.v2.API_KEY. Este nombre heredado solo permite la autenticación de la versión 2 de la API de Google Maps para Android. Una aplicación puede especificar solo uno de los nombres de metadatos de la clave de API. Si se especifican ambos, la API arrojará una excepción.

Paso 4: Inicializa el cliente de la API de Places

Inicializa el SDK de Places para Android dentro de una actividad o un fragmento, como se muestra en el siguiente ejemplo (ten en cuenta que pasas la clave de API cuando llamas a Places.initialize()):

Java


    // Initialize the SDK
    Places.initialize(getApplicationContext(), apiKey);

    // Create a new PlacesClient instance
    PlacesClient placesClient = Places.createClient(this);

      

Kotlin


    // Initialize the SDK
    Places.initialize(applicationContext, apiKey)

    // Create a new PlacesClient instance
    val placesClient = Places.createClient(this)

      

Ya estás listo para comenzar a usar el SDK de Places para Android.

Paso 5: Configura un dispositivo Android

Para ejecutar una app que usa el SDK de Places para Android, debes implementarla en un dispositivo Android o en un emulador de Android basado en Android 4.0 o versiones posteriores que incluya las API 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 Android Emulator, puedes crear un dispositivo virtual y, luego, instalar el emulador mediante el Administrador de dispositivos virtuales de Android (AVD) incluido con Android Studio.

Próximos pasos

Después de configurar tu proyecto, puedes explorar las apps de muestra.