Android Studio-Projekt einrichten

HINWEIS: Version 2.0.0 und höher des Places SDK for Android ist abhängig von AndroidX Ab dieser Version wird die alte Supportbibliothek nicht mehr unterstützt. Damit die Kompatibilität gewahrt bleibt, müssen Sie Ihre Projekte migrieren zu AndroidX verwenden.

So konfigurieren Sie Ihre App für die Verwendung des Places SDK for Android: Schritte. Sie sind für alle Apps erforderlich, die das Places SDK for Android verwenden.

Schritt 1: Android Studio einrichten

In diesem Dokument wird eine Entwicklungsumgebung mit Android Studio Hedgehog und Version 8.2 des Android-Gradle-Plug-ins beschrieben.

Hinweis: Wenn in Ihrer Entwicklungsumgebung eine andere Version von Android Studio oder Gradle verwendet wird, müssen Sie die Schritte möglicherweise entsprechend anpassen. Weitere Informationen zu Android Studio- und Gradle-Versionen sind im Abschnitt zur Kompatibilität zwischen Android-Gradle-Plug-in und Android Studio verfügbar.

Schritt 2: SDK einrichten

Die Places SDK for Android-Bibliothek ist über Maven-Repository von Google. So fügen Sie das SDK der App hinzu:

1. Fügen Sie in der Datei settings.gradle.kts auf oberster Ebene das Portal für Gradle-Plug-ins, das Maven-Repository von Google und das Maven Central Repository unter dem pluginManagement-Block ein. Der pluginManagement-Block muss vor allen anderen Anweisungen im Script eingefügt werden.

   pluginManagement {
       repositories {
           gradlePluginPortal()
           google()
           mavenCentral()
       }
   } 

2. Fügen Sie in der Datei settings.gradle.kts auf oberster Ebene das Maven-Repository von Google und das Maven Central Repository unter dem dependencyResolutionManagement-Block ein:

   dependencyResolutionManagement {
       repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
       repositories {
           google()
           mavenCentral()
       }
   } 

3. Im dependencies der Datei build.gradle auf Modulebene eine Abhängigkeit hinzu. auf das Places SDK for Android:

   Hinweis : Version des Places SDK for Android 3.5.0 erfordert kotlin-bom 1.8.0 oder höher. Für Weitere Informationen zur Abhängigkeit kotlin-bom finden Sie unter Verwendung der neuesten kotlin-stdlib-Version in transitiven Abhängigkeiten.

   Groovy

   dependencies {
       // If updating kotlin-bom version number above, also edit project-level build.gradle definition of $kotlin_version variable
       implementation(platform("org.jetbrains.kotlin:kotlin-bom:$kotlin_version"))
       implementation 'com.google.android.libraries.places:places:3.3.0'
   }

   Kotlin

   dependencies {
       implementation(platform("org.jetbrains.kotlin:kotlin-bom:$kotlin_version"))
       implementation("com.google.android.libraries.places:places:3.5.0")
   }

4. Legen Sie in der Datei build.gradle auf Modulebene compileSdk fest. und minSdk auf die folgenden Werte:
   Hinweis: Achten Sie darauf, dass compileSdk auf 34 oder höher eingestellt und minSdk auf „21“ oder höher eingestellt ist.

   Groovy

   android {
       compileSdk 34
   
       defaultConfig {
           minSdk 21
           // ...
       }
   }

   Kotlin

   android {
       compileSdk = 34
   
       defaultConfig {
           minSdk = 21
           // ...
       }
   }

5. Gehen Sie im Abschnitt buildFeatures der Datei build.gradle auf Modulebene so vor: Fügen Sie die Klasse BuildConfig hinzu, mit der Sie auf später definierte Metadatenwerte zugreifen in diesem Verfahren:

   Groovy

   android {
     // ...
     buildFeatures {
       buildConfig true
       // ...
     }
   }

   Kotlin

   android {
     // ...
     buildFeatures {
       buildConfig = true
       // ...
     }
   }

Schritt 3: API-Schlüssel zum Projekt hinzufügen

In diesem Abschnitt wird beschrieben, wie Sie Ihren API-Schlüssel speichern, damit er von Ihrer App sicherer referenziert werden kann. Er sollte nicht in Ihrem Versionsverwaltungssystem eingecheckt werden. Stattdessen empfehlen wir Ihnen, ihn im Stammverzeichnis Ihres Projekts in der Datei secrets.properties zu speichern. Weitere Informationen zur Datei secrets.properties finden Sie unter Gradle properties files.

Sie können das Secrets Gradle-Plug-in for Android verwenden, um diese Aufgabe zu optimieren.

Hinweis: Aktuelle Systemanforderungen und Installationsanleitungen finden Sie in der Dokumentation zum Secrets Gradle-Plug-in für Android auf GitHub.

So installieren Sie das Secrets Gradle-Plug-in für Android in Ihrem Google Maps-Projekt:

1. Öffnen Sie in Android Studio die Datei build.gradle.kts oder build.gradle auf oberster Ebene und fügen Sie den folgenden Code in das dependencies-Element unter buildscript ein.

   Kotlin

   buildscript {
       dependencies {
           classpath("com.google.android.libraries.mapsplatform.secrets-gradle-plugin:secrets-gradle-plugin:2.0.1")
       }
   }

   Groovy

   buildscript {
       dependencies {
           classpath "com.google.android.libraries.mapsplatform.secrets-gradle-plugin:secrets-gradle-plugin:2.0.1"
       }
   }
   

2. Öffnen Sie die Datei build.gradle.kts oder build.gradle auf Modulebene und fügen Sie den folgenden Code in das plugins-Element ein.

   Kotlin

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

   Groovy

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

3. Achten Sie in der Datei build.gradle.kts oder build.gradle auf Modulebene darauf, dass targetSdk und compileSdk sind festgelegt bis 34.
4. Speichern Sie die Datei und synchronisieren Sie Ihr Projekt mit Gradle.
5. Öffnen Sie die Datei secrets.properties im Verzeichnis der obersten Ebene und fügen Sie den folgenden Code ein. Ersetzen Sie dabei YOUR_API_KEY durch Ihren eigenen API-Schlüssel. Speichern Sie den Schlüssel in dieser Datei, da secrets.properties nicht in ein Versionsverwaltungssystem eingecheckt werden kann.
   Hinweis: Sollte die Datei secrets.properties nicht vorhanden sein, erstellen Sie sie im selben Ordner wie die Datei local.properties.

   PLACES_API_KEY=YOUR_API_KEY

6. Speichern Sie die Datei.

7. Erstellen Sie die Datei local.defaults.properties im Verzeichnis der obersten Ebene, im selben Ordner wie die Datei secrets.properties, und fügen Sie folgenden Code ein.

   Hinweis: Geben Sie den Code genau wie hier gezeigt ein. Ersetzen Sie DEFAULT_API_KEY nicht durch Ihren API-Schlüssel.

   PLACES_API_KEY=DEFAULT_API_KEY

   Diese Datei ist ein Ersatzspeicherort für den API-Schlüssel, damit Builds nicht fehlschlagen, falls die Datei secrets.properties nicht gefunden wird. Das kann passieren, wenn Sie die App aus einem Versionsverwaltungssystem klonen, in dem secrets.properties nicht vorhanden ist, und noch keine lokale Datei secrets.properties erstellt haben, um Ihren API-Schlüssel bereitzustellen.

8. Speichern Sie die Datei.

9. Öffnen Sie in Android Studio das build.gradle.kts auf Modulebene oder build.gradle-Datei und bearbeiten Sie das Attribut secrets. Wenn die Die Property secrets ist nicht vorhanden. Füge sie hinzu.

   Legen Sie in den Attributen des Plug-ins propertiesFileName fest: secrets.properties, defaultPropertiesFileName festlegen auf local.defaults.properties und legen Sie beliebige weitere Attribute fest.

   Kotlin

   secrets {
       // To add your Maps API key to this project:
       // 1. If the secrets.properties file does not exist, create it in the same folder as the local.properties file.
       // 2. Add this line, where YOUR_API_KEY is your API key:
       //        MAPS_API_KEY=YOUR_API_KEY
       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.*"
   }
           

   Groovy

   secrets {
       // To add your Maps API key to this project:
       // 1. If the secrets.properties file does not exist, create it in the same folder as the local.properties file.
       // 2. Add this line, where YOUR_API_KEY is your API key:
       //        MAPS_API_KEY=YOUR_API_KEY
       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.*"
   }
           

Schritt 4: Places API-Client initialisieren

Initialisieren Sie das Places SDK for Android innerhalb einer Aktivität oder eines Fragments. Sie müssen zuerst Entscheiden Sie, welche SDK-Version verwendet werden soll: Places SDK for Android oder Places SDK for Android (neu). Weitere Informationen zu Produktversionen Weitere Informationen finden Sie unter SDK-Version auswählen.

Das folgende Beispiel zeigt, wie das SDK für beide Versionen initialisiert wird.

Places SDK for Android (neu)

Übergeben Sie beim Aufruf den API-Schlüssel Places.initializeWithNewPlacesApiEnabled():

Kotlin

    // Define a variable to hold the Places API key.
    val apiKey = BuildConfig.PLACES_API_KEY

    // Log an error if apiKey is not set.
    if (apiKey.isEmpty() || apiKey == "DEFAULT_API_KEY") {
        Log.e("Places test", "No api key")
        finish()
        return
    }

    // Initialize the SDK
    Places.initializeWithNewPlacesApiEnabled(applicationContext, apiKey)

    // Create a new PlacesClient instance
    val placesClient = Places.createClient(this)
    

Java

    // Define a variable to hold the Places API key.
    String apiKey = BuildConfig.PLACES_API_KEY;

    // Log an error if apiKey is not set.
    if (TextUtils.isEmpty(apiKey) || apiKey.equals("DEFAULT_API_KEY")) {
      Log.e("Places test", "No api key");
      finish();
      return;
    }

    // Initialize the SDK
    Places.initializeWithNewPlacesApiEnabled(getApplicationContext(), apiKey);

    // Create a new PlacesClient instance
    PlacesClient placesClient = Places.createClient(this);
    

Places SDK for Android

Übergeben Sie beim Aufruf den API-Schlüssel Places.initialize():

Kotlin

    // Define a variable to hold the Places API key.
    val apiKey = BuildConfig.PLACES_API_KEY

    // Log an error if apiKey is not set.
    if (apiKey.isEmpty() || apiKey == "DEFAULT_API_KEY") {
        Log.e("Places test", "No api key")
        finish()
        return
    }

    // Initialize the SDK
    Places.initialize(applicationContext, apiKey)

    // Create a new PlacesClient instance
    val placesClient = Places.createClient(this)
    

Java

    // Define a variable to hold the Places API key.
    String apiKey = BuildConfig.PLACES_API_KEY;

    // Log an error if apiKey is not set.
    if (TextUtils.isEmpty(apiKey) || apiKey.equals("DEFAULT_API_KEY")) {
      Log.e("Places test", "No api key");
      finish();
      return;
    }

    // Initialize the SDK
    Places.initialize(getApplicationContext(), apiKey);

    // Create a new PlacesClient instance
    PlacesClient placesClient = Places.createClient(this);
    

WICHTIG:Fügen Sie API-Schlüssel niemals direkt Anwendungscode. In Produktionsumgebungen empfehlen wir die Verwendung eines Sicherheitsmechanismus um API-Schlüssel zu verwalten.

Sie können jetzt das Places SDK for Android verwenden.

Schritt 5: Android-Gerät einrichten

Wenn Sie eine App ausführen möchten, in der das Places SDK for Android verwendet wird, müssen Sie sie auf einem Android-Gerät oder Android-Gerät bereitstellen. Emulator, der auf Android 5.0 oder höher basiert und die Google-APIs.

• Wenn Sie ein Android-Gerät verwenden möchten, folgen Sie der Anleitung zum Ausführen von Apps auf einem Hardwaregerät: Run apps on a hardware device.
• Wenn Sie einen Android Emulator verwenden möchten, können Sie ein virtuelles Gerät erstellen und den Emulator mit dem AVD Manager für virtuelle Android-Geräte installieren, der in Android Studio enthalten ist.
  Hinweis: Um einen Android Emulator verwenden zu können, müssen Sie ein Gerät auswählen, bei dem in der Spalte Play Store ein Google Play-Symbol  angezeigt wird. Das Symbol weist darauf hin, dass die entsprechenden Profile vollständig mit CTS kompatibel sind und Systemimages verwenden dürfen, die die Play Store App enthalten:

  

Nächste Schritte

Nachdem Ihr Projekt konfiguriert wurde, können Sie Beispiel-Apps.