Tutorial for Mac

Masashi Katsumata edited this page Nov 17, 2016 · 50 revisions

Join the official community

New versions will be announced through the official community. Stay tune!

Do you have a question or feature request?

Feel free to ask me on the issues tracker.

Or on the official community is also welcome!

Jump to...

Clone this wiki locally

To install this plugin, you need to prepare your API keys for both Google Maps Android API v2 and Google Maps iOS SDK. This tutorial will explain how to obtain the API keys and how to install this plugin. Please follow each step with care.

Requirement iOS

Developing an application with the Google Maps SDK for iOS requires the following:

  • Cordova CLI 5+
  • Xcode 6.4 or later.
  • iOS SDK 7.0 or later.

Required XCode Version is 6.4+. The minimum target iOS version for Google Maps SDK for iOS is now 7.0. Version 6.0 is no longer supported. This release requires the following additional dependencies in your project: Accelerate.framework, CoreBluetooth.framework, CoreGraphics.framework, Security.framework

This will be set automatically when you install with CLI.

Requirement Android

  • Cordova Android 4+, CLI 5+
  • minSdkVersion 16 (4.1 is the minimum supported version)

0. Requirements

Before getting started you need to set up your environment properly.

  • Set the environment path to the Android SDK Platform-tools* and **Android SDK Build-tools
  • Install Apache Ant
  • Set the JAVA_HOME to the environment path
$> which ant

$> which android

$> which git

$> which unzip

$> echo $JAVA_HOME

$> cordova -v

Also you should install the latest versions. the latest versions of Android SDK platform-tools and Android SDK build-tools

It's also important to install the Android Support Repository, Library, Play Services and Google Repository.

1. Create a project

$> cordova create HelloMap com.example.myapp HelloMap

2. Add platforms

$> cd HelloMap/
$> cordova platform add android ios

3. (Only for Android) Displaying the debug certificate fingerprint

  • Find the keytool.
    • OS X and Linux: ~/.android/

*Display the SHA-1 fingerprint

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


4a. Obtain the Google Maps API Key for Android

  • Go to Google APIs Console.
  • Register your project
  • Turn on Google Maps Android API v2
  • Go to API Access page.
  • Click [Create New Android Key] button
  • In the resulting dialog, enter the SHA-1 fingerprint, then a semicolon, then your application's package name.
  • Write down the API Key See [the official document: Get an Android certificate and the Google Maps API key]

4b. Obtain the Google Maps API Key for iOS


5. Install this plugin

npm (stable)

$> cordova plugin add cordova-plugin-googlemaps --variable API_KEY_FOR_ANDROID="YOUR_ANDROID_API_KEY_IS_HERE" --variable API_KEY_FOR_IOS="YOUR_IOS_API_KEY_IS_HERE"

Github (current master)

$> cordova plugin add https://github.com/phonegap-googlemaps-plugin/cordova-plugin-googlemaps --variable API_KEY_FOR_ANDROID="YOUR_ANDROID_API_KEY_IS_HERE" --variable API_KEY_FOR_IOS="YOUR_IOS_API_KEY_IS_HERE"

*In case of PhoneGap, you also need to use the Cordova CLI. Check out PhoneGap Usage.

6. Change the www/index.html

<!DOCTYPE html>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <script type="text/javascript" src="cordova.js"></script>
    <script type="text/javascript">
    var map;
    document.addEventListener("deviceready", function() {
      var div = document.getElementById("map_canvas");

      // Initialize the map view
      map = plugin.google.maps.Map.getMap(div);

      // Wait until the map is ready status.
      map.addEventListener(plugin.google.maps.event.MAP_READY, onMapReady);
    }, false);

    function onMapReady() {
      var button = document.getElementById("button");
      button.addEventListener("click", onBtnClicked, false);

    function onBtnClicked() {
    <div style="width:100%;height:400px" id="map_canvas"></div>
    <button id="button">Full Screen</button>

7. Build and Run

For Android, just type these commands:

$> cordova build android
$> cordova run android


If you want to run this plugin on Android Emulator, please read this page. Run on Android Emulator

For iOS, you need to install Node.js modules once before running.

$> npm -g install ios-sim ios-deploy

then type these commands:

$> cordova build ios
$> cordova run ios


In order to stop the app, [command] + [D]

What's next?

There are many features! Check out the wiki page: https://github.com/wf9a5m75/phonegap-googlemaps-plugin/wiki