Places SDK - Android

This SDK is designed to be robust, user-friendly, and easy to integrate into any application. By providing powerful features like Autocomplete, Forward Geocoding, Reverse Geocoding and Directions, along with capabilities like configurable retry logic, this SDK is a comprehensive solution for place-related functionalities.

Designed to be lightweight, easy to integrate, this SDK ensures users have a seamless experience. It also includes periodic updates, making it highly reliable and user-friendly.

Purpose

The primary purpose of the Ola-Maps-Services SDK is to enable developers to seamlessly integrate the services including Autocomplete, Reverse Geocoding, Forward Geocoding and Route/Direction,

Features

  1. Plug and Play:
    • Easy to start with just one line of code and no extra dependencies need to be added.
  2. Lightweight:
    • Minimal footprint in the application.
  3. Configurable Retry Logic:
    • Users have control over the retry logic.
  4. Periodic Updates:
    • Enhanced/optimized versions, bug fixes, and new features are provided periodically.
  5. Easy to Understand Documentation:
    • Comprehensive and user-friendly documentation.

Pre-Requirements for Setup

  1. Obtain the Places SDK file from the provided link.
  2. Place the SDK file in your project's "libs" directory.
  3. In project's "build.gradle" add a dependency using implementation(files("libs/[filename].jar"), replace [filename] with exact jar filename in "libs" folder)

Code Changes

1. Add SDK Dependency:
Add following dependencies to your app-level build.gradle file
implementation("com.squareup.retrofit2:converter-gson:2.11.0")
implementation("com.squareup.retrofit2:retrofit:2.11.0")
2. Initialization:
Initialize an SDK using below provided Client Id and Client Secret
val config = PlatformConfig.Builder()
    .apiKey("<API_KEY_HERE>")
    .build()
3. Endpoint configuration:
Set the endpoint configuration using same PlatformConfig object
.baseUrl("<API BASE URL>")
4. Custom configuration:
Set the custom configuration before building the PlatformConfig object
.maxRetryAttempts(3)

Auto Complete / Places Service

Create an object of AutocompleteRequest class, set the input query in field queryText() method and call the autoComplete() method of PlacesClient as shown in below code snippet.

val placesClient = Platform.getPlacesClient(config)

val autocompleteRequest = AutocompleteRequest.Builder()
    .queryText("airport")
    .build()

val autocompleteResponse = placesClient.autocomplete(autocompleteRequest)

Reverse Geocoding Service

Create an object of ReverseGeocodingRequest class, set the comma separated latitude and longitude in field latlng() method and call the reverseGeocode() method of ReverseGeocodingClient as shown in below code snippet.

val clientReverseGeocoding = Platform.getReverseGeocodingClient(config)

val reverseGeocodingRequest = ReverseGeocodingRequest.Builder()
    .latlng("12.931316595874005,77.61649243443775")
    .build()

val reverseGeocodingResponse = clientReverseGeocoding.reverseGeocode(reverseGeocodingRequest)

Forward Geocoding Service

Create an object of ForwardGeocodingRequest class, set the address in field address() method and call the forwardGeocode() method of ForwardGeocodingClient as shown in below code snippet.

val clientForwardGeocoding = Platform.getForwardGeocodingClient(config)

val forwardGeocodingRequest = ForwardGeocodingRequest.Builder()
    .address("ola campus, bengaluru")
    .build()

val forwardGeocodingResponse = clientForwardGeocoding.forwardGeocode(forwardGeocodingRequest)

Get Place Details

Create an object of PlaceDetailsRequest class, set the placeId using method placeId() and call the placeDetails() method of PlaceDetailsClient as shown in below code snippet.

val placeDetailsClient = Platform.getPlaceDetailsClient(config)

val placeDetailsRequest = PlaceDetailsRequest.Builder()
    .placeId("ola-platform:209ff095-37b5-49e8-ba31-91a493b2f554")
    .build()

val placeDetailsResponse = placeDetailsClient.placeDetails(placeDetailsRequest)

Create an object of NearbySearchRequest class, set the location using method location() and call the nearbySearch() method of NearbySearchClient as shown in below code snippet.

val nearbySearchClient = Platform.getNearbySearchClient(config)

val nearbySearchRequest = NearbySearchRequest.Builder()
    .limit(1)
    .location("12.931316595874005,77.61649243443775")
    .build()

val nearbySearchResponse = nearbySearchClient.nearbySearch(nearbySearchRequest)

Text Search

Create an object of TextSearchRequest class, set the queryText and location using method queryText() and location() , then call the textSearch() method of TextSearchClient as shown in below code snippet.

val textSearchClient = Platform.getTextSearchClient(config)

val textSearchRequest = TextSearchRequest.Builder()
    .queryText("hospital in koramangala")
    .location("12.931316595874005,77.61649243443775")
    .build()

val textSearchResponse = textSearchClient.textSearch(textSearchRequest)