Android Studio 版 Google 助理插件

Google 助理插件可在 Android Studio 内测试应用操作。在开发和测试过程中,您可以使用该插件为您的 Google 帐号在助理中创建应用操作的预览。然后,您可以在提交部署之前测试您的应用操作如何处理各种参数。

工作原理

Google 助理插件包含应用操作测试工具,该工具可以解析您的 shortcuts.xml 文件,并为单个 Google 帐号创建应用操作的预览。这些预览使 Google 助理能够在您的应用生产版本部署到 Google Play 管理中心之前识别您的应用操作。

对于您的 shortcuts.xml 文件中的每个内置 intent (BII),该工具都会呈现相应的 JSON-LD 对象并提供默认参数值。然后,您可以修改这些值,以有意义的参数组合测试您的应用操作,并确保它们执行正确的应用功能。预览在测试工具中创建、更新和删除,让您可以在安全的环境中迭代和测试您的应用操作。

创建预览后,您可以直接从测试工具窗口在测试设备上触发应用操作。对于可供用户触发的 BII,您可以直接在设备上的助理中使用 app name 来试用您的应用操作。例如,您可以说“Ok Google,使用 Example App 开始我的锻炼”来启动一个使用 actions.intent.START_EXERCISE BII 的应用操作。

语言区域支持

在测试工具中为特定语言区域创建预览因 BII 而异。内置 intent 参考中每个 BII 的页面都提供了有关该 BII 可用功能的信息,例如测试工具是否支持为特定语言区域创建预览,以及应用操作是否可供用户触发。

获取插件

Google 助理插件适用于 Android Studio。有关安装和使用 Android Studio 的信息,请参阅 Android Studio 页面。

要在 Android Studio 中安装 Google 助理插件,请按以下步骤操作:

  1. 转到 File > Settings(macOS 上为 Android Studio > Preferences)。
  2. Plugins 部分,转到 Marketplace 并搜索“Google Assistant plugin”。
  3. 安装该工具并重启 Android Studio。

您也可以直接从 Jetbrains 公共存储库下载该插件。

设置要求

使用 Google 助理插件需要执行多项配置步骤,才能成功测试您的应用操作。特别是,您必须在 Android Studio、测试设备和 Google Play 管理中心访问权限中使用相同的用户帐号

使用以下配置准备您的开发环境:

  • 登录 Android Studio(4.0 或更高版本)。
  • 使用同一帐号登录 Android 测试设备上的 Google 应用。
  • 使用同一帐号获取对要测试的已上传应用包的 Play 管理中心访问权限
  • 在 Android 测试设备上打开 Google 应用并完成初始助理设置过程。
  • 在您的测试设备上启用设备数据同步

限制

Google 助理插件有以下限制:

  • 包含网络清单前台应用调用的应用操作无法直接在测试工具中或通过 Android Debug Bridge (adb) 命令进行测试。要测试这些应用操作,请首先使用测试工具创建预览。然后,通过与实体设备上的 Google 助理交互来触发这些应用操作。
  • actions.intent.OPEN_APP_FEATURE BII 的内联清单只能在创建或更新预览后的六小时内进行测试。更新测试工具预览或创建新预览以重置六小时期限。

添加其他测试人员

您可以邀请其他用户加入您的项目,以便他们可以测试您的应用操作集成。当您想与开发团队的其他成员共享项目以供他们全部测试,或者在准备生产发布时与质量保证 (QA) 测试人员共享项目时,这非常有用。测试人员必须在 Google Play 商店中添加为许可测试人员,并授予 Google Play 管理中心只读访问权限。

要添加其他测试人员,请按以下步骤操作:

  1. 登录 Play 管理中心
  2. 按照此 Play 管理中心帮助主题中“设置应用许可”下的说明进行操作。

    Add a license tester via the Google Play Console.
    图 1. 添加许可测试人员。
  3. 将许可测试人员的 Google 帐号邀请为 Google Play 管理中心只读用户。

    1. 选择 User and permissions > Invite new users > Add app
    2. App Access 中,确保 Admin (all permissions) 复选框未选中。

对于您希望启用预览测试的每个测试人员,您必须使用该用户的 Google 帐号单独登录 Android Studio。登录后,使用 Google 助理插件为测试用户创建预览

使用 Google 助理插件

通过导航到 Tools > Google Assistant > App Actions test tool,在 Android Studio 中访问应用操作测试工具。当您打开该工具时,视图会根据您是否有活跃的测试工具预览而改变。

创建、更新和删除预览

您可以使用应用的草稿版本进行测试。有关更多信息,请参阅准备和发布版本。在提交审核之前,请在草稿模式下测试您的应用。

测试工具根据您的 Google 帐号和应用包名称(应用 ID)创建预览,因此您可以使用同一 Google 帐号测试多个应用。只要每个应用的应用 ID 不同,您就可以继续使用同一 Google 帐号进行预览创建和测试。拥有相同应用包访问权限的多个 Google 帐号都可以使用测试工具为该应用创建单独的预览。

要创建预览,请在 Android Studio 中执行以下操作:

  1. 打开应用操作测试工具。
  2. (可选)输入要测试的应用名称和语言区域。默认应用名称和语言区域分别为 test app actionen
  3. 点击 Create Preview。如果出现提示,请查看并接受应用操作政策和服务条款。创建预览后,测试工具窗口将更新以显示在您的 shortcuts.xml 文件中找到的 BII 的信息。

测试工具使用应用名称来构建和模拟您的应用操作的助理查询。已部署的应用操作使用您的 Play 商店应用名称进行调用,但您可以在测试工具中使用任何调用名称。但是,我们建议您在测试工具中使用您的应用名称作为调用名称。

您提供的语言区域必须与测试设备上 Google 助理的语言匹配,并且您一次只能在一个语言区域中创建预览。例如,如果您的助理语言是英语(美国),则可以输入 en-US,但不能输入 en-**en-GBen-US, en-GB。您可以使用根语言区域(例如 en)来包含 en-GBen-US

要更改现有预览的应用名称或选定语言区域,请点击测试工具中的 Delete 按钮。然后,在创建新预览之前输入所需的应用名称和语言区域。

要更新现有预览以匹配您的 shortcuts.xml 文件,请点击测试工具中的 Update 按钮。有关当前预览的信息在测试工具窗口的 Test App Action 部分。

配置 BII

为您的应用创建预览后,您可以在插件中测试 BII 的各种参数值。对于您的 shortcuts.xml 文件中的每个 BII,插件都会呈现相应的 JSON-LD 对象并提供默认参数值。您可以修改这些默认值,以有意义的参数组合测试您的应用操作,并确保它们执行正确的应用功能。

参数及其值通常遵循属性和描述的 schema.orgschema.googleapis.com 结构。您可以通过访问参数及其更高级别参数的架构类型描述来查找有关任何 BII 参数的信息。

例如,actions.intent.GET_FOOD_OBSERVATION BII 支持 intent 参数 foodObservation.forMealMealTypeschema.googleapis.com 页面将 name 列为属性。forMeal 属性是一种传输模式,它期望枚举 MealType 类型的值(例如 MealTypeLunch)。

在测试工具中,您可以提供以下任何枚举作为 foodObservation.forMeal 的值:

  • https://schema.googleapis.com/MealTypeSnack
  • https://schema.googleapis.com/MealTypeBrunch
  • https://schema.googleapis.com/MealTypeLunch
  • https://schema.googleapis.com/MealTypeBreakfast
  • https://schema.googleapis.com/MealTypeDinner
  • https://schema.googleapis.com/MealTypeDesert

触发应用操作

创建预览并配置 BII 后,您可以直接从测试工具窗口在测试设备上触发应用操作。

要使用测试工具触发应用操作,请执行以下操作:

  1. 连接您的测试设备。
  2. Select Target Device 部分,选择您要触发应用操作的设备。
  3. Test App Action 部分,点击 Run App Action 按钮。

在测试工具中触发的应用操作使用显示的 Android 调试桥 (adb) 命令。生成的 adb shell 命令包含 Google 应用执行 BII 所需的所有元数据。此方法模拟助理从查询中提取关键信息后应用操作的行为。

Android Studio 日志记录

测试工具特有的日志可在 Android Studio 日志文件中找到,而不是作为 Logcat 输出。直接在您的工作站上运行的进程会生成 Android Studio 日志。您可以使用它们来排查测试工具操作,例如创建、更新或删除预览。

要访问您的 Android Studio 日志文件,请转到 Help > Show log in explorer(macOS 上为 Help > Show log in finder)。

与您的应用相关联的应用操作日志可在 Logcat 中找到。Logcat 捕获来自连接到 Android Studio 的虚拟或实体设备的日志。

要获取设备的 App Actions 日志,请按照以下步骤操作:

  1. 通过点击 Android Studio 工具窗口栏中的 Logcat 来访问您的 Logcat 日志消息。
  2. 搜索包含 ActivityTaskManager 的日志。

获取支持和其他资源

Google 助理插件提供指向文档、Codelab 和其他资源的链接,用于学习和获取使用测试工具的帮助。

您可以通过选择 Tools > Google Assistant > Help 在 Android Studio 中打开助理。

应用操作测试工具助手 图 2. Google 助理插件的帮助部分。