Configura un proyecto de Android Studio

AVISO: La versión 2.0.0 y las 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 de el 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 {
           google()
           mavenCentral()
           gradlePluginPortal()
       }
   } 

2. En el archivo settings.gradle.kts de nivel superior, incluye el repositorio de Maven de Google y el repositorio central de Maven debajo del bloque dependencyResolutionManagement:

   dependencyResolutionManagement {
       repositoriesMode.set(RepositoriesMode.PREFER_SETTINGS)
       repositories {
           google()
           mavenCentral()
       }
   } 

3. En la dependencies sección de tu build.gradle.ktsarchivo a nivel del módulo, agrega una dependencia al SDK de Places para Android:

   Nota: El SDK de Places para Android versión 3.5.0 requiere kotlin-bom 1.8.0 o versiones posteriores. 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:6.0.2")
   }

4. En tu archivo a nivel del módulo build.gradle.kts, 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 un archivo secrets.properties en el directorio raíz de tu proyecto y excluir ese archivo del control de versión. Para obtener más información sobre los archivos de propiedades de Gradle, consulta los archivos de propiedades de Gradle.

Para simplificar 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 tu archivo build.gradle.kts o build.gradle de nivel superior y agrega el siguiente código al bloque plugins.

   Kotlin

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

   Groovy

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

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.android.application")
       // ...
       id("com.google.android.libraries.mapsplatform.secrets-gradle-plugin")
   }

   Groovy

   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 secrets.properties en tu directorio de nivel superior, y agrega el siguiente código. Reemplaza YOUR_API_KEY por tu clave de API. Asegúrate de agregar secrets.properties a tu .gitignore archivo (o excluirlo de tu sistema de control de versión) para no registrar tu clave de API en el control de versión.
   Nota: Si el archivo secrets.properties no existe, créalo en la misma carpeta que el archivo local.properties.

   PLACES_API_KEY=YOUR_API_KEY

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

   Nota: Ingresa el código como se muestra. No reemplaces DEFAULT_API_KEY por tu clave de API.

   PLACES_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 para 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.

6. En Android Studio, abre el archivo a nivel del módulo build.gradle.kts o build.gradle y edita la propiedad secrets. Si la propiedad secrets no existe, agrégala.

   Edita las propiedades del complemento para establecer propertiesFileName en "secrets.properties", establecer defaultPropertiesFileName en "local.defaults.properties" y cualquier otra propiedad.

   Kotlin

   secrets {
       // To add your Maps API key to this project:
       // 1. If the secrets.properties file does not exist, create it in the root directory (the same folder as the root 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"
   }

   Groovy

   secrets {
       // To add your Maps API key to this project:
       // 1. If the secrets.properties file does not exist, create it in the root directory (the same folder as the root 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"
   }

Paso 4. Inicializa el cliente de 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 entornos de producción, te recomendamos que uses un mecanismo seguro para administrar las claves de API.

Ahora 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 Android Emulator que se base en Android 6.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 Android Emulator, puedes crear un dispositivo virtual y, luego, instalar el emulador usando el Administrador de dispositivos incluido con Android Studio.
  Nota: Si eliges usar un emulador de Android, asegúrate de elegir un perfil de 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

Una vez que tu proyecto esté configurado, podrás explorar las apps de ejemplo.