Интегрируйте действия приложения с виджетами 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);
    }

}

Рекомендации по стилю TTS

Используйте следующие рекомендации по стилю, чтобы оптимизировать представление пользовательских виджетов для TTS и отображаемых подсказок.

Закрепление лаунчера

Библиотека расширений виджетов позволяет отображать кнопку «Добавить этот виджет» вместе с вашим виджетом в Ассистенте. Чтобы включить закрепление, добавьте следующее определение получателя в 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>

Доступность инвентаря

BII, поддерживающие встроенную инвентаризацию или веб-инвентаризацию, могут расширить эти инвентаризации для выполнения ваших виджетов.

Встроенный инвентарь

Следующий код из примера файла shortcuts.xml демонстрирует возможность START_EXERCISE BII, настроенную для встроенной инвентаризации и выполнения виджетов:

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

В предыдущем примере, когда пользователь запускает эту возможность, спрашивая Ассистента: «Начните работу с примером приложения», пакет опций для выполнения <app-widget> содержит следующую пару ключ-значение:

• Ключ = “exerciseName”
• Значение = “RunningShortcut”

Веб-инвентаризация

Следующий код из примера файла shortcuts.xml показывает возможность, включенную для веб-инвентаризации и выполнения виджетов:

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

Действия тестового приложения

Используйте инструмент тестирования действий приложения — функцию плагина Google Assistant для Android Studio — для тестирования виджетов на физическом или виртуальном устройстве. Чтобы использовать инструмент тестирования, выполните следующие действия:

1. Подключите тестовое устройство с работающим приложением.
2. В Android Studio выберите «Инструменты» > «Действия приложения» > «Инструмент проверки действий приложения» .
3. Нажмите Создать предварительный просмотр .
4. Используя Android Studio, запустите приложение на тестовом устройстве.
5. Используйте приложение «Ассистент» на тестовом устройстве, чтобы протестировать действие приложения. Например, вы можете сказать что-то вроде : «Окей, Google, сколько миль я пробежал на этой неделе с помощью приложения exampleApp?»
6. Наблюдайте за поведением своего приложения или используйте отладчик Android Studio , чтобы проверить желаемый результат действия.

Рекомендации по качеству

В этом разделе освещаются основные требования и рекомендации по интеграции действий приложения с виджетами.

Контент в виджетах

• ( Обязательно ) Не ​​показывать рекламу в виджетах.
• Сосредоточьте содержимое виджета полностью на достижении цели. Не пытайтесь реализовать несколько целей с помощью одного виджета или добавлять нерелевантный контент.

Обработка аутентификации

• ( Обязательно ) Если для завершения пользовательского потока необходима аутентификация пользователя, верните виджет, объясняющий, что пользователю необходимо продолжить работу в приложении. Встроенная аутентификация пользователя в Google Assistant не поддерживается для действий приложения.
• Если пользователи разрешают вашему приложению отображать данные с помощью виджетов, вы можете вернуть виджет ошибки во время выполнения для неавторизованных пользователей.

Резервные намерения

• ( Обязательно ) В файле shortcuts.xml всегда указывайте резервный <intent> в дополнение к выполнению виджета для заданной возможности. Резервное намерение — это элемент <intent> без обязательных значений <parameter> .

  Это позволяет Помощнику выполнять действие, когда пользовательский запрос не содержит параметров, требуемых другими элементами выполнения, определенными в этой возможности. Исключением является случай, когда для этой возможности нет обязательных параметров, и в этом случае требуется только выполнение виджета.

• Используйте резервное намерение, чтобы открыть приложение на соответствующем экране, а не на главном экране.

Следующий код из примера файла shortcuts.xml демонстрирует <capability> с резервным <intent> , поддерживающим основное выполнение <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>

Раскрытие данных Google Play

В этом разделе перечислены данные конечных пользователей, собранные последней версией библиотеки расширений виджетов.

Этот SDK отправляет предоставленные разработчиком ответы преобразования текста в речь (TTS), которые объявляются пользователю Google Assistant с использованием речевой технологии Assistant. Эта информация не хранится в Google.

Действия приложения также могут собирать метаданные клиентского приложения для следующих целей:

• Для мониторинга темпов внедрения различных версий SDK.
• Для количественной оценки использования функций SDK в приложениях.