Se quiser configurar seu app para usar o SDK do Places para Android, siga estas etapas. Eles são necessários para todos os aplicativos que usam o SDK do Places para Android.
Etapa 1: configurar o Android Studio
- É preciso usar o Android Studio Arctic Fox ou versões mais recentes. Faça o download e instale o Android Studio, caso ainda não tenha feito isso.
- Verifique se você está usando o Plug-in do Android para Gradle versão 7.0 ou mais recente no Android Studio.
Etapa 2: configurar o SDK
A biblioteca do SDK do Places para Android está disponível no repositório Maven do Google. Para adicionar o SDK ao app, faça o seguinte:
- No arquivo
settings.gradle
de nível superior, inclua o portal do plug-in do Gradle, o repositório Maven do Google e o repositório Maven central no blocopluginManagement
. O blocopluginManagement
precisa aparecer antes de qualquer outra instrução no script.pluginManagement { repositories { gradlePluginPortal() google() mavenCentral() } }
- No arquivo
settings.gradle
de nível superior, inclua o repositório Maven do Google e o repositório Maven central (links em inglês) no blocodependencyResolutionManagement
:dependencyResolutionManagement { repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS) repositories { google() mavenCentral() } }
-
Na seção
dependencies
do arquivobuild.gradle
no módulo, adicione uma dependência ao SDK do Places para Android:dependencies { implementation 'com.google.android.libraries.places:places:3.3.0' }
- No arquivo
build.gradle
no nível do módulo, definacompileSdk
eminSdk
como os seguintes valores:android { compileSdk 31 defaultConfig { minSdk 21 // ... }
Etapa 3: adicionar sua chave de API ao projeto
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, faça o seguinte:
- No Android Studio, abra o arquivo
build.gradle
no nível do projeto e adicione o seguinte código ao elementodependencies
embuildscript
.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") } }
- Depois, abra o arquivo
build.gradle
no nível do módulo e adicione o seguinte código ao elementoplugins
.Groovy
plugins { // ... id 'com.google.android.libraries.mapsplatform.secrets-gradle-plugin' }
Kotlin
plugins { id("com.google.android.libraries.mapsplatform.secrets-gradle-plugin") }
- Salve o arquivo e sincronize seu projeto com o Gradle.
- Abra o
secrets.properties
no diretório do nível do projeto e adicione o seguinte código. SubstituaYOUR_API_KEY
pela sua chave de API.MAPS_API_KEY=YOUR_API_KEY
- Salve o arquivo.
- No seu arquivo
AndroidManifest.xml
, acessecom.google.android.geo.API_KEY
e atualizeandroid:value attribute
da seguinte maneira:<meta-data android:name="com.google.android.geo.API_KEY" android:value="${MAPS_API_KEY}" />
Se quiser, edite as propriedades do plug-in para especificar um arquivo diferente de segredos ou outras propriedades. No Android Studio, abra o arquivo
build.gradle
no nível do projeto e edite a propriedadesecrets
: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.*" }
Observação: conforme mostrado acima, com.google.android.geo.API_KEY
é o nome de metadados recomendado para a chave de API. Uma chave com esse nome pode ser usada para autenticar várias APIs do Google Maps na Plataforma Android, incluindo o SDK do Places para Android. Para garantir a compatibilidade com versões anteriores, a API também aceita o nome com.google.android.maps.v2.API_KEY
. Esse nome herdado permite autenticação apenas na API Android Maps v2. Um aplicativo pode especificar somente um dos nomes de metadados da chave de API. Se ambos forem especificados, a API vai gerar uma exceção.
Etapa 4. Inicializar o cliente da API Places
Inicializar o SDK do Places para Android em uma atividade ou um fragmento. Primeiro, você precisa decidir qual versão do SDK usar: o SDK do Places para Android ou o SDK do Places para Android (novo). Para mais informações sobre versões do produto, consulte Escolher a versão do SDK.
O exemplo a seguir mostra como inicializar o SDK para as duas versões.SDK do Places para Android (novo)
Transmita a chave de API ao chamar Places.initializeWithNewPlacesApiEnabled()
:
Kotlin
// Initialize the SDK Places.initializeWithNewPlacesApiEnabled(applicationContext, apiKey) // Create a new PlacesClient instance val placesClient = Places.createClient(this)
Java
// Initialize the SDK Places.initializeWithNewPlacesApiEnabled(getApplicationContext(), apiKey); // Create a new PlacesClient instance PlacesClient placesClient = Places.createClient(this);
SDK do Places para Android
Transmita a chave de API ao chamar Places.initialize()
:
Kotlin
// Initialize the SDK Places.initialize(applicationContext, apiKey) // Create a new PlacesClient instance val placesClient = Places.createClient(this)
Java
// Initialize the SDK Places.initialize(getApplicationContext(), apiKey); // Create a new PlacesClient instance PlacesClient placesClient = Places.createClient(this);
Agora você já pode começar a usar o SDK do Places para Android.
Etapa 5: configurar um dispositivo Android
Para executar um app que usa o SDK do Places para Android, faça a implantação dele em um dispositivo compatível ou Android Emulator com base no Android 4.0 ou uma versão mais recente que inclua as APIs do Google.
- Para usar um dispositivo Android, siga as instruções no artigo Executar apps em um dispositivo de hardware.
- Para usar o Android Emulator, crie um dispositivo virtual e instale o emulador usando o AVD Manager que acompanha o Android Studio.