Google Maps Setup Guide - nhtechip/android-bootstrap GitHub Wiki

Many Android applications require the use of an embedded interactive map. On Android, this embedded map is part of the Google Play Services SDK which is a Google add-on pack for Android enabling all sorts of extra features around gaming, messaging, billing, location, etc.

In this guide, we will walk you through the step by step process of getting an embedded Google Map working within an Android emulator.

First, let's download and setup the Google Play Services SDK. Open Eclipse ⇒ Windows ⇒ Android SDK Manager and check whether you have already downloaded "Google Play services" or not under Extras section. If not, select "Google Play services" and install the package.

Note: Skip this step when using Android Studio! This is for Eclipse only!

After downloading the play services we need to import the project to Eclipse which will be used as a library for our maps project.

1. In Eclipse goto File ⇒ Import ⇒ Android ⇒ Existing Android Code Into Workspace

2. Click on Browse and select "Google Play Services" project from your android sdk folder. You can locate the play services library project from <your-android-sdk-path>\extras\google\google_play_services\libproject\google-play-services_lib

3. Be sure to check "Copy projects into workspace" option as shown in the below image.

Open your terminal and execute the following command to generate SHA-1 fingerprint necessary to get your API key from Google.

On Windows:

"C:\Program Files (x86)\Java\jdk1.7.0_60\bin\keytool.exe" -list -v -keystore "%USERPROFILE%\.android\debug.keystore" -alias androiddebugkey -storepass android -keypass android

or, depending on the installation location of your JDK:

"C:\Program Files\Java\jre7\bin\keytool.exe" -list -v -keystore "%USERPROFILE%\.android\debug.keystore" -alias androiddebugkey -storepass android -keypass android

On Mac or Linux:

keytool -list -v -keystore ~/.android/debug.keystore -alias androiddebugkey -storepass android -keypass android

In the output you can see SHA 1 finger print:

Now open Google API Console, create and select a project, select "APIs & Auth" on left side and turn on Google Maps Android API v2 toggle switch.

Now select "Credentials" on left side and on the right side click on "Create New Key" => "Android Key"

It will popup a window asking the SHA1 and package name. Enter your SHA 1 and your android project package name separated by semicolon ; and click on create. The format is:

<YOURSHA1KEY>;com.example.mapdemo

For example you might enter:

BE:03:E1:44:39:7B:E8:17:02:9F:7F:B7:98:82:EA:DF:84:D0:FB:6A;com.example.mapdemo

Note the API Key for use in the next step while setting up the map demo app:

Note: As of March 6th, 2014, we can download the Google APIs x86 image to test maps. If you want to set the GPS coordinates of the emulator and you're using Eclipse, go to Window->Open Perspective->DDMS->Emulator Control, then type one in Location Controls and hit "Send". Otherwise, for using the Genymotion emulator, see below. Note that Genymotion is much harder to setup, but is a much faster and more powerful Android emulator that more closely mirrors a device.

The first step to getting Google Maps working on your emulator is to download a third-party emulator called Genymotion. The reason for this is that the official emulator does a terrible job of supporting the Google Play Services. While it is possible to get the Intel HAXM fast emulator working with the Play Services SDK, at the moment it's far more trouble then it's worth.

Genymotion is an incredibly fast, memory-efficient VM that runs the Android OS in a more accurate manner than even the official emulator. Many Android developers do all their device testing using this emulator especially when Google Play services is concerned.

To setup your genymotion emulator sign up and follow the installation guide:

1. Sign up for an account on the Genymotion Website
2. (Mac or Linux) You must install VirtualBox, a powerful free virtualization software for Genymotion to run.
3. Download Genymotion Emulator for your platform.
4. Install the Genymotion Emulator

• Windows: Run the MSI installer
• Mac: Open the dmg and drag both apps to Applications directory

5. Install the Eclipse Plugin (See this guide for Android Studio)
   • Go to the "Help/Install New Software..." menu
   • Add a new software site: Genymobile - http://plugins.genymotion.com/eclipse
   • Check all genymobile entries
   • Accept licenses and install
   • Restart eclipse

1. Run the Genymotion application
2. Sign in and add your first virtual device (Nexus 4 - 4.3 - API 18)
   • Do not start your emulator yet!
3. From within eclipse, click the genymobile icon and click "Start" on your virtual device.

• Make sure to start your emulator through the eclipse plugin

4. Wait for device to boot up into a useable state

1. Download the latest Google Play Services APK for 4.3 from Rootz Wiki
2. Drag and drop the zip file onto the running Genymotion emulator device
   • Seeing a crash dialog of Google services is to be expected
3. Close and restart the emulator and Google Play Store should now be installed
4. After restart, open the "Play Store" app on your emulator and sign in with a google account

Note: On Ubuntu 12.04, make sure to 3D acceleration mode by launching VirtualBox and going to Settings -> Display to fix. VirtualBox appears to prone to memory leaks, so you may find yourself killing the process from time to time. To avoid large CPU consumption by the compiz window manager and swapping in general, try increasing the video memory allocation and Base Memory (found in Settings -> System).

Note: Are you getting an error when starting the emulator? Error Failed to load VMMR0.r0? Follow the advice here. In short, go to virtual box page and download and install VirtualBox 4.3.6 Oracle VM VirtualBox Extension Pack.

Note: If you get Failed to load OVI error when re-adding the emulator, you need to use a new name for the same device. For example, "Nexus 4 - 4.3 - API 18" might be called "Nexus 4 - 4.3 - API 18 New".

Next, if you don't have the emulator started yet, be sure to boot the genymotion emulator from within the Eclipse plugin:

Now we need to enable the GPS location on the emulator by manually selecting a location on the map:

With GPS location enabled, let's now setup our map demo app.

Once we have our Genymotion emulator properly setup, let's import the maps demo application so we can use this to verify if maps are showing up correctly.

1. Download the Maps Demo application and extract the zip file.
2. Run "File...Import...Existing Android Code Into Workspace", select the project and hit "Finish"
3. Expand MapDemo application and open up the "AndroidManifest.xml"

Note: For Android Studio users, download this alternate maps demo and import into Studio as an existing project. Follow steps below.

Fill in your API Key into the meta data for com.google.android.maps.v2.API_KEY within the application node in the AndroidManifest.xml:

<application
  ...>
  <activity 
     ...>
  </activity>

  <meta-data android:name="com.google.android.gms.version" android:value="@integer/google_play_services_version" />
  <meta-data
     android:name="com.google.android.maps.v2.API_KEY"
     android:value="YOUR-KEY-HERE" />

</application>

Android Studio users: You need to install the "Google Repository" through the Android Studio SDK Manager. Gradle will pull the Google Play Services library from there.

Eclipse users: You need to include Google Play Services project as a library to use in our demo app. So right click on project and select "Properties". In the Properties window on left side select "Android". On the right you can see a Add button under library section. Click it and select google play services project which we imported previously.

Now we want to run the map demo, and if everything went well we should see:

Note: If you don't, you may have not properly installed the Google Play services on the emulator (see instructions in genymotion setup above) or you may need to update the Google Play services on your emulator by following the instructions given in the app.

At this point, you should have the Google map displaying in your sample application. If you don't, try restarting the emulator and uninstalling / reinstalling the map demo application. Eventually you will see the maps if you registered your key properly.

For more information including how to use the maps, check out the source of the Maps Usage Cliffnotes as well as this article on androidhive.

Use this checklist for troubleshooting below:

Trouble launching Genymotion?

• Did you install VirtualBox first. Run VirtualBox to ensure that it was installed correctly.
• Did you properly move Genymotion into the Applications folder?
• Launch VirtualBox, then verify the emulator is listed and ensure it is in a powered off state
• Open Genymotion app and verify the emulator is listed there and no errors are shown
• Restart Eclipse and try to launch the emulator again through eclipse plugin
• Restart your computer and try to launch the emulator again through eclipse plugin

Trouble seeing the map in the demo app?

• Does the Android Key on the Google API Console match the package namespace of the maps demo app i.e <YOURSHA1KEY>;com.example.mapdemo?
• Did you enter the correct API Key into the AndroidManifest.xml as explained in the map demo setup?
• Did you enable the "Google Maps Android API v2" toggle switch on the Google API Console under "APIs & Auth" tab?
• Did you enable GPS location for the emulator and set a location by going to the map?
• Did you download the latest Google Play Services APK and install that onto your emulator? See the google play genymotion section.
• Did you try running "Play Store" on your emulator and sign in with a Google account?
• Uninstall the "Map Demo" from the emulator first, then re-install
• Restart Eclipse and try to launch the app again
• Restart your computer and try to launch the app again

Hopefully with these troubleshooting steps you have gotten things working!

Often when collaborating on a project with others, you need to have the maps work across multiple computers. The problem is that the map key fingerprint is different from computer to computer and thus by default the maps will only work on the computer that was used to generate the key.

The simplest fix is described in detail within this stack overflow post but in short you can get the debug.keystore from one of the team members, check that into git and then instruct other team members to replace their debug.keystore file with the one from repository. See also this link and this guide.

• http://www.androidhive.info/2013/08/android-working-with-google-maps-v2/
• http://www.vogella.com/articles/AndroidGoogleMaps/article.html
• http://www.genymotion.com/