No public description

PiperOrigin-RevId: 700706989

Author: SDK Samples

README.md

@@ -1,40 +1,56 @@
-Android SearchInApps API sample apps
+SearchInApps API sample apps
 ============
 
 Introduction
 ------------
 
-Android SearchInApps API allows apps to get Google related search suggestions and trending searches.
-These apps provide fully functional examples of integrating with SearchInApps SDK.
+The SearchInApps API allows apps to get Google related search suggestions and trending searches.
+These apps provide fully functional examples of integrating with the SearchInApps SDK.
 
 Getting started
 ---------------
 Clone this project to your workstation using a git client. You can use the
 [instructions from GitHub](https://docs.github.com/en/free-pro-team@latest/github/creating-cloning-and-archiving-repositories/cloning-a-repository)
 if you need guidance.
 
-This project uses the Gradle build system. To build this project, use the
+### Android ###
+The Android projects use the Gradle build system. To build this project, use the
 `gradlew build` command or use "Import Project" in Android Studio.
 
 For more resources on learning Android development, visit the
 [Developer Guides](https://developer.android.com/guide/) at
 [developer.android.com](https://developer.android.com).
 
+### iOS ###
+The iOS projects are Xcode projects that use [cocoapods](https://cocoapods.org/)
+for package dependency. 
+
+For more resources on learning iOS development, visit Apple's
+[documentation](https://developer.apple.com/documentation/) at
+[developer.apple.com](https://developer.apple.com).
+
 Prerequisites
 -------------
 
-To let these sample apps work properly, please follow the [SearchInApps Android SDK developer guide](https://developers.google.com/search-in-apps/android) to get your client id and api key, and put them into the sample apps' AndroidManifest.xml file.
+The sample apps need a **client id** and **api key** to work. Please follow the [SearchInApps Android SDK developer guide](https://developers.google.com/search-in-apps/android) or [SearchInApps iOS SDK developer guide](https://developers.google.com/search-in-apps/ios) to get your client id and api key.
+
+For Android, insert the **client id** and **api key** into the sample apps' AndroidManifest.xml file, for iOS insert it into the project's Info.plist.
 
-For Java developers
+For Android Java developers
 -------------------
 
 The Android View sample application is contained in the view/ directory. It is written fully in Java. The detailed information about the SearchInApps SDK's Java classes can be found [here](https://developers.google.com/search-in-apps/android/reference/com/google/android/libraries/searchinapps/package-summary).
 
-For Jetpack Compose developers
+For Android Jetpack Compose developers
 ------------------------------
 
 The Jetpack Compose sample application is contained in the compose/ directory. It is written fully in Kotlin. The detailed information about the SearchInApps SDK's Kotlin classes can be found [here](https://developers.google.com/search-in-apps/android/reference/kotlin/com/google/android/libraries/searchinapps/package-summary).
 
+For iOS SwiftUI developers
+------------------------------
+The SwiftUI sample application is contained in the swiftui/ directory. The detailed information about the SearchInApps SDK's Swift classes can be found [here](https://developers.google.com/search-in-apps/ios/reference/api/swift_reference/Classes/ContextualSearchRuntime).
+
+
 Support
 -------
 

compose/app/build.gradle

@@ -54,7 +54,7 @@ android {
 
 dependencies {
     implementation "com.google.android.gms:play-services-oss-licenses:17.0.0"
-    implementation "com.google.android.libraries.searchinapps:searchinapps:0.3.0"
+    implementation "com.google.android.libraries.searchinapps:searchinapps:0.4.1"
 
     implementation "androidx.activity:activity-compose:1.7.0"
     implementation "androidx.appcompat:appcompat:1.4.1"

compose/app/src/main/java/com/google/samples/quickstart/searchinapps/compose/MainActivity.kt

@@ -27,13 +27,16 @@ import androidx.compose.foundation.layout.height
 import androidx.compose.foundation.layout.padding
 import androidx.compose.foundation.layout.width
 import androidx.compose.foundation.layout.wrapContentWidth
+import androidx.compose.foundation.rememberScrollState
+import androidx.compose.foundation.verticalScroll
 import androidx.compose.material3.Button
 import androidx.compose.material3.MaterialTheme
 import androidx.compose.material3.OutlinedTextField
 import androidx.compose.material3.RadioButton
 import androidx.compose.material3.Surface
 import androidx.compose.material3.Text
 import androidx.compose.runtime.Composable
+import androidx.compose.runtime.DisposableEffect
 import androidx.compose.runtime.getValue
 import androidx.compose.runtime.mutableStateOf
 import androidx.compose.runtime.remember
@@ -47,21 +50,23 @@ import androidx.compose.ui.tooling.preview.Preview
 import androidx.compose.ui.viewinterop.AndroidView
 import androidx.lifecycle.compose.collectAsStateWithLifecycle
 import androidx.lifecycle.viewmodel.compose.viewModel
+import com.google.android.libraries.searchinapps.GetSearchContentViewGeneratorCallback
+import com.google.android.libraries.searchinapps.GetSearchContentViewOptions
 import com.google.android.libraries.searchinapps.GetSearchSuggestionsViewGeneratorCallback
 import com.google.android.libraries.searchinapps.GetSearchSuggestionsViewOptions
 import com.google.android.libraries.searchinapps.GetTrendingSearchesViewOptions
 import com.google.android.libraries.searchinapps.LocationContext
 import com.google.android.libraries.searchinapps.LocationContext.CircularArea
 import com.google.android.libraries.searchinapps.LocationContext.GeographicalRestrictions
 import com.google.android.libraries.searchinapps.LocationContext.LatLng
+import com.google.android.libraries.searchinapps.SearchContentViewGenerator
+import com.google.android.libraries.searchinapps.SearchContentViewOptions
 import com.google.android.libraries.searchinapps.SearchInAppsService
 import com.google.android.libraries.searchinapps.SearchSuggestionsViewGenerator
 import com.google.android.libraries.searchinapps.SearchSuggestionsViewOptions
 
 /** Jetpack activity demonstrating the usage of SearchInAppsService API. */
 class MainActivity : AppCompatActivity() {
-  private var service: SearchInAppsService? = null
-
   override fun onCreate(savedInstanceState: Bundle?) {
     super.onCreate(savedInstanceState)
     setContent {
@@ -91,12 +96,22 @@ class MainActivity : AppCompatActivity() {
     viewModel: SearchInAppsViewModel = viewModel(),
   ) {
     var context = LocalContext.current
-    if (service == null) {
-      service = SearchInAppsService.create(context)
+    var service by remember {
+      mutableStateOf<SearchInAppsService?>(SearchInAppsService.create(context))
     }
     var textInput by remember { mutableStateOf("") }
     var locationInput by remember { mutableStateOf("") }
+    var searchRepeatInput by remember { mutableStateOf("") }
+
+    var searchContentBlockNumber by remember { mutableStateOf(0) }
 
+    val viewSuggestionsGenerator by
+      viewModel.getSearchSuggestionsViewGenerator().collectAsStateWithLifecycle()
+    val viewContentGenerator by
+      viewModel.getSearchContentViewGenerator().collectAsStateWithLifecycle()
+    viewContentGenerator?.let { viewContentGenerator ->
+      searchContentBlockNumber = viewContentGenerator.getSearchContentBlockCount()
+    }
     val layout by viewModel.getLayout().collectAsStateWithLifecycle()
 
     var radioOptions =
@@ -106,6 +121,8 @@ class MainActivity : AppCompatActivity() {
         stringResource(R.string.tiling_layout),
       )
 
+    DisposableEffect(Unit) { onDispose { service?.shutDown() } }
+
     Column {
       Row(verticalAlignment = Alignment.CenterVertically) {
         OutlinedTextField(
@@ -125,6 +142,15 @@ class MainActivity : AppCompatActivity() {
         )
       }
 
+      Row(verticalAlignment = Alignment.CenterVertically) {
+        OutlinedTextField(
+          value = searchRepeatInput,
+          onValueChange = { searchRepeatInput = it },
+          label = { Text(stringResource(R.string.search_repeat_hint)) },
+          modifier = Modifier.fillMaxWidth(),
+        )
+      }
+
       Spacer(modifier = Modifier.height(dimensionResource(R.dimen.vertical_spacer_height)))
 
       Row(verticalAlignment = Alignment.CenterVertically) {
@@ -195,6 +221,56 @@ class MainActivity : AppCompatActivity() {
 
       Spacer(modifier = Modifier.height(dimensionResource(R.dimen.vertical_spacer_height)))
 
+      val searchContentCallback =
+        object : GetSearchContentViewGeneratorCallback() {
+          override fun onSuccess(generator: SearchContentViewGenerator) {
+            viewModel.setSearchContentViewGenerator(generator)
+            searchContentBlockNumber = generator.getSearchContentBlockCount()
+          }
+
+          override fun onError(errorMessage: String) {
+            Toast.makeText(context, errorMessage, Toast.LENGTH_SHORT).show()
+          }
+
+          override fun onLoadMoreSearchContentSuccess(generator: SearchContentViewGenerator) {
+            searchContentBlockNumber = generator.getSearchContentBlockCount()
+          }
+
+          override fun onLoadMoreSearchContentError(errorMessage: String) {
+            Toast.makeText(context, errorMessage, Toast.LENGTH_SHORT).show()
+          }
+        }
+      Row(verticalAlignment = Alignment.CenterVertically) {
+        Button(
+          modifier = Modifier.wrapContentWidth(),
+          onClick = {
+            var options: GetSearchContentViewOptions =
+              GetSearchContentViewOptions()
+                .setSearchRepeatContext(searchRepeatInput)
+                .setNumberOfBlocksToRequest(3)
+                .setSearchContentViewOptions(SearchContentViewOptions().setLayout(layout))
+
+            service?.getSearchContentView(options, searchContentCallback)
+          },
+        ) {
+          Text(stringResource(R.string.search_content))
+        }
+
+        Spacer(modifier = Modifier.width(dimensionResource(R.dimen.horizontal_spacer_width)))
+
+        Button(
+          onClick = {
+            viewContentGenerator?.let { viewContentGenerator ->
+              viewContentGenerator.loadMoreSearchContent(searchContentCallback)
+            }
+          }
+        ) {
+          Text(stringResource(R.string.load_more_content))
+        }
+      }
+
+      Spacer(modifier = Modifier.height(dimensionResource(R.dimen.vertical_spacer_height)))
+
       Row {
         radioOptions.forEach { currentLayout ->
           Row(verticalAlignment = Alignment.CenterVertically) {
@@ -206,27 +282,48 @@ class MainActivity : AppCompatActivity() {
           }
         }
       }
-      val viewGenerator by
-        viewModel.getSearchSuggestionsViewGenerator().collectAsStateWithLifecycle()
-      ChipGroupUI(layout, viewGenerator)
+      ChipGroupUI(layout, viewSuggestionsGenerator)
+      SearchContentUI(layout, viewContentGenerator, searchContentBlockNumber)
     }
   }
 
   @Composable
   fun ChipGroupUI(
     layout: SearchSuggestionsViewOptions.Layout,
-    viewGenerator: SearchSuggestionsViewGenerator?,
+    viewSuggestionsGenerator: SearchSuggestionsViewGenerator?,
   ) {
-    viewGenerator?.let { viewGenerator ->
-      viewGenerator.getViewOptions().setLayout(layout)
+    viewSuggestionsGenerator?.let { viewSuggestionsGenerator ->
+      viewSuggestionsGenerator.getViewOptions().setLayout(layout)
       var context = LocalContext.current
       AndroidView(
-        factory = { context -> viewGenerator.populateView(context) },
-        update = { view -> viewGenerator.updateView(view, context) },
+        factory = { context -> viewSuggestionsGenerator.populateView(context) },
+        update = { view -> viewSuggestionsGenerator.updateView(view, context) },
       )
     }
   }
 
+  @Composable
+  fun SearchContentUI(
+    layout: SearchSuggestionsViewOptions.Layout,
+    viewContentGenerator: SearchContentViewGenerator?,
+    searchContentBlockNumber: Int,
+  ) {
+    viewContentGenerator?.let { viewContentGenerator ->
+      viewContentGenerator.getSearchContentViewOptions().setLayout(layout)
+      var context = LocalContext.current
+      Column(modifier = Modifier.verticalScroll(rememberScrollState())) {
+        for (index in 0..searchContentBlockNumber - 1) {
+          Row {
+            AndroidView(
+              factory = { context -> viewContentGenerator.populateView(context, index) },
+              update = { view -> viewContentGenerator.updateView(view, context) },
+            )
+          }
+        }
+      }
+    }
+  }
+
   @Preview(showBackground = true)
   @Composable
   fun SearchSuggestionsPreview() {

compose/app/src/main/java/com/google/samples/quickstart/searchinapps/compose/SearchInAppsViewModel.kt

@@ -15,20 +15,35 @@
 package com.google.samples.quickstart.searchinapps.compose
 
 import androidx.lifecycle.ViewModel
+import com.google.android.libraries.searchinapps.SearchContentViewGenerator
 import com.google.android.libraries.searchinapps.SearchSuggestionsViewGenerator
 import com.google.android.libraries.searchinapps.SearchSuggestionsViewOptions
 import kotlinx.coroutines.flow.MutableStateFlow
 import kotlinx.coroutines.flow.StateFlow
-import kotlinx.coroutines.flow.update
 import kotlinx.coroutines.flow.asStateFlow
+import kotlinx.coroutines.flow.update
 
 /** The ViewModel for the Jetpack Compose sample activity to store the data. */
 class SearchInAppsViewModel : ViewModel() {
-  private val searchSuggestionsViewGenerator = MutableStateFlow<SearchSuggestionsViewGenerator?>(null)
-  private val layout = MutableStateFlow<SearchSuggestionsViewOptions.Layout>(SearchSuggestionsViewOptions.Layout.COMPACT_CAROUSEL)
+  private val searchContentViewGenerator = MutableStateFlow<SearchContentViewGenerator?>(null)
+  private val searchSuggestionsViewGenerator =
+    MutableStateFlow<SearchSuggestionsViewGenerator?>(null)
+  private val layout =
+    MutableStateFlow<SearchSuggestionsViewOptions.Layout>(
+      SearchSuggestionsViewOptions.Layout.COMPACT_CAROUSEL
+    )
+
+  public fun setSearchContentViewGenerator(searchContentViewGenerator: SearchContentViewGenerator) {
+    this.searchContentViewGenerator.value = searchContentViewGenerator
+  }
+
+  public fun getSearchContentViewGenerator(): StateFlow<SearchContentViewGenerator?> {
+    return this.searchContentViewGenerator.asStateFlow()
+  }
 
   public fun setSearchSuggestionsViewGenerator(
-      searchSuggestionsViewGenerator: SearchSuggestionsViewGenerator) {
+    searchSuggestionsViewGenerator: SearchSuggestionsViewGenerator
+  ) {
     this.searchSuggestionsViewGenerator.value = searchSuggestionsViewGenerator
   }
 
@@ -41,6 +56,6 @@ class SearchInAppsViewModel : ViewModel() {
   }
 
   public fun updateLayout(layout: SearchSuggestionsViewOptions.Layout) {
-    this.layout.update {layout}
+    this.layout.update { layout }
   }
 }

compose/app/src/main/res/values/strings.xml

@@ -18,7 +18,10 @@
   <string name="search_text" translatable="false">Get suggestions</string>
   <string name="search_hint" translatable="false">Enter search context</string>
   <string name="location_hint" translatable="false">Enter location latitude, longitude and radius</string>
+  <string name="search_repeat_hint" translatable="false">Enter search repeat</string>
   <string name="trending_text" translatable="false">Get trendings</string>
+  <string name="search_content" translatable="false">Get content</string>
+  <string name="load_more_content" translatable="false">More content</string>
   <string name="compact_carousel_layout" translatable="false">Compact Carousel</string>
   <string name="carousel_layout" translatable="false">Carousel</string>
   <string name="tiling_layout" translatable="false">Tiling</string>

compose/gradle/wrapper/gradle-wrapper.jar

@@ -0,0 +1,11 @@
+# Uncomment the next line to define a global platform for your project
+# platform :ios, '9.0'
+
+target 'SearchApertureSwiftUISample' do
+  # Comment the next line if you don't want to use dynamic frameworks
+  use_frameworks!
+
+  # Pods for SearchApertureSwiftUISample
+  pod "Google-SearchInApps-SDK"
+
+end