Integrazione di Azioni app con i widget Android

package com.example.exampleapp

//... Other module imports
import com.google.assistant.appactions.widgets.AppActionsWidgetExtension

/**
 * Implementation of App Widget functionality.
 */
object MyAppWidget : AppWidgetProvider() {
    fun updateAppWidget(
        context: Context?,
        appWidgetManager: AppWidgetManager,
        appWidgetId: Int
    ) {
        val appActionsWidgetExtension = AppActionsWidgetExtension.newBuilder(appWidgetManager)
            .setResponseSpeech("Hello world") // TTS to be played back to the user
            .setResponseText("Hello world!") // Response text to be displayed in Assistant
            .build()

        // Update widget with TTS
        appActionsWidgetExtension.updateWidget(appWidgetId)

        // Update widget UI
        appWidgetManager.updateAppWidget(appWidgetId, views)
    }
}

package com.example.exampleapp;

//... Other module imports
import com.google.assistant.appactions.widgets.AppActionsWidgetExtension;

/**
 * Implementation of App Widget functionality.
 */
public class MyAppWidget extends AppWidgetProvider {

  static void updateAppWidget(Context context, AppWidgetManager appWidgetManager,
    int appWidgetId) {

    AppActionsWidgetExtension appActionsWidgetExtension = AppActionsWidgetExtension.newBuilder(appWidgetManager)
      .setResponseSpeech("Hello world")  // TTS to be played back to the user
      .setResponseText("Hello world!")  // Response text to be displayed in Assistant
      .build();

      // Update widget with TTS
      appActionsWidgetExtension.updateWidget(appWidgetId);

      // Update widget UI
      appWidgetManager.updateAppWidget(appWidgetId, views);
    }

}

Consigli di stile per la sintesi vocale

Utilizza i seguenti suggerimenti di stile per ottimizzare il widget personalizzato introduzioni per la sintesi vocale e i prompt visualizzati.

Blocco in Avvio app

La libreria dell'estensione Widgets consente di visualizzare il pulsante Aggiungi questo widget con il widget nell'assistente. Per attivare il blocco, aggiungi il seguente destinatario definizione in AndroidManifest.xml:

<application>
  <receiver android:name="com.google.assistant.appactions.widgets.pinappwidget.PinAppWidgetBroadcastReceiver"
    android:exported="false">
    <intent-filter>
      <action android:name="com.google.assistant.appactions.widgets.COMPLETE_PIN_APP_WIDGET" />
    </intent-filter>
  </receiver>
  <service
    android:name=
    "com.google.assistant.appactions.widgets.pinappwidget.PinAppWidgetService"
    android:enabled="true"
    android:exported="true">
    <intent-filter>
      <action
        android:name="com.google.assistant.appactions.widgets.PIN_APP_WIDGET" />
    </intent-filter>
  </service>
</application>

Disponibilità inventario

Gli intent integrati che supportano l'inventario in linea o l'inventario web possono estendere gli inventari ai completamenti widget.

Inventario in linea

Il seguente codice di un file shortcuts.xml di esempio dimostra una START_EXERCISE Funzionalità degli intent integrati configurato per l'inventario in linea e l'evasione degli ordini widget:

<capability
  android:name="actions.intent.START_EXERCISE">
  <app-widget
    android:identifier="START_EXERCISE_1"
    android:targetClass="com.example.exampleapp.StartExerciseAppWidgetProvider">
    <parameter
      android:name="exercise.name"
      android:key="exerciseName"
      app:shortcutMatchRequired="true">
    </parameter>
  </app-widget>
</capability>

<shortcut android:shortcutId="RunningShortcut">
  <intent
    android:action="android.intent.action.VIEW"
    android:targetClass="com.example.exampleapp.StartExcerciseActivity" />
  <capability-binding
    android:capability="actions.intent.START_EXERCISE"
    android:parameter="exercise.name"
    android:value="running;runs" />
</shortcut>

Nell'esempio precedente, quando un utente attiva questa funzionalità chiedendo l'assistente, "Start running with ExampleApp", il pacchetto di opzioni per Il completamento <app-widget> contiene la seguente coppia chiave-valore:

• Chiave = “exerciseName”
• Valore = “RunningShortcut”

Inventario web

Il seguente codice da un file shortcuts.xml di esempio mostra una funzionalità abilitato per l'inventario web e l'evasione di widget:

<shortcuts>
  <capability
    android:name="actions.intent.START_EXERCISE">
    <app-widget
      android:identifier="START_EXERCISE_1"
      android:targetClass="com.example.exampleapp.CreateTaxiAppWidgetProvider">
      <parameter
        android:name="exercise.name"
        android:key="exerciseName"
        android:mimeType="text/*">
        <data android:pathPattern="https://exampleapp.com/exercise/.*" />
      </parameter>
    </app-widget>
  </capability>
</shortcuts>

Testa Azioni app

Utilizza lo strumento App Actions Test, una funzionalità del plug-in dell'Assistente Google per Android Studio, per testare i widget su un dispositivo fisico o virtuale. Per utilizzare dello strumento di test:

1. Connetti il dispositivo di test all'app in esecuzione.
2. In Android Studio, vai a Strumenti > Azioni app > Test Azioni app strumento.
3. Fai clic su Crea anteprima.
4. Con Android Studio, esegui l'app sul tuo dispositivo di test.
5. Usa l'app Assistente sul dispositivo di test per testare l'Azione app. Per Ad esempio, puoi dire "Hey Google, per quanti chilometri ho corso su ExampleApp?"
6. Osserva il comportamento della tua app o utilizza il debugger di Android Studio per verificare il risultato dell'azione desiderata.

Norme sulla qualità

Questa sezione evidenzia i requisiti chiave e le best practice quando puoi integrare le Azioni app con i widget.

Contenuti nei widget

• (Obbligatorio) Non mostrare gli annunci nei widget.
• Concentra completamente i contenuti del widget sul raggiungimento dell'intento. Azioni sconsigliate prova a soddisfare più intenti con un solo widget o aggiungi contenuti irrilevanti.

Gestire l'autenticazione

• (Obbligatorio) Se è necessaria l'autenticazione dell'utente per completare una procedura, restituire un widget che spiega che l'utente deve continuare nell'app. L'autenticazione utente incorporata nell'Assistente Google non è supportata per l'app Azioni.
• Se gli utenti consentono alla tua app di mostrare dati tramite i widget, puoi restituire un widget degli errori in fase di runtime per gli utenti non autorizzati.

Intent di riserva

• (Obbligatorio) In shortcuts.xml, fornisci sempre un elemento di riserva <intent> oltre al completamento del widget per una capacità assegnata. Un intent di riserva è un elemento <intent> senza alcun requisito <parameter> valori.

  Consente all'assistente di compiere un'azione quando la query dell'utente non contiene i parametri richiesti dall'altro fulfillment gli elementi definiti nella funzionalità. L'eccezione a questa regola è quando non sono parametri richiesti per quella funzionalità, nel qual caso solo il widget il completamento sia necessario.

• Usa l'intent di riserva per aprire la tua app nella schermata pertinente non nella schermata Home.

Il seguente codice di un file shortcuts.xml di esempio dimostra una <capability> con <intent> di riserva a supporto di una principale Evasione dell'ordine <app-widget>:

<shortcuts>
  <capability
    android:name="actions.intent.CREATE_TAXI_RESERVATION">
    <!-- Widget with required parameter, specified using the "android:required" attribute. -->
    <app-widget
      android:identifier="CREATE_TAXI_RESERVATION_1"
      android:targetClass="com.example.myapplication.CreateTaxiAppWidgetProvider">
      <parameter
        android:name="taxiReservation.dropoffLocation.name"
        android:key="dropoff"
        android:required="true">
      </parameter>
    </app-widget>
    <!-- Fallback intent with no parameters required to successfully execute. -->
    <intent
      android:identifier="CREATE_TAXI_RESERVATION_3"
      android:action="myapplication.intent.CREATE_TAXI_RESERVATION_1"
      android:targetClass="com.example.myapplication.TaxiReservationActivity">
    </intent>
  </capability>
</shortcuts>

Informativa sui dati di Google Play

In questa sezione sono elencati i dati degli utenti finali raccolti dall'ultima versione del libreria dell'estensione Widgets.

Questo SDK invia risposte di sintesi vocale (TTS) fornite dallo sviluppatore che sono annunciati all'utente dall'Assistente Google tramite la voce dell'assistente tecnologia. Queste informazioni non vengono memorizzate da Google.

Le Azioni app potrebbero anche raccogliere i metadati dell'app client per i seguenti scopi:

• Per monitorare i tassi di adozione di diverse versioni dell'SDK.
• Per quantificare l'utilizzo delle funzionalità dell'SDK nelle app.