Configura un proyecto de Android Studio

AVISO: La versión 2.0.0 y las versiones posteriores del SDK de Places para Android dependen de AndroidX. A partir de esta versión, ya no se admitirá la biblioteca de compatibilidad anterior. Para conservar la compatibilidad, debes migrar tus proyectos para usar AndroidX.

Para configurar tu app para que use el SDK de Places para Android, sigue estos pasos. Son obligatorios para todas las apps que usan el SDK de Places para Android.

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.

Nota: Si tu entorno de desarrollo emplea una versión diferente de Android Studio o Gradle, quizás debas modificar los pasos en función de esas versiones. Para obtener más información sobre las versiones de Android Studio y Gradle, consulta la Compatibilidad del complemento de Android para Gradle y Android Studio.

Paso 2: Configura el SDK

La biblioteca del SDK de Places 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.kts 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.kts 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.kts a nivel del módulo, agrega una dependencia al SDK de Places para Android:

   Nota: La versión 3.5.0 del SDK de Places para Android requiere kotlin-bom 1.8.0 o una versión posterior. Para obtener más información sobre la dependencia kotlin-bom, consulta Uso de la versión más reciente de kotlin-stdlib en dependencias transitivas.

   Groovy

   dependencies {
       implementation(platform("org.jetbrains.kotlin:kotlin-bom:$kotlin_version"))
       implementation("com.google.android.libraries.places:places:3.5.0")
   }

   Kotlin

             dependencies {
   
       // Places and Maps SDKs
       implementation("com.google.android.libraries.places:places:5.0.0")
   }

4. En tu archivo build.gradle.kts a nivel del módulo, configura compileSdk y minSdk con los siguientes valores:
   Nota: Asegúrate de que compileSdk se haya establecido en 34 o más, y minSdk, en 23 o más.

   Groovy

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

   Kotlin

   android {
       compileSdk = 34
   
       defaultConfig {
           minSdk = 23
           // ...
       }
   }

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.

Para instalar el complemento Secrets Gradle para Android y almacenar tu clave de API, haz lo siguiente:

1. En Android Studio, abre el archivo build.gradle de nivel raíz 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 de la app y agrega el siguiente código al elemento plugins.

   Groovy

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

   Kotlin

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

3. Si usas Android Studio, 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.

   PLACES_API_KEY=YOUR_API_KEY

Paso 4: Inicializa el cliente de la API de Places

Para inicializar el SDK de Places para Android dentro de una actividad o un fragmento, pasa la clave de API cuando llames a Places.initializeWithNewPlacesApiEnabled():

Kotlin

    // Define a variable to hold the Places API key.
    val apiKey = BuildConfig.PLACES_API_KEY

    // Log an error if apiKey is not set.
    if (apiKey.isEmpty() || apiKey == "DEFAULT_API_KEY") {
        Log.e("Places test", "No api key")
        finish()
        return
    }

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

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

Java

    // Define a variable to hold the Places API key.
    String apiKey = BuildConfig.PLACES_API_KEY;

    // Log an error if apiKey is not set.
    if (TextUtils.isEmpty(apiKey) || apiKey.equals("DEFAULT_API_KEY")) {
      Log.e("Places test", "No api key");
      finish();
      return;
    }

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

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

IMPORTANTE: Nunca agregues claves de API directamente al código de la aplicación. En los entornos de producción, te recomendamos usar un mecanismo seguro para administrar las claves de API.

Ya puedes 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 que se base en Android 5.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.
  Nota: Si eliges usar un emulador de Android, asegúrate de elegir un dispositivo que muestre el ícono de Play, , en la columna Play Store. Este ícono indica que estos perfiles satisfacen el CTS y pueden usar imágenes del sistema que incluyan la app de Play Store:

  

Próximos pasos

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