Configuração

Nesta página, descrevemos o que você precisa fazer para começar a criar com o SDK do Maps 3D para Android. O processo de configuração envolve a configuração de um projeto e uma API do Google Cloud para uso com o SDK e, em seguida, a configuração de um projeto do Android Studio. Conclua estas etapas antes de adicionar seu primeiro mapa 3D ao app.

Configurar um projeto do Google Cloud e uma chave de API

Antes de começar a criar com o SDK do Maps 3D para Android, configure um projeto do Google Cloud e uma chave de API para usar com o SDK do Maps 3D para Android. Para isso, siga estas etapas:

Etapa 1

Console

  1. No console do Google Cloud, na página do seletor de projetos, clique em Criar projeto para começar a criar um projeto do Cloud.

    Acessar a página do seletor de projetos

  2. Verifique se o faturamento está ativado para seu projeto do Cloud. Confirme se o faturamento está ativado no projeto.

    É possível testar o Google Cloud sem pagar nada. O teste expira em 90 dias ou quando a conta acumular US$ 300 em cobranças, o que ocorrer primeiro. É possível cancelar a qualquer momento. Para mais informações, consulte Créditos da conta de faturamento e Faturamento.

SDK do Cloud

gcloud projects create "PROJECT"

Saiba mais sobre o SDK Google Cloud, a instalação do SDK Cloud e os seguintes comandos:

Etapa 2

Para utilizar a Plataforma Google Maps, ative as APIs ou os SDKs que você planeja usar com seu projeto.

É preciso ativar vários SDKs/APIs para algumas integrações. Se você não souber quais APIs ou SDKs ativar, use o Seletor de APIs ou consulte a documentação do recurso que gostaria de utilizar.

Para ativar uma ou mais APIs ou SDKs, faça o seguinte:

Console

  1. Veja as APIs e os SDKs da Plataforma Google Maps que você pode habilitar acessando a página da Biblioteca de APIs Maps no console do Cloud:

    Acessar a página Biblioteca de APIs Maps

  2. Clique na API ou no SDK que você quer ativar.
    • Se houver um botão ATIVAR, clique nele.
    • Se houver um botão GERENCIAR, a API ou o SDK já está ativado e você não precisa fazer mais nada.
    • Quando você clica em um desses botões, o painel da API ou do SDK é exibido. Clique em DESATIVAR para remover a API ou o SDK do projeto.

SDK do Cloud

O comando a seguir ativa todas as APIs Maps, Routes e 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"

Saiba mais sobre o SDK Google Cloud, a instalação do SDK Cloud e os seguintes comandos:

Use este comando para ativar as APIs do ambiente:

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

Etapa 3

Essa etapa só passa pelo processo de criação da chave de API. Se você usa sua chave de API na produção, recomendamos restringi-la. Para mais informações, consulte a página Como usar chaves de API específica do produto.

A chave de API é um identificador exclusivo que autentica solicitações associadas ao seu projeto para fins de uso e faturamento. Você precisa ter pelo menos uma chave de API associada ao projeto.

Para criar uma chave de API, siga estas etapas:

Console

  1. Acesse a página Plataforma Google Maps > Credenciais.

    Acessar a página "Credenciais"

  2. Na página Credenciais, clique em Criar credenciais > Chave de API.
    A caixa de diálogo Chave de API criada exibirá sua chave recém-criada.
  3. Clique em Fechar.
    A nova chave vai aparecer na página Credenciais, em Chaves de API.
    Lembre-se de restringir a chave de API antes de usar na produção.

SDK Cloud

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

Saiba mais sobre o SDK Google Cloud, a instalação do SDK Cloud e os seguintes comandos:

Para ativar o SDK, consulte a página do SDK do Maps 3D para Android no console do Google Cloud. Para mais informações sobre como concluir essas etapas, consulte Começar a usar a Plataforma Google Maps.

Configurar um projeto do Android Studio

Esta seção explica como criar e configurar um projeto do Android Studio para uso com o SDK do Maps 3D para Android.

Parte 1: configurar o projeto e a configuração do Gradle

  1. Crie um projeto do Android Studio usando o modelo Empty Views Activity.

  2. Se você estiver usando o Git para controle de origem, modifique o arquivo .gitignore do projeto para evitar que o arquivo de secrets seja confirmado no controle de versões:

    • No diretório raiz do projeto, abra o arquivo .gitignore.
    • Adicione a linha abaixo:
    secrets.properties
    
  3. Atualize o arquivo build.gradle.kts no nível do projeto:

    • No diretório raiz do projeto, abra o arquivo build.gradle.kts.
    • No bloco plugins, adicione o plug-in 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. Atualize o arquivo gradle/libs.versions.toml: - Abra o arquivo gradle/libs.versions.toml, que geralmente está localizado no diretório gradle dentro do diretório raiz do projeto. - Na seção "Versões", adicione as versões do SDK e do plug-in do Gradle Secrets:

    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. Atualize o arquivo app/build.gradle.kts no nível do módulo: - Abra o arquivo build.gradle.kts no nível do módulo, que geralmente está localizado no diretório app. - Na parte de cima do arquivo, adicione o plug-in Secrets Gradle ao bloco 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: adicionar sua chave de API ao projeto

  1. Crie um arquivo secrets.properties:

    • No diretório raiz do módulo do app (geralmente o diretório app), crie um arquivo chamado secrets.properties.
    • Adicione a chave de API ao arquivo:
    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. Crie um arquivo local.defaults.properties: - No diretório raiz do módulo do app, crie um arquivo chamado secrets.properties. - Adicione uma chave de API padrão ou de marcador de posição ao arquivo. Esse arquivo pode ser verificado no controle de versões:

    MAPS3D_API_KEY=DEFAULT_API_KEY_OR_PLACEHOLDER
    

Parte 3: atualizar o arquivo AndroidManifest.xml

  1. Abra o arquivo app/src/main/AndroidManifest.xml.

  2. Dentro da tag <application>, antes da tag <activity>, adicione o seguinte elemento <meta-data> para declarar sua chave de API:

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

    Durante o processo de build, o plug-in de secrets do Gradle vai substituir o marcador de posição ${MAPS3D_API_KEY} pela chave do arquivo secrets.properties.

Próximas etapas

Agora que você tem um projeto do Google Cloud, uma chave de API e um projeto do Android Studio configurado para uso com o SDK do Maps 3D para Android, é possível adicionar um mapa 3D ao seu app.