欢迎使用 Google Home 开发者中心,您可以在这里学习有关如何开发智能家居 Action 的新平台。注意:你将继续在 Actions 控制台中构建操作。

报告状态

使用集合让一切井井有条 根据您的偏好保存内容并对其进行分类。

作为一项重要功能,报告状态可让智能家居 Action 主动将用户设备的最新状态报告回 Google 的 Home Graph,而不是等待 QUERY intent。

状态报告会向 Google 报告与指定 agentUserId 相关联的用户设备的状态(在原始 SYNC 请求中发送)。当 Google 助理要执行一项需要了解设备当前状态的操作时,它可以直接在 Home Graph 中查询状态信息,无需先向各种第三方云发出 QUERY intent,然后再发出 EXECUTE intent。

如果不用报告状态,当客厅中有来自多个提供商的灯时,“Ok Google,调亮客厅的灯”命令需要解析发送到多个云的多个 QUERY intent,而不是根据之前报告的内容直接查询当前的亮度值。为了提供最佳用户体验,Google 助理需要获取设备的当前状态,而无需数据往返设备。

在设备的初始 SYNC 之后,该平台会发送 QUERY intent,用于收集设备的状态来填充 Home Graph。在此之后,Home Graph 仅存储随报告状态一起发送的状态。

调用报告状态时,请务必提供给定特征的完整状态数据。Home Graph 会按特征更新状态,并在调用报告状态时覆盖相应特征的所有数据。例如,如果你要报告 StartStop 特征的状态,则载荷需要同时包含 isRunningisPaused 两者的值。

开始使用

如需实现报告状态,请按以下步骤操作:

启用 Google HomeGraph API

  1. 在 Google Cloud Platform Console 中,转到 HomeGraph API 页面。

    转到 HomeGraph API 页面
  2. 请选择与你的智能家居项目 ID 相匹配的项目。
  3. 点击启用

创建服务帐号密钥

按照以下说明从 GCP Console 生成服务帐号密钥:

注意:请确保你在执行以下步骤时使用的 GCP 项目正确无误。也就是与你的智能家居项目 ID 匹配的项目。
  1. 在 GCP Console 中,转到创建服务帐号密钥页面。

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

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

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

调用该 API

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

HTTP

Home Graph API 提供 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 API 提供 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);
}
    

测试报告状态

为了让你的 Action 为认证做好准备,请务必测试报告状态。

前提条件

你需要服务帐号密钥和 agentUserId 才能测试 Action。如果您已拥有服务帐号密钥和 agentUserId,请参阅部署报告状态信息中心

部署报告状态信息中心

获取项目的服务帐号密钥和 agentUserId 后,从报告状态信息中心下载并部署最新版本。下载最新版本后,请按照随附的 README.MD 文件中的说明进行操作。

部署报告状态信息中心后,可以通过以下网址访问信息中心(将 your_project_id 替换为你的项目 ID):

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

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

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

然后,点击 List

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

错误响应

调用报告状态时,你可能会收到以下某个错误响应。这些响应以 HTTP 状态代码的形式出现。

  • 400 Bad Request - 由于语法无效,服务器无法处理客户端发送的请求。常见原因包括 JSON 格式错误,或者针对字符串值使用 null 而不是 ""。
  • 404 Not Found - 找不到所请求的资源,但将来可能会提供。通常情况下,这意味着我们找不到所请求的设备。这也可能意味着该用户帐号未与 Google 关联,或我们收到的 agentUserId 无效。确保 agentUserIdSYNC 响应中提供的值一致,并且您已正确处理 DISCONNECT intent。