Objectives:
- Understand how to use Google Maps API
- Understand how to use Google Location Services API
Tasks:
- Use Google Maps API
- Access to the current location
Location Services allows apps and websites (including Maps, Camera, Weather, and other apps) to use information from cellular, Wi-Fi, Global Positioning System (GPS) networks, and Bluetooth to determine your approximate location.
Using location-based information in your app is a great way to keep the user connected to the surrounding world. Whether you use this information for practical purposes such as navigation or for entertainment, location-based information can offer users a more contextual experience and enhance the overall user experience.
In this tutorial, we will explore how to capture this location information by using Google Maps API and Google Location Services API in your mobile device.
School of Computer SciencePage 1 of 11
Task 1: Use Google Maps API
This guide is a quick start to adding a map to an Android app. Android Studio is the recommended development environment for building an app with the Maps SDK for Android.
With the Maps SDK for Android, you can add maps based on Google Maps data to your application. The API automatically handles access to Google Maps servers, data downloading, map display, and response to map gestures. You can also use API calls to add markers, polygons, and overlays to a basic map, and to change the user’s view of a particular map area. These objects provide additional information for map locations and allow user interaction with the map. The API allows you to add these graphics to a map:
- Icons anchored to specific positions on the map (Markers).
- Sets of line segments (Polylines).
- Enclosed segments (Polygons).
- Bitmap graphics anchored to specific positions on the map (Ground Overlays).
- Sets of images which are displayed on top of the base map tiles (Tile Overlays).
This task is based on the following tutorial links:
- https://developers.google.com/maps/documentation/android-sdk/start
- https://developers.google.com/maps/documentation/android-sdk/map-with-marker
-
Start Android Studio and pick a No Activity project under Phone and Tablet category for creating a new project. Enter the following information as prompted:
- Name: GoogleMaps
- Package name: comp5216.sydney.edu.au.googlemaps
- Choose your preferred Save location
- Language: Java
- Minimum API level: API 24 Android 7.0 (Nougat)
- Build Configuration level: Groovy DSL Click Finish
-
Once your project is created, right-click on App -> Java -> comp5216.sydney.edu.au.googlemaps and select New -> Activity Gallery -> Google Maps View Activity and complete the details of the activity screen. In the New Android Activity dialog box, select the Launcher Activity checkbox.
-
Your app needs a Google Map API key to access the Google Maps servers, so in the next steps, you should obtain a Google Maps API key that you can add to your app. Android Studio Androidmanifest.xml file contains a link to the website with directions on how to get the Google Map API key. Do not add your API key to the file. Doing so stores your API key less securely.
School of Computer SciencePage 2 of 11
-
Proceed to the Google Cloud Platform Console to create a Google Maps API key. In the Google Cloud Console, on the Select a project page, click Create NEW PROJECT to begin creating a new Google Cloud project. Choose a Project name and click Create.
-
Provide the billing information to start the free trial and enable the Maps APIs or SDK for Android to use the Google Maps Platform. Select APIs and Services -> Enabled APIs and Services on the Getting Started section. Select the Library option to proceed to the API library. Click Maps SDK for Android tile to enable the SDK to be used with your project and click enable button.
-
Select the payment method if billing account is already created or set up the payment method to generate API key.
-
In the Google Maps Platform, proceed to the Keys and Credentials tab.
-
On the Credentials page, click + Create Credentials > API key. The API key created dialog displays your newly created API key.
-
Click Close. The new API key is listed on the Credentials page under API Keys. (Remember to restrict the API key before using it in production)
-
In Android Studio, open your project build.gradle file and add the following code to the id under the plugins section. These lines might have been already added to the gradle files automatically.
plugins '2.0.1' apply false
id 'com.android.application' version '8.1.0' apply false
id 'com.android.library' version '8.1.0' apply false
id 'com.google.android.libraries.mapsplatform.secrets - gradle - plugin' version
- Next, open your module build.gradle file and add the following code to the plugins element.
id 'com.google.android.libraries.mapsplatform.secrets - gradle - plugin'
- Save the file and sync your project with Gradle. In your AndroidManifest.xml file, go to com.google.android.geo.API_KEY and update the android:value attribute with MAPS_API_KEY as follows.
<meta - data
android:name = "com.google.android.geo.API_KEY"
android:value = "MAPS_API_KEY" />
- Review the code generated by Android Studio. Have a look at the apps layout XML file activity_maps.xml, and the Java file that defines the maps activity MapsActivity.java.
School of Computer SciencePage 3 of 11
- Enable zoom controls on your map and animate the camera to zoom into the map as soon as the map is ready to be used. Refer to the code snippet below. The final code should look the same as per MapsActivity.java file given in the Appendix.
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
binding = ActivityMapsBinding.inflate(getLayoutInflater());
setContentView(binding.getRoot());
// Obtain the SupportMapFragment and get notified when the map is ready to be used.
if (mMap == null) { // Do a null check to confirm that we have not already instantiated the map.
SupportMapFragment mapFragment = (SupportMapFragment)
getSupportFragmentManager().findFragmentById(R.id.map);
mapFragment.getMapAsync(this);
}
@Override
public void onMapReady(GoogleMap googleMap) {
mMap = googleMap;
if (mMap!= null) {
// Map is ready
Toast.makeText(this, "Map is ready to be used!", Toast.LENGTH_SHORT).show();
// Add a marker in Sydney and move the camera
LatLng sydney = new LatLng(-33.8692, 151.2089);
mMap.addMarker(new MarkerOptions().position(sydney).title("Marker in Sydney"));
mMap.moveCamera(CameraUpdateFactory.newLatLng(sydney));
// Enable zoom controls
mMap.getUiSettings().setZoomControlsEnabled(true);
// Animate the camera to zoom into the map
mMap.animateCamera(CameraUpdateFactory.newLatLngZoom(sydney, 11));
} else {
Toast.makeText(this, "Error - Map was null!", Toast.LENGTH_SHORT).show();
}
}
}
- Build and run your app. A Google map, a marker anchored to a specific Sydney location and zoom controls should be displayed as per the following screenshots. Use the zoom controls on the map to zoom in or out of your map.
School of Computer SciencePage 4 of 11
Task 2: Access to current location
This task shows you how to find the current location of an Android device. It builds an Android app using the Maps SDK for Android and the fused location provider in the Google Play services location APIs. The content is partially adopted from the following tutorialhttps://developers.google.com/maps/documentation/android-sdk/current-place-tutorial
- Start Android Studio and pick a No Activity project under the Phone and Tablet category for creating a new project. Enter the following information as prompted:
- Name: GoogleLocation
- Package name: comp5216.sydney.edu.au.googlelocation
- Choose your preferred Save location
- Language: Java
- Minimum API level: API 24 Android 7.0 (Nougat)
- Build Configuration level: Groovy DSL
- Click Finish
School of Computer SciencePage 5 of 11
-
Once your project is created, right-click on App -> Java -> comp5216.sydney.edu.au.googlelocation and select Activity – Gallery > Google Maps View Activity and complete the details of the activity screen.
-
Copy the activity_maps.xml (from the appendix) into your projects res/layout folder. It only contains a location TextView at the bottom to show the latitude and longitude, and a Google Map Fragment above it to cover the rest of the screen. 8:00 GoogleLocation
-
Obtain a Google Maps API key and add the API key to your app. Refer to steps 4 to 12 from Task 1 on how to obtain a key and use it for your app.
School of Computer SciencePage 6 of 11
- In your MapsActivity.java file, declare variables to reference the location
private ActivityMapsBinding binding;
private TextView locationTextView;
private GoogleMap mMap;
private CameraPosition mCameraPosition;
private static final String TAG = MapsActivity.class.getSimpleName();
private FusedLocationProviderClient mFusedLocationProviderClient; // The entry point to the Fused Location Provider.
private Location mLastKnownLocation = new Location(""); // The geographical location where the device is currently located. That is, the last - known location retrieved by the Fused Location Provider.
private final LatLng mDefaultLocation = new LatLng(-33.8523341, 151.2106085);
private static final int DEFAULT_ZOOM = 15;
private static final int PERMISSIONS_REQUEST_ACCESS_FINE_LOCATION = 1; // A default location (Sydney, Australia) and default zoom to use when location
private boolean mLocationPermissionGranted = false;
// Keys for storing activity state.
private static final String KEY_CAMERA_POSITION = "camera_position";
private static final String KEY_LOCATION = "location";
.
(locationTextView), the current location (mLastKnownLocation), default location (mDefaultLocation), default zoom and other supporting variables.
- Add Google Play Services libraries in build.gradle file inside your app module directory
implementation libs.play.services.maps
implementation 'com.google.android.gms:play - services - location:21.0.1'
School of Computer SciencePage 7 of 11
- In onCreate() method, use the layout activity_maps, and initialise the Fused Location Provider Client. Also initialise the Google Map.
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
// Retrieve the content view that renders the map.
binding = ActivityMapsBinding.inflate(getLayoutInflater());
setContentView(binding.getRoot());
if // Retrieve location and camera position from saved instance state.
(savedInstanceState!= null) {
mLastKnownLocation = savedInstanceState.getParcelable(KEY_LOCATION);
mCameraPosition = savedInstanceState.getParcelable(KEY_CAMERA_POSITION);
// Obtain the SupportMapFragment and get notified when the map is ready to be used.
SupportMapFragment mapFragment = (SupportMapFragment)
getSupportFragmentManager().findFragmentById(R.id.map);
mapFragment.getMapAsync(this);
// Obtain the location TextView
locationTextView = (TextView) this.findViewById(R.id.location);
// Construct a FusedLocationProviderClient.
mFusedLocationProviderClient = LocationServices.getFusedLocationProviderClient(this);
}
}
- Make sure your activity extends FragmetActivity instead of Activity, and implements OnMapReadyCallback. We will add the required methods in the next step.
public class MapsActivity extends FragmentActivity implements OnMapReadyCallback {
- Add the required callback methods.
@Override
public void onMapReady(GoogleMap googleMap) {
mMap = googleMap;
getLocationPermission(); // Prompt the user for permission.
// Turn on the My Location layer and the related control on the map.
updateLocationUI();
// Get the current location of the device and set the position of the map.
getDeviceLocation();
}
School of Computer SciencePage 8 of 11
- Make sure getLocationPermission, updateLocationUI, and getDeviceLocation methods are implemented and you understand what each function does. Refer to MapsActivity.java in the lab files.
private void getDeviceLocation() {
try {
if (mLocationPermissionGranted) {
Task<Location> locationResult =
mFusedLocationProviderClient.getLastLocation();
locationResult.addOnCompleteListener(this, new OnCompleteListener<Location>() {
@Override
public void onComplete(@NonNull Task<Location> task) {
if (task.isSuccessful()) {
mLastKnownLocation = task.getResult();
String currentOrDefault = "Current";
// Obtain the current location of the device
if (mLastKnownLocation!= null) {
DEFAULT_ZOOM));
} else {
mMap.animateCamera(CameraUpdateFactory.newLatLngZoom(
Log.d(TAG, "Current location is null. Using defaults.");
new LatLng(mLastKnownLocation.getLatitude(),
mLastKnownLocation.getLongitude()),
currentOrDefault = "Default";
mMap.animateCamera(CameraUpdateFactory.newLatLngZoom(mDefaultLocation,
DEFAULT_ZOOM));
mMap.getUiSettings().setMyLocationButtonEnabled(false);
mLastKnownLocation = new Location("");
// Set current location to the default location
mLastKnownLocation.setLatitude(mDefaultLocation.latitude);
mLastKnownLocation.setLongitude(mDefaultLocation.longitude);
String msg = currentOrDefault + " Location: " +
// Show location details on the location TextView
toString(mLastKnownLocation.getLatitude()) + ",
locationTextView.setText(msg);
toString(mLastKnownLocation.getLongitude());
// Add a marker for my current location on the map
MarkerOptions marker = new MarkerOptions().position(
new LatLng(mLastKnownLocation.getLatitude(),
mLastKnownLocation.getLongitude()))
else {
mMap.addMarker(marker);
e(TAG, "Exception: %s", task.getException());
d(TAG, "Current location is null. Using defaults.");
"I am here");
mMap.moveCamera(CameraUpdateFactory
mMap.getUiSettings().setMyLocationButtonEnabled(false);
newLatLngZoom(mDefaultLocation, DEFAULT_ZOOM));
}
}
}
});
}
} catch (SecurityException e) {
Log.e("Exception: %s", e.getMessage());
}
}
- Setup the permission for accessing location. You may refer to AndroidManifest.xml file in the lab material to update your own version.
<uses - permission android:name = "android.permission.ACCESS_FINE_LOCATION" />
<uses - permission android:name = "android.permission.ACCESS_COARSE_LOCATION" />
- Build and run the app, preferably on a mobile phone. The app should display your current location. The final code will be the similar to that of MapsActivity.java (in Appendix).
To learn more about the Location Services API, see Google Location Services for Android:
- Build location-aware apps –https://developer.android.com/training/location/
- Get the last known location –https://developer.android.com/training/location/retrieve-current
To learn more about the step-by-step process of getting an embedded Google Map working within an Android emulator, refer to this tutorial:https://github.com/codepath/android_guides/wiki/Google-Maps-Fragment-Guide
School of Computer SciencePage 10 of 11
APPENDIX
Activity_maps.xml
Reviews
There are no reviews yet.