报告状态

Report State 是一项重要功能,可让 Home 操作主动报告 返回 Google Home Graph,而不是等待 QUERY intent。

Report State 会向 Google 报告用户设备的状态 以及与其关联的指定agentUserId(在原始邮件中发送) SYNC 请求)。当Google Assistant想执行操作时 需要了解设备的当前状态,只需查看 改为在 Home Graph 中查询状态信息 即先向各种第三方云发出QUERY intent,然后再发出 EXECUTE intent。

鉴于来自多个提供商的光源,没有 Report State 使用Ok Google,调亮我的客厅指令需要 解析发送到多个云的多个 QUERY intent, 根据图片中已得到的亮度 。为了提供最佳用户体验, Assistant 需要知道设备的当前状态, 而无需往返设备。

在设备的初始 SYNC 之后,平台会发送 QUERY intent 用于收集设备状态来填充 Home Graph。 在此之后,Home Graph 将仅存储 通过Report State发送。

调用 Report State 时,请务必提供完整的 状态数据。Home Graph在 并在出现以下情况时覆盖该特征的所有数据: Report State 调用。例如,如果您要报告 StartStop 特征的状态,即载荷 需要同时包含 isRunningisPaused 的值。

开始使用

如需实现 Report State,请按以下步骤操作:

启用 Google HomeGraph API

  1. Google Cloud Console 中,前往 HomeGraph API 页面。

    转到 HomeGraph API 页面
  2. 选择与您的 smart home 项目 ID 匹配的项目。
  3. 点击启用

创建服务账号密钥

请按照以下说明通过 Google Cloud Console 生成服务账号密钥:

注意:请确保你在执行以下步骤时使用的 GCP 项目正确无误。这是与您的 smart home 项目 ID 匹配的项目。
  1. Google Cloud Console 中,转到创建服务账号密钥页面。

    转到“创建服务账号密钥”页面
  2. 服务账号列表中,选择创建服务账号
  3. 服务账号名称字段中,输入一个名称。
  4. 服务账号 ID 字段中,输入一个 ID。
  5. 角色列表中,依次选择 Service Accounts > Service Account Token Creator

  6. 对于密钥类型,选择 JSON 选项。

  7. 点击创建。包含密钥的 JSON 文件就会下载到计算机。

调用该 API

从下面的标签页中选择一个选项:

HTTP

Home Graph 提供 HTTP 端点

  1. 使用下载的服务账号 JSON 文件创建 JSON 网络令牌 (JWT)。如需了解详情,请参阅使用服务账号进行身份验证
  2. 使用 oauth2l 获取具有 https://www.googleapis.com/auth/homegraph 范围的 OAuth 2.0 访问令牌:
  3. oauth2l fetch --credentials service-account.json \
      --scope https://www.googleapis.com/auth/homegraph
    
  4. 使用 agentUserId 创建 JSON 请求。 以下是报告状态和通知的 JSON 请求示例:
  5. {
      "requestId": "123ABC",
      "agentUserId": "user-123",
      "payload": {
        "devices": {
          "states": {
            "light-123": {
              "on": true
            }
          }
        }
      }
    }
    
  6. 将报告状态和通知 JSON 与你对 Google Home Graph 端点的 HTTP POST 请求中的令牌合并。作为测试,以下示例演示了如何在命令行中使用 curl 发出请求:
  7. curl -X POST -H "Authorization: Bearer ACCESS_TOKEN" \
      -H "Content-Type: application/json" \
      -d @request-body.json \
      "https://homegraph.googleapis.com/v1/devices:reportStateAndNotification"
    

gRPC

Home Graph 提供 gRPC 端点

  1. 获取 Home Graph API 的协议缓冲区服务定义
  2. 按照 gRPC 开发者文档进行操作,为其中一种受支持的语言生成客户端存根。
  3. 调用 ReportStateAndNotification 方法。

Node.js

Google API Node.js 客户端Home Graph API 提供了绑定。

  1. 使用应用默认凭据初始化 google.homegraph 服务。
  2. 使用 ReportStateAndNotificationRequest 调用 reportStateAndNotification 方法。它会返回一个包含 ReportStateAndNotificationResponsePromise
const homegraphClient = homegraph({
  version: 'v1',
  auth: new GoogleAuth({
    scopes: 'https://www.googleapis.com/auth/homegraph'
  })
});

const res = await homegraphClient.devices.reportStateAndNotification({
  requestBody: {
    agentUserId: 'PLACEHOLDER-USER-ID',
    requestId: 'PLACEHOLDER-REQUEST-ID',
    payload: {
      devices: {
        states: {
          "PLACEHOLDER-DEVICE-ID": {
            on: true
          }
        }
      }
    }
  }
});
    

Java

适用于 Java 的 HomeGraph API 客户端库为 Home Graph API 提供绑定。

  1. 使用应用默认凭据初始化 HomeGraphApiService
  2. 使用 ReportStateAndNotificationRequest 调用 reportStateAndNotification 方法。它会返回一个 ReportStateAndNotificationResponse
  // Get Application Default credentials.
  GoogleCredentials credentials =
      GoogleCredentials.getApplicationDefault()
          .createScoped(List.of("https://www.googleapis.com/auth/homegraph"));

  // Create Home Graph service client.
  HomeGraphService homegraphService =
      new HomeGraphService.Builder(
              GoogleNetHttpTransport.newTrustedTransport(),
              GsonFactory.getDefaultInstance(),
              new HttpCredentialsAdapter(credentials))
          .setApplicationName("HomeGraphExample/1.0")
          .build();

  // Build device state payload.
  Map<?, ?> states = Map.of("on", true);

  // Report device state.
  ReportStateAndNotificationRequest request =
      new ReportStateAndNotificationRequest()
          .setRequestId("PLACEHOLDER-REQUEST-ID")
          .setAgentUserId("PLACEHOLDER-USER-ID")
          .setPayload(
              new StateAndNotificationPayload()
                  .setDevices(
                      new ReportStateAndNotificationDevice()
                          .setStates(Map.of("PLACEHOLDER-DEVICE-ID", states))));
  homegraphService.devices().reportStateAndNotification(request);
}
    

测试报告状态

<ph type="x-smartling-placeholder"></ph>
推荐用于此任务的工具

为了让您的 Action 为认证做好准备,务必要测试 Report State

为此,我们建议使用Home Graph查看器工具 它是一个独立的 Web 应用,无需下载或部署。

Report State信息中心仍然可用, 已弃用且不再受支持。

报告状态信息中心

前提条件

你需要服务账号密钥和 agentUserId 才能测试 Action。如果您已有服务账号密钥并且 agentUserId,请参阅部署 Report State 信息中心

部署报告状态信息中心

获得项目的服务账号密钥和代理用户 ID 后, 从命令行下载并部署最新版本 Report State 信息中心。 下载最新版本后,请按照 包含的 README.MD 文件。

部署 Report State 信息中心后,您即可访问 从以下网址访问信息中心(将 your_project_id 替换为您的 项目 ID):

http://<your-project-id>.appspot.com

在该信息中心内,执行以下操作:

  • 选择你的账号密钥文件
  • 添加你的 agentUserId

然后,点击 List

系统会列出你的所有设备。系统填充列表后,你可以使用 Refresh 按钮更新设备状态。如果设备状态发生更改,则该行会以绿色突出显示。

错误响应

调用 Report State。这些响应以 HTTP 状态的形式 代码。

  • 400 Bad Request - 服务器无法处理 客户端发送的请求,因为语法无效。常见原因 包含格式错误的 JSON 或使用 null 代替 ""指定字符串值。
  • 404 Not Found - 请求的资源无法 但将来可能会提供。通常情况下,这意味着 找不到请求的设备。这可能还意味着 未与 Google 关联,或我们收到的 agentUserId 无效。确保 agentUserIdSYNC 响应,则您的 处理 DISCONNECT intent。