API Permissions su Android

Prima di utilizzare una delle API Home per Android, l'app deve disporre dell'autorizzazione per accedere ai dispositivi nella casa dell'utente, indicata nell'API come struttura. Con l'API Permissions, l'utente può, utilizzando il proprio Account Google, concedere alle app API Home l'accesso ai dispositivi della propria casa.

Il flusso di autorizzazioni consente all'utente di creare una struttura se non è già stata configurata, senza dover utilizzare Google Home app (GHA).

Integra l'API Permissions

Prima di continuare, assicurati di aver seguito la procedura Inizializzare la casa su Android. L'istanza homeManager di questo passaggio viene utilizzata in tutti gli esempi di autorizzazioni riportati di seguito.

Per prima cosa, registra un ActivityResultCaller con l'SDK. Ad esempio, ecco come viene gestito dall'app di esempio:

override fun onCreate(savedInstanceState: Bundle?) {
    super.onCreate(savedInstanceState)
    homeManager.registerActivityResultCallerForPermissions(this)
  }

Controllare le autorizzazioni

Prima di richiedere le autorizzazioni, ti consigliamo di verificare se l'utente dell'app ha già concesso il consenso per accedere alla struttura. Per farlo, chiama il metodo hasPermissions() dell'istanza Home per ottenere un Flow di valori PermissionsState:

val permissionsReadyState =
homeManager.hasPermissions().collect { state ->
    when (state) {
      PermissionsState.GRANTED -> println("Permissions granted, no need to request permissions")
      PermissionsState.PERMISSIONS_STATE_UNAVAILABLE ->
          println("Permissions state unavailable, request permissions")

      PermissionsState.NOT_GRANTED ->
          println("OAuth permission is enabled but not granted yet, request permissions")

      PermissionsState.PERMISSIONS_STATE_UNINITIALIZED -> println(
          "Permissions state is not initialized yet. Clients should wait for another status update"
      )
      else ->
          throw IllegalStateException("""
            HomeClient.hasPermissions state should be PermissionsState.GRANTED,
            PermissionState.PERMISSIONS_STATE_UNINITIALIZED, or
            PermissionsState.PERMISSIONS_STATE_UNAVAILABLE. Actual state: $state
          """.trimIndent())
    }
}

Se il controllo restituisce un PermissionsState di NOT_GRANTED o PERMISSIONS_STATE_UNAVAILABLE, significa che l'utente o l'applicazione non ha accesso alla struttura. Se il controllo restituisce un PermissionsState di GRANTED, ma una chiamata successiva a structures() non restituisce strutture, significa che l'utente ha revocato l'accesso all'app tramite la pagina delle impostazioni GHA oppure che l'utente non dispone dell'accesso richiesto.

Richiedi autorizzazioni

Per accedere alle strutture e ai dispositivi all'interno di una determinata struttura, è necessario concedere l'autorizzazione alla tua app.

Se l'utente non ha ancora concesso le autorizzazioni, utilizza il metodo requestPermissions() dell'istanza Home per avviare l'interfaccia utente delle autorizzazioni ed elaborare il risultato:

fun requestPermissions(scope: CoroutineScope, onShowSnackbar: (String) -> Unit) {
  scope.launch {
    val result =
      try {
        homeManager.requestPermissions()
      } catch (e: HomeException) {
        PermissionsResult(
          PermissionsResultStatus.ERROR,
          "Got HomeException with error: ${e.message}",
        )
      }
    when (result.status) {
      PermissionsResultStatus.SUCCESS -> {
        Log.i(TAG, "Permissions successfully granted.")
      }
      PermissionsResultStatus.CANCELLED -> {
        Log.i(TAG, "User cancelled Permissions flow.")
        onShowSnackbar("User cancelled Permissions flow")
      }
      else -> {
        Log.e(
          TAG,
          "Failed to grant permissions with error: ${result.status}, ${result.errorMessage}",
        )
        onShowSnackbar("Failed to grant permissions with error: ${result.errorMessage}")
      }
    }
  }
}

Per avviare correttamente l'interfaccia utente delle autorizzazioni, devi aver già configurato OAuth per la tua app.

Concedi le autorizzazioni

Ora dovresti essere in grado di eseguire l'app e fare in modo che un utente conceda le autorizzazioni. Il tipo di utenti che possono concedere l'autorizzazione e i tipi di dispositivi disponibili per concedere le autorizzazioni variano a seconda che tu abbia registrato la tua app in Google Home Developer Console.

La registrazione di Developer Console è obbligatoria per pubblicare un'app utilizzando le API Home. Non è necessario testare e utilizzare le API per la casa.

Se un'app non è registrata in Developer Console, si troverà in stato non verificato. Questo è consigliato per testare l'utilizzo delle API per la casa:

• Solo gli utenti registrati come utenti di test nella console OAuth possono concedere le autorizzazioni per l'app. Esiste un limite di 100 utenti di test per un'app non verificata.

• Un'app non verificata avrà accesso ai dispositivi di qualsiasi tipo supportato da OAuth per le API Home (l'elenco dei tipi di dispositivi in Developer Console). Verranno concessi tutti i dispositivi in una struttura.

Se un'app è registrata in Developer Console e è stata approvata per l'accesso a uno o più tipi di dispositivi e la verifica del brand è stata completata per OAuth, si troverà nello stato verificato. Questo stato è necessario per il lancio di un'app in produzione:

• I limiti per gli utenti di test non vengono più applicati. Qualsiasi utente può concedere l'autorizzazione all'app.
• L'utente può concedere l'autorizzazione solo ai tipi di dispositivi approvati nel Developer Console.

Ora che OAuth è configurato, la chiamata dell'app a requestPermissions() attiva le seguenti finestre di dialogo:

1. All'utente viene chiesto di selezionare l'Account Google che vuole utilizzare.
2. All'utente viene chiesto di selezionare la casa a cui vuole concedere l'accesso all'app.
   1. Per un'app non verificata, tutti i tipi di dispositivi supportati dalle API Home sono disponibili per l'app.
   2. Per un'app verificata, l'utente può concedere l'autorizzazione solo ai tipi di dispositivi approvati in Developer Console.
   3. Per i tipi di dispositivi sensibili che l'app può gestire, l'utente può limitare l'accesso in base al dispositivo. Ad esempio, se un utente ha tre serrature, può concedere l'accesso a una sola di queste.

Una volta concesso, l'app può utilizzare le API Home per leggere lo stato e controllare i dispositivi nella struttura. Se l'utente non concede l'autorizzazione all'app per un particolare tipo di dispositivo o dispositivo sensibile, l'app non potrà utilizzare le API Home per accedervi, controllarlo o automatizzarlo.

Modifica autorizzazioni

Per concedere l'autorizzazione ad accedere ai dispositivi in una struttura diversa, è possibile avviare il selettore di account per consentire all'utente di scegliere l'Account Google e la struttura a cui passare. Durante questa procedura, all'utente verrà mostrata di nuovo la schermata per il consenso, anche se il consenso è stato concesso in precedenza.

Per farlo, chiama di nuovo requestPermissions() con il flag forceLaunch impostato su true:

homeManager.requestPermissions(forceLaunch=true)

Modificare le autorizzazioni con i suggerimenti sulla struttura

I suggerimenti sulla struttura consentono a un'app di preselezionare una struttura specifica o di limitare l'elenco delle strutture disponibili quando richiede una modifica incrementale alle autorizzazioni delle API Home dell'utente. Se trasmetti i parametri della struttura nella richiesta di autorizzazione, la finestra di dialogo delle autorizzazioni si concentrerà automaticamente sulla struttura scelta, riducendo l'attrito per gli utenti e prevenendo errori di configurazione.

Il suggerimento della struttura viene gestito utilizzando la classe di dati ConsentScreenOptions. La classe ConsentScreenOptions accetta i seguenti parametri di configurazione:

• structureId: l'ID struttura specifico da preselezionare nella finestra di dialogo delle autorizzazioni. Per ottenerlo, controlla le proprietà della struttura per la struttura in fase di aggiornamento.
• allowedStructureIds: un elenco di ID struttura. Se fornito, il dialogo dell'autorizzazione filtrerà le strutture disponibili per mostrare solo quelle in questo elenco. Nella maggior parte dei casi, questo campo può essere lasciato non specificato, a meno che tu non voglia assicurarti che l'utente rimanga all'interno di un elenco di strutture già concesse.
• allowStructureChange: determina se l'utente è autorizzato a modificare la struttura preselezionata. Imposta questo valore su true se almeno uno tra allowedStructureIds e structureId è specificato nella maggior parte dei casi per supportare il comportamento naturale dell'utente.

Passa questo oggetto come parametro facoltativo nella chiamata requestPermissions(), con il flag forceLaunch impostato su true:

import com.google.home.ConsentScreenOptions

// Create the ConsentScreenOptions class, allowing structure changes while
// ensuring the permissions dialog pre-selects the target structure on launch
val consentOptions = ConsentScreenOptions(
    structureId = target-structure-id,
    allowStructureChange = true
)

homeManager.requestPermissions(forceLaunch=true, consentOptions)

L'utente visualizzerà la schermata per il consenso già filtrata in base alla struttura indicata nell'oggetto ConsentScreenOptions.

Consenti all'utente di cambiare struttura con i suggerimenti

Se un utente ha più strutture in un'app e vuoi preselezionarne una consentendogli comunque di passare da una struttura all'altra, attiva le modifiche alla struttura con il flag allowStructureChange e fornisci un elenco di strutture in allowedStructureIds:

val consentOptions = ConsentScreenOptions(
    structureId = target-structure-id,
    allowedStructureIds = listOf(target-structure-id, another-structure-id),
    allowStructureChange = true
)

Revoca delle autorizzazioni

Gli utenti possono revocare l'accesso concesso in precedenza:

1. Tramite la pagina Il mio account Google > Dati e privacy > Servizi e app di terze parti. Verrà revocato il token OAuth emesso al momento della concessione del consenso iniziale e verrà revocato l'accesso a qualsiasi istanza dell'app che l'utente stava utilizzando su tutte le piattaforme (smartphone) e strutture.

   L'utente potrebbe essere indirizzato con un deep link alla pagina secondaria App e servizi di terze parti utilizzando il seguente schema URL:

   https://myaccount.google.com/connections/link?project_number=Cloud project_number
   

2. Tramite la pagina GHA > Impostazioni > App collegate. Se fai clic su settings in GHA, si aprirà la pagina Impostazioni. Da qui, fai clic sul riquadro App collegate, che ti reindirizza a una pagina simile alla schermata per il consenso. Da questa pagina l'utente può rimuovere l'accesso all'app. L'utente può utilizzare questa stessa pagina per modificare i tipi di dispositivi o i dispositivi sensibili specifici accessibili all' app.

Visualizzare i tipi di dispositivi per cui un utente ha concesso le autorizzazioni

Nell'ecosistema Google Home, per la maggior parte dei tipi di dispositivi, gli utenti possono concedere le autorizzazioni per tutti i dispositivi di quel tipo contemporaneamente. Per i tipi di dispositivi sensibili o con limitazioni, come serrature, videocamere o campanelli, gli utenti devono concedere l'autorizzazione singolarmente.

Per determinare se un utente ha concesso l'autorizzazione per accedere a un tipo di dispositivo sensibile o con limitazioni, utilizza la funzione consentedDeviceTypes() a livello di struttura:

import com.google.home.Structure
import com.google.home.DeviceType
import com.google.home.DeviceTypeFactory
import com.google.home.consentedDeviceTypes // Extension function from the SDK
import kotlinx.coroutines.flow.Flow
import kotlinx.coroutines.flow.collect
import kotlinx.coroutines.launch

/**
 * Example of how an app may monitor which device types have been granted access by a user.
 */
fun monitorDeviceConsent(structure: Structure, myScope: CoroutineScope) {
    // Obtain the flow of consented device type factories
    val consentedTypesFlow: Flow<Set<DeviceTypeFactory<out DeviceType>>> =
        structure.consentedDeviceTypes()

    myScope.launch {
        consentedTypesFlow.collect { consentedSet ->
            // Check if the user has consented to share a specific restricted
            // type, such as a Doorbell or Camera.
            val hasCameraAccess = consentedSet.any {
                it.toString() == "matter.google.type.GoogleDoorbellDevice"
            }

            if (hasCameraAccess) {
                // Enable features that require camera access
            } else {
                // Inform the user or disable camera-specific features
            }
        }
    }
}

Autorizzazioni Ok Google

Il comando okGoogle è un comando a livello di dispositivo e può essere utilizzato per automatizzare qualsiasi dispositivo nella struttura. Tuttavia, un'app API Home potrebbe non avere accesso a tutti i dispositivi. La tabella seguente descrive come vengono applicate le autorizzazioni in questi casi.

Indicazioni se l'utente revoca tutte le autorizzazioni

Se l'utente revoca le autorizzazioni complete, tutte le automazioni esistenti smetteranno di funzionare. Inoltre, se l'utente revoca l'accesso a dispositivi specifici, i comandi iniziali, le condizioni e le azioni associati a questi dispositivi smetteranno di funzionare.

Ogni volta che l'app viene avviata, assicurati che le autorizzazioni siano ancora attive. Se sono state revocate, assicurati che tutti i dati precedenti vengano rimossi, inclusi quelli memorizzati nella cache dell'applicazione.