App-Aktionen in Android-Widgets einbinden

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);
    }

}

Stilempfehlungen für Text-in-Sprache

Mit den folgenden Stilempfehlungen können Sie Ihr benutzerdefiniertes Widget optimieren Einführung in Sprachausgabe und angezeigte Prompts

Launcher-Anpinnen

In der Widget-Erweiterungsbibliothek kann die Schaltfläche Dieses Widget hinzufügen angezeigt werden. mit deinem Widget in Assistant. Füge den folgenden Empfänger hinzu, um das Anpinnen zu aktivieren Definition für 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>

Inventarverfügbarkeit

BIIs, die Inline-Inventar oder Webinventar unterstützen, können diese zu Ihren Widget-Ausführungen hinzufügen.

Inline-Inventar

Der folgende Code aus einer shortcuts.xml-Beispieldatei veranschaulicht, START_EXERCISE BII-Funktion konfiguriert für Inline-Inventar und Widget-Auftragsausführung:

<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>

Wenn im obigen Beispiel ein Nutzer diese Funktion auslöst, indem er Assistant, „Start running with ExampleApp“, das Options-Bundle für das Die <app-widget>-Auftragsausführung enthält das folgende Schlüssel/Wert-Paar:

• Schlüssel = “exerciseName”
• Wert = “RunningShortcut”

Webinventar

Der folgende Code aus der Beispieldatei shortcuts.xml zeigt eine Funktion, aktiviert für Webinventar und Widget-Ausführung:

<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>

App Actions testen

Verwenden Sie das App Actions-Testtool, eine Funktion des Google Assistant-Plug-ins für Android Studio, um Widgets auf einem physischen oder virtuellen Gerät zu testen Zur Verwendung Test-Tool verwenden, gehen Sie folgendermaßen vor:

1. Verbinden Sie das Testgerät mit der laufenden App.
2. Gehen Sie in Android Studio zu Tools > App Actions > App Actions-Test Tool.
3. Klicken Sie auf Vorschau erstellen.
4. Führen Sie Ihre App mit Android Studio auf Ihrem Testgerät aus.
5. Verwende die Assistant App auf deinem Testgerät, um deine App Action zu testen. Für zum Beispiel „Hey Google, wie viele Kilometer bin ich gelaufen?“ diese Woche bei ExampleApp?“
6. Beobachten Sie das Verhalten Ihrer App oder verwenden Sie den Android Studio-Debugger, um um das gewünschte Aktionsergebnis zu verifizieren.

Qualitätsrichtlinien

In diesem Abschnitt werden die wichtigsten Anforderungen und Best Practices für integrierst du App Actions in Widgets.

Inhalte in Widgets

• (Erforderlich) In Ihren Widgets dürfen keine Anzeigen eingeblendet werden.
• Der Widget-Inhalt sollte sich ganz darauf konzentrieren, die Absicht zu erfüllen. Das sollten Sie nicht tun: mit einem Widget mehrere Intents zu erreichen oder irrelevante Inhalte hinzuzufügen.

Authentifizierung verarbeiten

• (Erforderlich) Wenn die Nutzerauthentifizierung zum Abschließen eines Nutzerflusses erforderlich ist, ein Widget zurückgeben, das erklärt, dass der Nutzer mit der App fortfahren muss. Die Inline-Nutzerauthentifizierung in Google Assistant wird für die App nicht unterstützt Aktionen.
• Wenn Nutzer zulassen, dass deine App Daten mithilfe von Widgets anzeigt, kannst du eine Fehler-Widget zur Laufzeit für nicht autorisierte Nutzer.

Fallback-Intents

• (Erforderlich) Geben Sie in der Datei shortcuts.xml immer ein Fallback an. <intent> zusätzlich zu deiner Widget-Ausführung für ein über die gegebene Fähigkeit verfügt. Ein Fallback-Intent ist ein <intent>-Element, für das keine <parameter>-Werte.

  So kann Assistant eine Aktion ausführen, wenn Die Nutzerabfrage enthält keine Parameter, die für die andere Auftragsausführung erforderlich sind. Elemente, die in der Capability definiert sind. Hiervon ausgenommen sind keine erforderliche Parameter für diese Funktion. In diesem Fall wird nur das Widget Erfüllung ist erforderlich.

• Verwenden Sie den Fallback-Intent, um den entsprechenden Bildschirm in Ihrer App zu öffnen. nicht den Startbildschirm.

Der folgende Code aus einer shortcuts.xml-Beispieldatei veranschaulicht, <capability> mit einem Fallback-<intent>, der eine primäre Auftragsausführung in Höhe von <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>

Offenlegung von Daten bei Google Play

In diesem Abschnitt werden die Endnutzerdaten aufgeführt, die von der neuesten Version des Widget-Erweiterungsbibliothek.

Dieses SDK sendet vom Entwickler bereitgestellte Sprachausgabe-Antworten, die werden dem Nutzer von Google Assistant per Spracheingabe angesagt Technologie. Diese Informationen werden nicht von Google gespeichert.

App-Aktionen können auch Metadaten von Clientanwendungen für folgende Zwecke erfassen:

• Sie können die Akzeptanzraten verschiedener SDK-Versionen überwachen.
• Bezifferung der Nutzung von SDK-Funktionen in Apps