Criar o projeto

Este guia lista os requisitos de configuração do build para usar o SDK do Navigation para Android versão 5.0.0 e mais recentes.

As instruções pressupõem que você tenha um ambiente de desenvolvimento integrado do Android instalado e esteja familiarizado com o desenvolvimento nesse sistema operacional.

Requisitos mínimos para usar o SDK do Navigation

Estes requisitos se aplicam ao SDK do Navigation para Android versão 5.0.0 e mais recentes.

• Um projeto do Console do Google Cloud com o SDK de navegação ativado. Para provisionar, fale com seu representante da Plataforma Google Maps.

• Seu app precisa especificar as versões do Android da seguinte maneira:

  • A versão de destino precisa ser o Android 13 (nível 33 da API) ou mais recente.
  • A versão mínima precisa ser o Android 6 (nível 23 da API) ou mais recente.

• Para executar um app criado com o SDK do Navigation, o dispositivo Android precisa atender aos seguintes requisitos:

  • Google Play Services instalado e ativado.

  • Pelo menos 2 GB de RAM

  • Compatibilidade com OpenGL ES 2.0. Consulte a documentação de compatibilidade do Android Open Source com o Android 6.0 para saber mais sobre Aceleração de gráficos 2D e 3D.

• Atribuições e texto de licenciamento precisam ser adicionados ao app.

Configurar seus projetos: projeto do Console do Cloud e projeto Android

Antes de criar ou testar um app, você precisa criar um projeto do Console do Cloud e adicionar credenciais de chave de API. O projeto precisa ter provisionamento para acessar o SDK do Navigation. Todas as chaves no projeto do Console do Cloud recebem o mesmo acesso ao SDK do Navigation. Uma chave pode ter mais de um projeto de desenvolvimento associado a ela. Se você já tiver um projeto no console, poderá adicionar uma chave ao seu projeto atual.

Para configurar

1. No navegador da Web de sua preferência, faça login no Console do Cloud e crie seu projeto do Console do Cloud.
2. No seu IDE, como o Android Studio, crie um projeto de desenvolvimento de apps Android e anote o nome do pacote.
3. Entre em contato com seu representante da Plataforma Google Maps para conceder acesso ao SDK do Navigation para seu projeto do console do Cloud.
4. No painel do Console do Cloud no navegador da Web, crie credenciais para gerar uma chave de API com restrições.
5. Na página da chave de API, clique em "Apps Android" na área Restrições do aplicativo.
6. Clique em Adicionar o nome do pacote e a impressão digital e insira o nome do pacote do seu projeto de desenvolvimento e a impressão digital SHA-1 para essa chave.
7. Clique em Salvar.

Adicionar o SDK do Navigation ao seu projeto

O SDK do Navigation está disponível no Maven. Depois de criar seu projeto de desenvolvimento, é possível integrar o SDK a ele usando uma das abordagens a seguir.

Como usar o Maven para o SDK do Navigation v4.5 e versões mais recentes (recomendado)

O exemplo a seguir usa o repositório Maven google(), que é a maneira mais simples e recomendada de adicionar o SDK do Navigation ao seu projeto.

1. Adicione a seguinte dependência à configuração do Gradle ou do Maven, substituindo o marcador VERSION_NUMBER pela versão desejada do SDK do Navigation para Android.

   Gradle

   Adicione o seguinte ao seu build.gradle no módulo:

   dependencies {
   ...
   implementation 'com.google.android.libraries.navigation:navigation:VERSION_NUMBER'
   }
   

   Se estiver fazendo upgrade do repositório Maven original, observe que os nomes dos grupos e artefatos foram alterados, e o plug-in com.google.cloud.artifactregistry.gradle-plugin não é mais necessário.

   E adicione o seguinte ao seu build.gradle de nível superior:

   allprojects {
   ...
   // Required: you must exclude the Google Play service Maps SDK from
   // your transitive dependencies. This is to ensure there won't be
   // multiple copies of Google Maps SDK in your binary, as the Navigation
   // SDK already bundles the Google Maps SDK.
   configurations {
           implementation {
               exclude group: 'com.google.android.gms', module: 'play-services-maps'
           }
   }
   }
   

   Maven

   Adicione o seguinte ao seu pom.xml:

   <dependencies>
     ...
     <dependency>
       <groupId>com.google.android.libraries.navigation</groupId>
       <artifactId>navigation</artifactId>
       <version>VERSION_NUMBER</version>
     </dependency>
   </dependencies>
   

   Se você tiver alguma dependência que use o SDK do Maps, será necessário excluí-la em cada dependência declarada que depende dele.

   <dependencies>
     <dependency>
     <groupId>project.that.brings.in.maps</groupId>
     <artifactId>MapsConsumer</artifactId>
     <version>1.0</version>
       <exclusions>
         <!-- Navigation SDK already bundles Maps SDK. You must exclude it to prevent duplication-->
         <exclusion>  <!-- declare the exclusion here -->
           <groupId>com.google.android.gms</groupId>
           <artifactId>play-services-maps</artifactId>
         </exclusion>
       </exclusions>
     </dependency>
   </dependencies>
   

Configure o build

Depois de criar o projeto, você pode definir as configurações para um build e uso bem-sucedidos do SDK do Navigation.

Atualizar propriedades locais

• Na pasta "Gradle Scripts", abra o arquivo local.properties e adicione android.useDeprecatedNdk=true.

Atualizar o script de build do Gradle

• Abra o arquivo build.gradle (Module:app) e use as diretrizes abaixo para atualizar as configurações e atender aos requisitos do SDK do Navigation. Considere também definir as opções de otimização.

  Configurações necessárias para o SDK do Navigation

  1. Defina minSdkVersion como 23 ou maior.
  2. Defina targetSdkVersion como 33 ou maior.
  3. Adicione uma configuração dexOptions que aumente a javaMaxHeapSize.
  4. Defina o local das bibliotecas adicionais.
  5. Adicione repositories e dependencies ao SDK do Navigation.
  6. Substitua os números de versão nas dependências pelas versões mais recentes disponíveis.

  Configurações opcionais para diminuir o tempo de build

  • Ative a redução de código e de recursos (link em inglês) usando o R8/ProGuard para remover recursos e códigos não utilizados das dependências. Se a etapa do R8/ProGuard demorar muito para ser executada, ative o multidex para o trabalho de desenvolvimento.
  • Reduza o número de traduções de idiomas incluídas no build: defina resConfigs para um idioma durante o desenvolvimento. Para o build final, defina resConfigs para as linguagens que você realmente usa. Por padrão, o Gradle inclui strings de recursos para todos os idiomas com suporte no SDK do Navigation.

  Adicionar a simplificação de leitura para oferecer suporte a Java8

  • Se você está criando seu app usando o Plug-in do Android para Gradle 4.0.0 ou mais recente, o plug-in estende o suporte ao uso de várias APIs da linguagem Java 8. Consulte Suporte à simplificação do Java 8 para mais informações. Confira o snippet de exemplo de script de build abaixo para saber como as opções de compilação e dependência são disponíveis.

Confira abaixo um exemplo do script de build do Gradle para o app. Verifique os apps de exemplo para ver conjuntos atualizados de dependências, porque a versão do SDK do Navigation que você está usando pode estar um pouco à frente ou para trás nesta documentação.

apply plugin: 'com.android.application'

ext {
    navSdk = "__NAVSDK_VERSION__"
}

android {
    compileSdk 33
    buildToolsVersion='28.0.3'

    defaultConfig {
        applicationId "<your id>"
        // Navigation SDK supports SDK 23 and later.
        minSdkVersion 23
        targetSdkVersion 33
        versionCode 1
        versionName "1.0"
        // Set this to the languages you actually use, otherwise you'll include resource strings
        // for all languages supported by the Navigation SDK.
        resConfigs "en"
        multiDexEnabled true
    }

    dexOptions {
        // This increases the amount of memory available to the dexer. This is required to build
        // apps using the Navigation SDK.
        javaMaxHeapSize "4g"
    }
    buildTypes {
        // Run ProGuard. Note that the Navigation SDK includes its own ProGuard configuration.
        // The configuration is included transitively by depending on the Navigation SDK.
        // If the ProGuard step takes too long, consider enabling multidex for development work
        // instead.
        all {
            minifyEnabled true
            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
        }
    }
    compileOptions {
        // Flag to enable support for the new language APIs
        coreLibraryDesugaringEnabled true
        // Sets Java compatibility to Java 8
        sourceCompatibility JavaVersion.VERSION_1_8
        targetCompatibility JavaVersion.VERSION_1_8
    }
}

repositories {
    // Navigation SDK for Android and other libraries are hosted on Google's Maven repository.
    google()
}

dependencies {
    // Include the Google Navigation SDK.
    // Note: remember to exclude Google play service Maps SDK from your transitive
    // dependencies to avoid duplicate copies of the Google Maps SDK.
    api "com.google.android.libraries.navigation:navigation:${navSdk}"

    // Declare other dependencies for your app here.

    annotationProcessor "androidx.annotation:annotation:1.7.0"
    coreLibraryDesugaring 'com.android.tools:desugar_jdk_libs:1.1.9'
}

Adicionar a chave de API ao seu app

Nesta seção, descrevemos como armazenar sua chave de API para que ela possa ser referenciada com segurança pelo seu app. Não faça a verificação dela no sistema de controle de versões. Recomendamos armazenar no arquivo secrets.properties, que fica no diretório raiz do projeto. Para saber mais sobre o arquivo secrets.properties, consulte Arquivos de propriedades do Gradle.

Se quiser otimizar essa tarefa, use o plug-in Secrets Gradle para Android.

Para instalar esse plug-in no seu projeto do Google Maps:

1. No Android Studio, abra o arquivo de nível superior build.gradle ou build.gradle.kts e adicione o seguinte código ao elemento dependencies em 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. Depois, abra o arquivo build.gradle no nível do módulo e adicione o seguinte código ao elemento plugins.

   Groovy

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

   Kotlin

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

3. No arquivo build.gradle no nível do módulo, defina targetSdk e compileSdk como 34.
4. Salve o arquivo e sincronize seu projeto com o Gradle.
5. Abra o arquivo secrets.properties no seu diretório de nível superior e adicione o código a seguir. Substitua YOUR_API_KEY pela sua chave de API. Armazene sua chave nesse arquivo porque secrets.properties não é verificado em um sistema de controle de versões.

   MAPS_API_KEY=YOUR_API_KEY

6. Salve o arquivo.

7. Crie o arquivo local.defaults.properties no seu diretório de nível superior, na mesma pasta que o arquivo secrets.properties, e depois adicione o seguinte código.

   MAPS_API_KEY=DEFAULT_API_KEY

   O objetivo desse arquivo é oferecer um local de backup para a chave da API se o arquivo secrets.properties não for encontrado, para que os builds não apresentem falha. Isso pode acontecer se você clonar o app de um sistema de controle de versões que omite secrets.properties e ainda não tiver criado um arquivo secrets.properties localmente para fornecer sua chave de API.

8. Salve o arquivo.
9. No seu arquivo AndroidManifest.xml, vá até com.google.android.geo.API_KEY e atualize android:value attribute. Se a tag <meta-data> não existe, crie-a como um elemento filho da tag <application>.

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

   Note: com.google.android.geo.API_KEY is the recommended metadata name for the API key. A key with this name can be used to authenticate to multiple Google Maps-based APIs on the Android platform, including the Navigation SDK for Android. For backwards compatibility, the API also supports the name com.google.android.maps.v2.API_KEY. This legacy name allows authentication to the Android Maps API v2 only. An application can specify only one of the API key metadata names. If both are specified, the API throws an exception.

10. In Android Studio, open your module-level build.gradle or build.gradle.kts file and edit the secrets property. If the secrets property does not exist, add it.

    Edit the properties of the plugin to set propertiesFileName to secrets.properties, set defaultPropertiesFileName to local.defaults.properties, and set any other properties.

    Groovy

    secrets {
        // Optionally specify a different file name 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"
    
        // Configure which keys should be ignored by the plugin by providing regular expressions.
        // "sdk.dir" is ignored by default.
        ignoreList.add("keyToIgnore") // Ignore the key "keyToIgnore"
        ignoreList.add("sdk.*")       // Ignore all keys matching the regexp "sdk.*"
    }
            

    Kotlin

    secrets {
        // Optionally specify a different file name 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"
    
        // Configure which keys should be ignored by the plugin by providing regular expressions.
        // "sdk.dir" is ignored by default.
        ignoreList.add("keyToIgnore") // Ignore the key "keyToIgnore"
        ignoreList.add("sdk.*")       // Ignore all keys matching the regexp "sdk.*"
    }
            

Incluir as atribuições necessárias no seu app

Se você usa o SDK do Navigation para Android no seu app, é necessário incluir texto de atribuição e licenças de código aberto como parte da seção de avisos legais do app.

O texto de atribuição e as licenças de código aberto necessários estão disponíveis no arquivo ZIP do SDK do Navigation para Android:

• NOTICE.txt
• LICENSES.txt