Configuración

En esta página, se describe lo que debes hacer para comenzar a compilar con el SDK de Maps 3D para Android. El proceso de configuración implica configurar un proyecto y una API de Google Cloud para usarlos con el SDK y, luego, configurar un proyecto de Android Studio. Completa estos pasos antes de agregar tu primer mapa en 3D a tu app.

Configura un proyecto de Google Cloud y una clave de API

Antes de comenzar a compilar con el SDK de Maps 3D para Android, debes configurar un proyecto de Google Cloud y una clave de API para usar con el SDK de Maps 3D para Android. Para ello, completa los siguientes pasos:

Paso 1

Console

  1. En la consola de Google Cloud, en la página del selector de proyectos, haz clic en Crear proyecto para comenzar a crear un proyecto de Cloud nuevo.

    Ir a la página del selector de proyectos

  2. Asegúrate de que la facturación esté habilitada para tu proyecto de Cloud. Confirma que la facturación esté habilitada para tu proyecto.

    Google Cloud ofrece una prueba con un cargo de USD 0.00. La prueba vence al final de un plazo de 90 días, o bien después de que la cuenta acumule USD 300 en cargos, lo que ocurra primero. Puedes cancelar la prueba en cualquier momento. Para obtener más información, consulta Créditos de la cuenta de facturación y Facturación.

SDK de Cloud

gcloud projects create "PROJECT"

Obtén más información sobre el SDK de Google Cloud, la instalación del SDK de Cloud y los siguientes comandos:

Paso 2

Para usar Google Maps Platform, debes habilitar las APIs o los SDKs que planeas usar con tu proyecto.

Ten en cuenta que algunas integraciones requieren que habilites varias APIs o SDKs. Si no sabes qué API o SDK habilitar, prueba usar el selector de API o consulta la documentación de la API o el SDK que quieres usar.

Para habilitar una o más APIs o SDKs, sigue estos pasos:

Console

  1. En la página Biblioteca de la API de Google Maps en la consola de Cloud, consulta las APIs y los SDKs de Google Maps Platform que puedes habilitar:

    Ve a la página Biblioteca de la API de Google Maps

  2. Haz clic en la API o el SDK que deseas habilitar.
    • Si el botón dice HABILITAR, haz clic en él para habilitar la API o el SDK.
    • Si el botón dice ADMINISTRAR, la API o el SDK ya están habilitados y no necesitas hacer nada más.
    • Si haces clic en cualquiera de los botones, se mostrará el panel de la API o el SDK. (Haz clic en el botón INHABILITAR para quitar la API o el SDK de este proyecto).

SDK de Cloud

El siguiente comando habilita todas las APIs de Maps, Routes y Places:

gcloud services enable \
    --project "PROJECT" \
    "addressvalidation.googleapis.com" \
    "areainsights.googleapis.com" \
    "tile.googleapis.com" \
    "aerialview.googleapis.com" \
    "elevation-backend.googleapis.com" \
    "routes.googleapis.com" \
    "geocoding-backend.googleapis.com" \
    "geolocation.googleapis.com" \
    "maps-android-backend.googleapis.com" \
    "maps-backend.googleapis.com" \
    "maps-embed-backend.googleapis.com" \
    "maps-ios-backend.googleapis.com" \
    "mapsplatformdatasets.googleapis.com" \
    "places-backend.googleapis.com" \
    "roads.googleapis.com" \
    "routeoptimization.googleapis.com" \
    "static-maps-backend.googleapis.com" \
    "street-view-image-backend.googleapis.com" \
    "timezone-backend.googleapis.com"

Obtén más información sobre el SDK de Google Cloud, la instalación del SDK de Cloud y los siguientes comandos:

Usa este comando para habilitar las APIs de Environment:

gcloud services enable \
    --project "PROJECT" \
    "airquality.googleapis.com" \
    "solar.googleapis.com" \
    "pollen.googleapis.com" \
    "weather.googleapis.com"

Paso 3

En este paso, solo se realiza el proceso de creación de la clave de API. Si usas la clave de API en producción, te recomendamos que la restrinjas. Puedes encontrar más información en la página Usar claves de API específica del producto.

La clave de API es un identificador único que se utiliza para autenticar solicitudes asociadas a tu proyecto con fines de uso y facturación. Debes tener, al menos, una clave de API asociada a tu proyecto.

Para crear una clave de API, sigue estos pasos:

Consola

  1. Ve a la página Google Maps Platform > Credenciales.

    Ir a la página Credenciales

  2. En la página Credenciales, haz clic en Crear credenciales > Clave de API.
    El diálogo Se creó la clave de API mostrará la clave de API que acabas de crear.
  3. Haz clic en Cerrar.
    La nueva clave de API aparecerá en la página Credenciales debajo de Claves de API.
    (Recuerda restringir la clave de API antes de utilizarla en producción).

SDK de Cloud

gcloud services api-keys create \
    --project "PROJECT" \
    --display-name "DISPLAY_NAME"

Obtén más información sobre el SDK de Google Cloud, la instalación del SDK de Cloud y los siguientes comandos:

Para habilitar el SDK, consulta la página del SDK de Maps 3D para Android en la consola de Google Cloud. Para obtener más información sobre cómo completar estos pasos, consulta Cómo comenzar a utilizar Google Maps Platform.

Cómo configurar un proyecto de Android Studio

En esta sección, se explica cómo crear y configurar un proyecto de Android Studio para usarlo con el SDK de Maps 3D para Android.

Parte 1: Configura tu proyecto y la configuración de Gradle

  1. Crea un proyecto nuevo de Android Studio con la plantilla Empty Views Activity.

  2. Si usas Git para el control de código fuente, modifica el archivo .gitignore del proyecto para evitar que se confirme tu archivo de secretos en el control de versiones:

    • En el directorio raíz de tu proyecto, abre el archivo .gitignore.
    • Agrega la siguiente línea:
    secrets.properties
    
  3. Actualiza el archivo build.gradle.kts a nivel del proyecto:

    • En el directorio raíz de tu proyecto, abre el archivo build.gradle.kts.
    • En el bloque plugins, agrega el complemento Secrets Gradle:
    plugins {
      alias(libs.plugins.android.application) apply false
      alias(libs.plugins.kotlin.android) apply false
      alias(libs.plugins.secrets.gradle.plugin) apply false // Add this line
    }
    
  4. Actualiza el archivo gradle/libs.versions.toml: - Abre el archivo gradle/libs.versions.toml, que suele estar ubicado en el directorio gradle dentro del directorio raíz del proyecto. - En la sección de versiones, agrega las versiones del SDK y del complemento de Secrets de Gradle:

    maps3dSdk = "0.0.1" # Update this value to match the SDK version to include
    secretsGradlePlugin = "2.0.1"
    
    -   In the library section, add the SDK library:
    
    play-services-maps3d = { module = "com.google.android.gms:play-services-maps3d", version.ref = "maps3dSdk" }
    
    -   In the plugin section, add the Secrets Gradle plugin:
    
    secrets-gradle-plugin = { id = "com.google.android.libraries.mapsplatform.secrets-gradle-plugin", version.ref = "secretsGradlePlugin" }
    
  5. Actualiza el archivo app/build.gradle.kts a nivel del módulo: - Abre el archivo build.gradle.kts a nivel del módulo, que suele encontrarse dentro del directorio app. - En la parte superior del archivo, agrega el complemento Secrets Gradle al bloque plugins:

    plugins {
      alias(libs.plugins.android.application)
      alias(libs.plugins.kotlin.android)
      alias(libs.plugins.secrets.gradle.plugin) // Add this line
    }
    
    -   In the `dependencies` block, add the SDK:
    
    dependencies {
      // ... other dependencies
      implementation(libs.play.services.maps3d) // Add this line
    }
    
    -   At the end of the file, outside of the `android` and `dependencies`
        blocks, add the secrets configuration:
    
    secrets {
      // Optionally specify a different filename 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"
    }
    

Parte 2: Agrega tu clave de API a tu proyecto

  1. Crea un archivo secrets.properties:

    • En el directorio raíz del módulo de la app (generalmente, el directorio app), crea un archivo nuevo llamado secrets.properties.
    • Agrega tu clave de API al archivo:
    MAPS3D_API_KEY=YOUR_API_KEY_HERE
    ``` Note: Make sure you
        replace `YOUR_API_KEY_HERE` with the API key that you configured for use
    with the Maps 3D SDK for Android.
    
  2. Crea un archivo local.defaults.properties: - En el directorio raíz del módulo de la app, crea un archivo nuevo llamado secrets.properties. - Agrega una clave de API predeterminada o de marcador de posición al archivo. Este archivo se puede registrar en el control de versiones:

    MAPS3D_API_KEY=DEFAULT_API_KEY_OR_PLACEHOLDER
    

Parte 3: Actualiza tu archivo AndroidManifest.xml

  1. Abre el archivo app/src/main/AndroidManifest.xml.

  2. Dentro de la etiqueta <application>, antes de la etiqueta <activity>, agrega el siguiente elemento <meta-data> para declarar tu clave de API:

    <application
      ...>
    
      <meta-data
          android:name="com.google.android.geo.maps3d.API_KEY"
          android:value="${MAPS3D_API_KEY}" />
    
      <activity
          ...>
      </activity>
    </application>
    

    Durante el proceso de compilación, el complemento Secrets Gradle reemplazará el marcador de posición ${MAPS3D_API_KEY} por la clave de tu archivo secrets.properties.

Próximos pasos

Ahora que tienes un proyecto de Google Cloud, una clave de API y un proyecto de Android Studio configurados para usar el SDK de Maps 3D para Android, puedes agregar un mapa en 3D a tu app.