fix(tutorials): migrate CurrentPlaceDetailsOnMap to Places SDK 6 (#2456)

Places SDK for Android 6.0 removed Places.initialize and
PlacesClient.findCurrentPlace, which both CurrentPlaceDetailsOnMap
tutorials relied on. Use Places.initializeWithNewPlacesApiEnabled and
searchNearby around the device's last-known location instead.

The tutorials were not part of the root build, so the breakage went
unnoticed. Include them in settings.gradle.kts, the build-tutorials CI
job and verify_all.sh, and fix the build files so they compile with the
shared version catalog and current AGP.

Author: kikoso

.github/workflows/build.yml

@@ -143,6 +143,8 @@ jobs:
     - name: Build and check
       run: |
         ./gradlew :tutorials:kotlin:Polygons:assembleDebug
+        ./gradlew :tutorials:java:CurrentPlaceDetailsOnMap:assembleDebug
+        ./gradlew :tutorials:kotlin:CurrentPlaceDetailsOnMap:assembleDebug
 
   test:
     runs-on: ubuntu-latest

scripts/verify_all.sh

@@ -47,6 +47,8 @@ MODULES=(
     ":snippets:java-app"
     ":snippets:app-utils"
     ":tutorials:kotlin:Polygons"
+    ":tutorials:java:CurrentPlaceDetailsOnMap"
+    ":tutorials:kotlin:CurrentPlaceDetailsOnMap"
 )
 
 # Parse arguments

settings.gradle.kts

@@ -69,6 +69,10 @@ project(":snippets:app-places-ktx").projectDir = file("snippets/app-places-ktx")
 // Tutorials
 include(":tutorials:kotlin:Polygons")
 project(":tutorials:kotlin:Polygons").projectDir = file("tutorials/kotlin/Polygons/app")
+include(":tutorials:java:CurrentPlaceDetailsOnMap")
+project(":tutorials:java:CurrentPlaceDetailsOnMap").projectDir = file("tutorials/java/CurrentPlaceDetailsOnMap/app")
+include(":tutorials:kotlin:CurrentPlaceDetailsOnMap")
+project(":tutorials:kotlin:CurrentPlaceDetailsOnMap").projectDir = file("tutorials/kotlin/CurrentPlaceDetailsOnMap/app")
 // Add others as needed, starting with these for now
 
 // Visual Testing

tutorials/java/CurrentPlaceDetailsOnMap/README.md

@@ -7,7 +7,7 @@ This sample goes hand in hand with a tutorial for the Google Maps Android API:
 Prerequisites
 --------------
 
-- Android API level 21+
+- Android API level 24+
 - Latest Android Build Tools
 - Android Support Repository
 - Google Repository
@@ -28,6 +28,17 @@ This sample uses the Gradle build system.
 
 This demo app requires that you add your own Google Maps API key. See [Get an API key](https://developers.google.com/maps/documentation/android-sdk/get-api-key) for more instructions.
 
+The app uses the Places SDK for Android (New), so the API key must have
+[Places API (New)](https://developers.google.com/maps/documentation/places/android-sdk/cloud-setup)
+enabled in addition to the Maps SDK for Android.
+
+This sample is part of the root Gradle build. From the root of this repository, add your key to
+`secrets.properties` (see `local.defaults.properties` for the format) and run:
+
+```
+./gradlew :tutorials:java:CurrentPlaceDetailsOnMap:assembleDebug
+```
+
 Support
 -------
 

tutorials/java/CurrentPlaceDetailsOnMap/app/build.gradle.kts

@@ -40,7 +40,7 @@ android {
         }
         release {
             isMinifyEnabled = false
-            proguardFiles(getDefaultProguardFile("proguard-android.txt"), "proguard-rules.pro")
+            proguardFiles(getDefaultProguardFile("proguard-android-optimize.txt"), "proguard-rules.pro")
         }
     }
 
@@ -49,11 +49,12 @@ android {
 
 dependencies {
     implementation(libs.appcompat)
-    implementation(libs.playServicesMaps)
+    implementation(libs.play.services.maps)
+    implementation(libs.play.services.location)
     implementation(libs.places)
     implementation(libs.volley)
-    implementation(platform(libs.kotlinBom))
-    implementation (libs.material)
+    implementation(platform(libs.kotlin.bom))
+    implementation(libs.material)
     testImplementation(libs.junit)
 }
 

tutorials/java/CurrentPlaceDetailsOnMap/app/src/main/java/com/example/currentplacedetailsonmap/MapsActivityCurrentPlace.java

@@ -42,11 +42,11 @@
 import com.google.android.gms.tasks.OnCompleteListener;
 import com.google.android.gms.tasks.Task;
 import com.google.android.libraries.places.api.Places;
+import com.google.android.libraries.places.api.model.CircularBounds;
 import com.google.android.libraries.places.api.model.Place;
-import com.google.android.libraries.places.api.model.PlaceLikelihood;
-import com.google.android.libraries.places.api.net.FindCurrentPlaceRequest;
-import com.google.android.libraries.places.api.net.FindCurrentPlaceResponse;
 import com.google.android.libraries.places.api.net.PlacesClient;
+import com.google.android.libraries.places.api.net.SearchNearbyRequest;
+import com.google.android.libraries.places.api.net.SearchNearbyResponse;
 import java.util.Arrays;
 import java.util.List;
 
@@ -82,6 +82,7 @@ public class MapsActivityCurrentPlace extends AppCompatActivity implements OnMap
 
     // Used for selecting the current place.
     private static final int M_MAX_ENTRIES = 5;
+    private static final double SEARCH_RADIUS_METERS = 100.0;
     private String[] likelyPlaceNames;
     private String[] likelyPlaceAddresses;
     private List[] likelyPlaceAttributions;
@@ -107,7 +108,7 @@ protected void onCreate(Bundle savedInstanceState) {
 
         // [START_EXCLUDE silent]
         // Construct a PlacesClient
-        Places.initialize(getApplicationContext(), BuildConfig.PLACES_API_KEY);
+        Places.initializeWithNewPlacesApiEnabled(getApplicationContext(), BuildConfig.MAPS_API_KEY);
         placesClient = Places.createClient(this);
 
         // Construct a FusedLocationProviderClient.
@@ -323,52 +324,55 @@ private void showCurrentPlace() {
         if (locationPermissionGranted) {
             // Use fields to define the data types to return.
             List<Place.Field> placeFields =
-                    Arrays.asList(Place.Field.NAME, Place.Field.ADDRESS, Place.Field.LAT_LNG);
-
-            // Use the builder to create a FindCurrentPlaceRequest.
-            FindCurrentPlaceRequest request = FindCurrentPlaceRequest.newInstance(placeFields);
+                    Arrays.asList(
+                            Place.Field.DISPLAY_NAME,
+                            Place.Field.FORMATTED_ADDRESS,
+                            Place.Field.LOCATION);
+
+            // Search around the device's last-known location, falling back to the center of the
+            // map if the location is not available yet.
+            LatLng center =
+                    lastKnownLocation != null
+                            ? new LatLng(
+                                    lastKnownLocation.getLatitude(),
+                                    lastKnownLocation.getLongitude())
+                            : map.getCameraPosition().target;
+            CircularBounds searchArea = CircularBounds.newInstance(center, SEARCH_RADIUS_METERS);
+
+            // Use the builder to create a SearchNearbyRequest that returns the closest places
+            // first.
+            SearchNearbyRequest request =
+                    SearchNearbyRequest.builder(searchArea, placeFields)
+                            .setMaxResultCount(M_MAX_ENTRIES)
+                            .setRankPreference(SearchNearbyRequest.RankPreference.DISTANCE)
+                            .build();
 
             // Get the likely places - that is, the businesses and other points of interest that
-            // are the best match for the device's current location.
-            @SuppressWarnings("MissingPermission")
-            final Task<FindCurrentPlaceResponse> placeResult =
-                    placesClient.findCurrentPlace(request);
+            // are closest to the device's current location.
+            final Task<SearchNearbyResponse> placeResult = placesClient.searchNearby(request);
             placeResult.addOnCompleteListener(
-                    new OnCompleteListener<FindCurrentPlaceResponse>() {
+                    new OnCompleteListener<SearchNearbyResponse>() {
                         @Override
-                        public void onComplete(@NonNull Task<FindCurrentPlaceResponse> task) {
+                        public void onComplete(@NonNull Task<SearchNearbyResponse> task) {
                             if (task.isSuccessful() && task.getResult() != null) {
-                                FindCurrentPlaceResponse likelyPlaces = task.getResult();
+                                List<Place> likelyPlaces = task.getResult().getPlaces();
 
                                 // Set the count, handling cases where less than 5 entries are
                                 // returned.
-                                int count;
-                                if (likelyPlaces.getPlaceLikelihoods().size() < M_MAX_ENTRIES) {
-                                    count = likelyPlaces.getPlaceLikelihoods().size();
-                                } else {
-                                    count = M_MAX_ENTRIES;
-                                }
+                                int count = Math.min(likelyPlaces.size(), M_MAX_ENTRIES);
 
-                                int i = 0;
                                 likelyPlaceNames = new String[count];
                                 likelyPlaceAddresses = new String[count];
                                 likelyPlaceAttributions = new List[count];
                                 likelyPlaceLatLngs = new LatLng[count];
 
-                                for (PlaceLikelihood placeLikelihood :
-                                        likelyPlaces.getPlaceLikelihoods()) {
+                                for (int i = 0; i < count; i++) {
                                     // Build a list of likely places to show the user.
-                                    likelyPlaceNames[i] = placeLikelihood.getPlace().getName();
-                                    likelyPlaceAddresses[i] =
-                                            placeLikelihood.getPlace().getAddress();
-                                    likelyPlaceAttributions[i] =
-                                            placeLikelihood.getPlace().getAttributions();
-                                    likelyPlaceLatLngs[i] = placeLikelihood.getPlace().getLatLng();
-
-                                    i++;
-                                    if (i > (count - 1)) {
-                                        break;
-                                    }
+                                    Place place = likelyPlaces.get(i);
+                                    likelyPlaceNames[i] = place.getDisplayName();
+                                    likelyPlaceAddresses[i] = place.getFormattedAddress();
+                                    likelyPlaceAttributions[i] = place.getAttributions();
+                                    likelyPlaceLatLngs[i] = place.getLocation();
                                 }
 
                                 // Show a dialog offering the user the list of likely places, and

tutorials/java/CurrentPlaceDetailsOnMap/local.defaults.properties

@@ -1,2 +1 @@
 MAPS_API_KEY=DEFAULT_API_KEY
-PLACES_API_KEY=DEFAULT_API_KEY

tutorials/kotlin/CurrentPlaceDetailsOnMap/README.md

@@ -7,7 +7,7 @@ This sample goes hand in hand with a tutorial for the Google Maps Android API:
 Prerequisites
 --------------
 
-- Android API level 21+
+- Android API level 24+
 - Latest Android Build Tools
 
 Getting started
@@ -25,6 +25,17 @@ This sample uses the Gradle build system.
 
 This demo app requires that you add your own Google Maps API key. See [Get an API key](https://developers.google.com/maps/documentation/android-sdk/get-api-key) for more instructions.
 
+The app uses the Places SDK for Android (New), so the API key must have
+[Places API (New)](https://developers.google.com/maps/documentation/places/android-sdk/cloud-setup)
+enabled in addition to the Maps SDK for Android.
+
+This sample is part of the root Gradle build. From the root of this repository, add your key to
+`secrets.properties` (see `local.defaults.properties` for the format) and run:
+
+```
+./gradlew :tutorials:kotlin:CurrentPlaceDetailsOnMap:assembleDebug
+```
+
 Support
 -------
 

tutorials/kotlin/CurrentPlaceDetailsOnMap/app/build.gradle.kts

@@ -30,7 +30,7 @@ android {
         targetSdk = libs.versions.targetSdk.get().toInt()
         versionCode = libs.versions.versionCode.get().toInt()
         versionName = libs.versions.versionName.get()
-        testInstrumentationRunner = "android.support.test.runner.AndroidJUnitRunner"
+        testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
     }
 
     buildFeatures {
@@ -43,7 +43,7 @@ android {
         }
         release {
             isMinifyEnabled = false
-            proguardFiles(getDefaultProguardFile("proguard-android.txt"), "proguard-rules.pro")
+            proguardFiles(getDefaultProguardFile("proguard-android-optimize.txt"), "proguard-rules.pro")
         }
     }
 
@@ -62,16 +62,16 @@ kotlin {
 }
 
 dependencies {
-    androidTestImplementation(libs.espressoCore) {
+    androidTestImplementation(libs.espresso.core) {
         exclude(group = "com.android.support", module = "support-annotations")
     }
     implementation(libs.appcompat)
-    implementation(libs.playServicesMaps)
+    implementation(libs.play.services.maps)
+    implementation(libs.play.services.location)
     implementation(libs.places)
     implementation(libs.volley)
     testImplementation(libs.junit)
-    implementation(libs.coreKtx)
-    implementation(libs.lifecycleViewModelKtx)
+    implementation(libs.core.ktx)
     implementation(libs.kotlin.stdlib)
     implementation(libs.material)
 }

tutorials/kotlin/CurrentPlaceDetailsOnMap/app/src/main/java/com/example/currentplacedetailsonmap/MapsActivityCurrentPlace.kt

@@ -41,9 +41,10 @@ import com.google.android.gms.maps.model.LatLng
 import com.google.android.gms.maps.model.Marker
 import com.google.android.gms.maps.model.MarkerOptions
 import com.google.android.libraries.places.api.Places
+import com.google.android.libraries.places.api.model.CircularBounds
 import com.google.android.libraries.places.api.model.Place
-import com.google.android.libraries.places.api.net.FindCurrentPlaceRequest
 import com.google.android.libraries.places.api.net.PlacesClient
+import com.google.android.libraries.places.api.net.SearchNearbyRequest
 
 /**
  * An activity that displays a map showing the place at the device's current location.
@@ -92,7 +93,7 @@ class MapsActivityCurrentPlace :
 
         // [START_EXCLUDE silent]
         // Construct a PlacesClient
-        Places.initialize(applicationContext, BuildConfig.MAPS_API_KEY)
+        Places.initializeWithNewPlacesApiEnabled(applicationContext, BuildConfig.MAPS_API_KEY)
         placesClient = Places.createClient(this)
 
         // Construct a FusedLocationProviderClient.
@@ -288,47 +289,41 @@ class MapsActivityCurrentPlace :
      * current place on the map - provided the user has granted location permission.
      */
     // [START maps_current_place_show_current_place]
-    @SuppressLint("MissingPermission")
     private fun showCurrentPlace() {
-        if (map == null) {
-            return
-        }
+        val map = map ?: return
         if (locationPermissionGranted) {
             // Use fields to define the data types to return.
-            val placeFields = listOf(Place.Field.NAME, Place.Field.ADDRESS, Place.Field.LAT_LNG)
+            val placeFields = listOf(
+                Place.Field.DISPLAY_NAME,
+                Place.Field.FORMATTED_ADDRESS,
+                Place.Field.LOCATION,
+            )
+
+            // Search around the device's last-known location, falling back to the center of
+            // the map if the location is not available yet.
+            val center = lastKnownLocation?.let { LatLng(it.latitude, it.longitude) }
+                ?: map.cameraPosition.target
+            val searchArea = CircularBounds.newInstance(center, SEARCH_RADIUS_METERS)
 
-            // Use the builder to create a FindCurrentPlaceRequest.
-            val request = FindCurrentPlaceRequest.newInstance(placeFields)
+            // Use the builder to create a SearchNearbyRequest that returns the closest places
+            // first.
+            val request = SearchNearbyRequest.builder(searchArea, placeFields)
+                .setMaxResultCount(M_MAX_ENTRIES)
+                .setRankPreference(SearchNearbyRequest.RankPreference.DISTANCE)
+                .build()
 
             // Get the likely places - that is, the businesses and other points of interest that
-            // are the best match for the device's current location.
-            val placeResult = placesClient.findCurrentPlace(request)
+            // are closest to the device's current location.
+            val placeResult = placesClient.searchNearby(request)
             placeResult.addOnCompleteListener { task ->
                 if (task.isSuccessful && task.result != null) {
-                    val likelyPlaces = task.result
+                    val likelyPlaces = task.result.places.take(M_MAX_ENTRIES)
 
-                    // Set the count, handling cases where less than 5 entries are returned.
-                    val count = if (likelyPlaces != null && likelyPlaces.placeLikelihoods.size < M_MAX_ENTRIES) {
-                        likelyPlaces.placeLikelihoods.size
-                    } else {
-                        M_MAX_ENTRIES
-                    }
-                    var i = 0
-                    likelyPlaceNames = arrayOfNulls(count)
-                    likelyPlaceAddresses = arrayOfNulls(count)
-                    likelyPlaceAttributions = arrayOfNulls<List<*>?>(count)
-                    likelyPlaceLatLngs = arrayOfNulls(count)
-                    for (placeLikelihood in likelyPlaces?.placeLikelihoods ?: emptyList()) {
-                        // Build a list of likely places to show the user.
-                        likelyPlaceNames[i] = placeLikelihood.place.name
-                        likelyPlaceAddresses[i] = placeLikelihood.place.address
-                        likelyPlaceAttributions[i] = placeLikelihood.place.attributions
-                        likelyPlaceLatLngs[i] = placeLikelihood.place.latLng
-                        i++
-                        if (i > count - 1) {
-                            break
-                        }
-                    }
+                    // Build a list of likely places to show the user.
+                    likelyPlaceNames = likelyPlaces.map { it.displayName }.toTypedArray()
+                    likelyPlaceAddresses = likelyPlaces.map { it.formattedAddress }.toTypedArray()
+                    likelyPlaceAttributions = likelyPlaces.map { it.attributions }.toTypedArray()
+                    likelyPlaceLatLngs = likelyPlaces.map { it.location }.toTypedArray()
 
                     // Show a dialog offering the user the list of likely places, and add a
                     // marker at the selected place.
@@ -342,7 +337,7 @@ class MapsActivityCurrentPlace :
             Log.i(TAG, "The user did not grant location permission.")
 
             // Add a default marker, because the user hasn't selected a place.
-            map?.addMarker(
+            map.addMarker(
                 MarkerOptions()
                     .title(getString(R.string.default_info_title))
                     .position(defaultLocation)
@@ -440,5 +435,6 @@ class MapsActivityCurrentPlace :
 
         // Used for selecting the current place.
         private const val M_MAX_ENTRIES = 5
+        private const val SEARCH_RADIUS_METERS = 100.0
     }
 }