Configurar seu projeto: versão 4.99 e anteriores

Este guia lista os requisitos de configuração do build para usar o SDK do Navigation para Android. As instruções presumem que você tenha um ambiente de desenvolvimento integrado do Android instalado e familiarizado com o desenvolvimento para Android.

Requisitos mínimos para usar o SDK do Navigation

Estes requisitos se aplicam ao SDK do Navigation para Android versão 4.99 e anteriores.

• Um projeto do Console do Google Cloud com o SDK do Navigation ativado. Para o provisionamento, pergunte ao seu representante da Plataforma Google Maps.

• O app precisa ser direcionado ao nível 30 da API ou mais recente.

• Para executar um app criado com o SDK do Navigation, é preciso usar o Android dispositivo precisa ter o Google Play Services instalado e ativado.

• Texto de atribuições e 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 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 ele. Se você já tem um projeto no console, é possível adicionar uma chave ao projeto atual.

Para configurar

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

Adicionar o SDK do Navigation ao seu projeto

O SDK do Navigation está disponível pelo Maven ou Pacote de AAR. Depois de criar seu projeto de desenvolvimento, você pode integrar o SDK a ele ao usando uma das abordagens a seguir.

Como usar o Maven para o SDK de navegação v4.5 e mais recentes (recomendado)

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

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

   Gradle

   Adicione o código abaixo ao build.gradle do módulo:

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

   Se você fizer upgrade do repositório Maven original, observe que o grupo e os nomes de artefatos mudaram, O plug-in com.google.cloud.artifactregistry.gradle-plugin não está mais disponível necessários.

   E adicione o seguinte à sua 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, exclua o em cada dependência declarada que depende do SDK do Maps.

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

Como usar o Maven para o SDK de navegação anterior à v4.5 ou com o SDK do Driver

O SDK do Navigation continua disponível pelo repositório Maven original ao restante das versões v4. Esta é a com as mesmas atualizações da versão acima e oferece compatibilidade com o SDK do Driver e outras bibliotecas durante a transição Usando essa dependência requer login no projeto na nuvem via gcloud quando compilação.

1. Configure seu ambiente para acessar o repositório Maven do Google, conforme descrito nas Pré-requisitos da documentação do SDK do consumidor. O O SDK do Navigation é controlado por um grupo de espaços de trabalho.

2. Adicione a seguinte dependência à sua configuração do Gradle ou Maven, substituindo " O marcador VERSION_NUMBER para a versão desejada do SDK do Navigation.

   Gradle

   Adicione o código abaixo ao build.gradle do módulo:

   dependencies {
     ...
     implementation 'com.google.android.maps:navsdk:VERSION_NUMBER'
   }
   

   E adicione o seguinte à sua 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.maps</groupId>
       <artifactId>navsdk</artifactId>
       <version>VERSION_NUMBER</version>
     </dependency>
   </dependencies>
   

   Se você tiver alguma dependência que use o SDK do Maps, exclua o em cada dependência declarada que depende do SDK do Maps.

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

Usar um pacote de AARs baixado (não recomendado)

O SDK do Navigation também está disponível como um pacote AAR. Depois de criar o projeto de desenvolvimento, será possível integrar o SDK. Essas instruções pressupõem o uso do Android Studio para o ambiente de desenvolvimento integrado.

1. Faça o download da versão mais recente do SDK do Navigation. do Google Drive compartilhado e descompacte-o. Se você não tiver acesso, entre em contato com seu representante.

2. No Android Studio, abra um projeto e Adicione o pacote Google Play Services. usando o SDK Manager.

3. No diretório do arquivo ZIP, copie libs/google_navigation_navmap.aar para no diretório app/libs do projeto.

4. Adicione o código abaixo ao build.gradle do módulo:

   implementation(name: 'google_navigation_navmap', ext: 'aar')
   

   E adicione o seguinte à sua 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'
           }
       }
   }
   

Configure o build

Depois de criar o projeto, você pode definir as configurações para uma 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 seguintes diretrizes para Atualize as configurações para atender aos requisitos do SDK do Navigation. e considere definir as opções de otimização.

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

  1. Defina minSdkVersion como 23 ou mais.
  2. Defina targetSdkVersion como 30 ou mais.
  3. Adicione uma configuração dexOptions para aumentar o javaMaxHeapSize.
  4. Defina o local de outras bibliotecas.
  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

  • Ativar de redução de código e de recursos usando o R8/ProGuard para remover código e recursos não utilizados das dependências. Se a execução da etapa do R8/ProGuard demorar muito tempo, ative multidex (link em inglês) para o trabalho de desenvolvimento.
  • Reduzir o número de idiomas traduzidos no build: definir resConfigs para uma linguagem durante o desenvolvimento. Para o build final, defina resConfigs para idiomas que você realmente usa. Por padrão, o Gradle inclui strings de recursos para todos os idiomas compatíveis com o SDK do Navigation.

Confira abaixo um exemplo do script de build do Gradle para o aplicativo. Consulte o aplicativos de exemplo para conjuntos atualizados de dependências, como a versão do O SDK do Navigation que você está usando pode estar um pouco adiantado ou por trás desta documentação.

apply plugin: 'com.android.application'
apply plugin: 'com.google.cloud.artifactregistry.gradle-plugin'

ext {
    androidxVersion = "1.0.0"
    lifecycle_version = "1.1.1"
}

android {
    compileSdkVersion 30
    buildToolsVersion '28.0.3'

    defaultConfig {
        applicationId "<your id>"
        // Navigation SDK supports SDK 23 and later.
        minSdkVersion 23
        targetSdkVersion 30
        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 {
        sourceCompatibility JavaVersion.VERSION_1_8
        targetCompatibility JavaVersion.VERSION_1_8
    }
}

// This tells Gradle where to look to find additional libraries - in this case, the
// google_navigation_navmap.aar file.
repositories {
    flatDir {
        dirs 'libs'
    }
    google()

    // Required for accessing the Navigation SDK on Google's Maven repository.
    maven {
        url "artifactregistry://us-west2-maven.pkg.dev/gmp-artifacts/transportation"
    }
}

dependencies {
    // Include the Google Navigation SDK
    implementation 'com.google.android.maps:navsdk:4.4.0'

    // The included AAR file under libs can be used instead of the Maven repository.
    // Uncomment the line below and comment out the previous dependency to use
    // the AAR file instead. Ensure that you add the AAR file to the libs directory.
    // implementation(name: 'google_navigation_navmap', ext: 'aar')

    // These dependencies are required for the Navigation SDK to function
    // properly at runtime.
    implementation 'org.chromium.net:cronet-fallback:69.3497.100'
    // Optional for Cronet users:
    // implementation 'org.chromium.net:cronet-api:69.3497.100'
    implementation 'androidx.appcompat:appcompat:${androidxVersion}'
    implementation 'androidx.cardview:cardview:${androidxVersion}'
    implementation 'com.google.android.material:material:${androidxVersion}'
    implementation 'androidx.mediarouter:mediarouter:${androidxVersion}'
    implementation 'androidx.preference:preference:${androidxVersion}'
    implementation 'androidx.recyclerview:recyclerview:${androidxVersion}'
    implementation 'androidx.legacy:legacy-support-v4:${androidxVersion}'
    implementation 'com.github.bumptech.glide:glide:4.9.0'
    implementation 'com.github.bumptech.glide:okhttp-integration:4.9.0'
    implementation 'android.arch.lifecycle:common-java8:$lifecycle_version'
    implementation 'com.android.support:multidex:1.0.3'
    implementation 'com.google.android.datatransport:transport-api:2.2.0'
    implementation 'com.google.android.datatransport:transport-backend-cct:2.2.0'
    implementation 'com.google.android.datatransport:transport-runtime:2.2.0'
    implementation 'joda-time:joda-time:2.9.9'
    annotationProcessor 'androidx.annotation:annotation:1.1.0'
    annotationProcessor 'com.github.bumptech.glide:compiler:4.9.0'
}

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.

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

   NAV_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 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 dos avisos legais do seu app nesta seção.

Encontre o texto de atribuição necessário e as licenças de código aberto na Arquivo ZIP do SDK do Navigation para Android:

• NOTICE.txt
• LICENSES.txt