The Maps SDK for Android repository on GitHub includes samples illustrating the use of the Maps SDK for Android in your Android app.
The repository contains the ApiDemos app, a sample app that lets you build and run the samples from a single Android app. Import and build the app, add your API key, view the demo, and use the sample code supplied as a starting point for your app.
When you run the sample app, it displays a list of available samples that you can run on your own device. Select one of the options. For example, click Basic Map.
Troubleshooting: If the sample app runs successfully but you don't see a map, check that you've added your API key to the app's manifest file, as described in Using API Keys.
Maps SDK for Android sample app list
Key sample activities contained in the Maps SDK for Android ApiDemos app are listed below and reproduced at the linked pages for quick reference. See the Kotlin or Java folder for the full list of available samples.
Clone and run the samples
Git is required to run this sample locally. The following command clones the sample application repository.
git clone git@github.com:googlemaps-samples/android-samples.git
Import the sample project into Android Studio:
- In Android Studio, select File > New > Import Project.
Go to the location where you saved the repository and select the project directory for Kotlin or Java:
- Kotlin:
PATH-REPO/android-samples/ApiDemos/kotlin
- Java:
PATH-REPO/android-samples/ApiDemos/java
- Kotlin:
- Select Open. Android Studio builds your project, using the Gradle build tool.
- Create a blank
secrets.properties
file in the same directory as your project'slocal.properties
file. For more information, see Add your API key to the project. Add the following string to
secrets.properties
, replacing YOUR_API_KEY with the value of your API key:MAPS_API_KEY=YOUR_API_KEY
- Run the app.
Sample app for maps on Wear OS
A sample app for Maps SDK for Android on Wear OS is available on GitHub, which you can use as a starting point when building a wearable app. The sample shows you how to set up a basic Google Map on Wear OS.