活动

事件是异步的，由 Google Cloud Pub/Sub 进行管理，每个 Project对应一个主题。事件可为所有设备和结构提供更新，并且只要用户未撤消访问令牌且事件消息未过期，系统就会保证收到事件。

允许显示活动

事件是 SDM API 的一项可选功能。请参阅 启用事件 ，了解如何为 Project启用这些事件。

Google Cloud Pub/Sub

如需详细了解 Pub/Sub 的运作方式，请参阅 Google Cloud Pub/Sub 文档。具体而言：

• 通过其方法指南了解 Pub/Sub 的基础知识。
• 了解身份验证的工作原理。
• 选择提供的客户端库， 或自行编写并使用 REST/HTTP 或 gRPC API 途径。

活动订阅

在 2025 年 1 月之前，如果您的 Project启用了事件，系统会为您提供特定于该 Project ID 的主题，格式如下：

projects/gcp-project-name/subscriptions/topic-id

如需接收事件，请根据您的使用情形，为相应主题创建拉取或推送订阅。支持对 SDM 主题进行多次订阅。如需了解详情，请参阅管理订阅。

发起事件

在创建 Pub/Sub 订阅后，如需首次启动事件，请进行 devices.list API 调用作为一次性触发器。在此调用之后，系统将发布所有结构和设备的事件。

如需查看示例，请参阅快速入门指南中的授权页面。

活动顺序

Pub/Sub 不保证按顺序传送事件，并且接收事件的顺序可能与事件实际发生的顺序不一致。使用 timestamp 字段有助于协调事件顺序。事件也可以单独到达，或者合并到单个事件消息中。

如需了解详情，请参阅对消息排序。

用户 ID

如果您的实现是基于用户（而非结构或设备），请使用事件载荷中的 userID 字段来关联资源和事件。此字段是一个模糊处理的 ID，表示特定用户。

您还可以在每次 API 调用的 HTTP 响应标头中找到 userID。

关联事件

关系事件表示资源的关系更新。例如，当设备添加到结构中或从结构中删除时。

关系事件分为三种类型：

• CREATED
• 已删除
• 已更新

关系事件的载荷如下：

{
  "eventId" : "81688b62-4f69-432f-bbe0-5270032f5466",
  "timestamp" : "2019-01-01T00:00:01Z",
  "relationUpdate" : {
    "type" : "CREATED",
    "subject" : "enterprises/project-id/structures/structure-id",
    "object" : "enterprises/project-id/devices/device-id"
  },
  "userId": "AVPHwEuBfnPOnTqzVFT4IONX2Qqhu9EJ4ubO-bNnQ-yi"
}

在关系事件中，object 是触发事件的资源，而 subject 是 object 现在与之建立关系的资源。在上面的示例中， user 已向 developer授予对相应特定设备的访问权限，并且 user的授权设备现在与其授权结构相关联，从而触发了该事件。

subject 只能是房间或结构。如果 a developer 没有查看 user结构的权限，则subject始终为空。

字段

如需详细了解不同类型的事件及其运作方式，请参阅事件。

示例

每种类型的关联事件的事件载荷各不相同：

"relationUpdate" : {
  "type" : "CREATED",
  "subject" : "",
  "object" : "enterprises/project-id/structures/structure-id"
}

"relationUpdate" : {
  "type" : "CREATED",
  "subject" : "enterprises/project-id/structures/structure-id",
  "object" : "enterprises/project-id/devices/device-id"
}

"relationUpdate" : {
  "type" : "CREATED",
  "subject" : "enterprises/project-id/structures/structure-id/rooms/room-id",
  "object" : "enterprises/project-id/devices/device-id"
}

"relationUpdate" : {
  "type" : "UPDATED",
  "subject" : "enterprises/project-id/structures/structure-id/rooms/room-id",
  "object" : "enterprises/project-id/devices/device-id"
}

"relationUpdate" : {
  "type" : "DELETED",
  "subject" : "",
  "object" : "enterprises/project-id/structures/structure-id"
}

"relationUpdate" : {
  "type" : "DELETED",
  "subject" : "enterprises/project-id/structures/structure-id",
  "object" : "enterprises/project-id/devices/device-id"
}

"relationUpdate" : {
  "type" : "DELETED",
  "subject" : "enterprises/project-id/structures/structure-id/rooms/room-id",
  "object" : "enterprises/project-id/devices/device-id"
}

在以下情况下，系统不会发送关联事件：

• 聊天室已删除

资源事件

资源事件表示特定于资源的更新。它可以是对特性字段值发生变化（例如更改温控器的模式）的响应。 它还可以表示不更改特征字段的设备操作，例如按设备按钮。

因特征字段值发生变化而生成的事件包含 traits 对象，类似于设备 GET 调用：

{
  "eventId" : "b5a3cb32-3ca8-4b0b-9510-c6a9e70f00f4",
  "timestamp" : "2019-01-01T00:00:01Z",
  "resourceUpdate" : {
    "name" : "enterprises/project-id/devices/device-id",
    "traits" : {
      "sdm.devices.traits.ThermostatMode" : {
        "mode" : "COOL"
      }
    }
  },
  "userId": "AVPHwEuBfnPOnTqzVFT4IONX2Qqhu9EJ4ubO-bNnQ-yi",
  "resourceGroup" : [
    "enterprises/project-id/devices/device-id"
  ]
}

请参阅各个功能特征的文档，了解任何功能特征字段更改资源事件的载荷格式。

因设备操作而生成的事件（该操作不会更改特征字段）的载荷也包含 resourceUpdate 对象，但包含的是 events 对象，而不是 traits 对象：

{
  "eventId" : "803821e5-2626-41d5-8ea2-04b6fdb88f8c",
  "timestamp" : "2019-01-01T00:00:01Z",
  "resourceUpdate" : {
    "name" : "enterprises/project-id/devices/device-id",
    "events" : {
      "sdm.devices.events.CameraMotion.Motion" : {
        "eventSessionId" : "CjY5Y3VKaTZwR3o4Y19YbTVfMF...",
        "eventId" : "HEQiFiTuneH7NJVZ-kHxnbZyU9...",
      }
    }
  }
  "userId" : "AVPHwEuBfnPOnTqzVFT4IONX2Qqhu9EJ4ubO-bNnQ-yi",
  "eventThreadId" : "d67cd3f7-86a7-425e-8bb3-462f92ec9f59",
  "eventThreadState" : "STARTED",
  "resourceGroup" : [
    "enterprises/project-id/devices/device-id"
  ]
}

这些类型的资源事件在特定特征中定义。例如，运动事件是在 CameraMotion 特征中定义的。请参阅每种特征的文档，了解这些类型的资源事件的载荷格式。

字段

如需详细了解不同类型的事件及其运作方式，请参阅事件。

可更新的通知

选择支持可更新通知的事件功能，并在文档中标记为可更新 。这些事件的载荷中包含一个名为 eventThreadId 的额外字段。使用此字段将各个事件关联起来，以便更新已向用户显示的现有通知。

事件线程与事件会话不同。事件线程用于标识同一线程中之前事件的更新状态。事件会话用于标识相互关联的各个事件，并且一个给定的事件会话可以包含多个事件线程。

出于通知目的，不同类型的事件会分组到不同的线程中。

此线程分组和时间安排逻辑由 Google 处理，并且可能会随时更改。A developer 应根据 SDM API 提供的事件线程和会话更新通知。

线程状态

支持可更新通知的事件还具有 eventThreadState 字段，用于指示相应时间点事件线程的状态。此字段具有以下值：

• STARTED - 事件线程中的第一个事件。
• UPDATED - 持续性事件线程中的事件。单个线程中可以有零个或多个处于此状态的事件。
• ENDED - 事件线程中的最后一个事件，可能是最后一个 UPDATED 事件的重复事件，具体取决于线程类型。

此字段可用于跟踪事件线程的进度以及事件线程何时结束。

事件过滤

在某些情况下，设备检测到的事件可能会被过滤掉，而无法发布到 SDM Pub/Sub 主题。这种行为称为事件过滤。事件过滤的目的是避免在短时间内发布过多的类似事件消息。

例如，系统可能会针对初始运动事件向 SDM 主题发布消息。在此之后，系统会过滤掉与运动相关的其他消息，直到经过一段设定的时间后才会发布这些消息。一旦该时间段过去，系统可能会再次发布相应事件类型的事件消息。

在 Google Home 应用 (GHA) 中，被过滤的事件仍会显示在 user的事件记录中。不过，此类事件不会生成应用通知（即使已启用相应通知类型）。

每种类型的事件都有自己的事件过滤逻辑，该逻辑由 Google 定义，并且随时可能会发生变化。此事件过滤逻辑独立于事件线程和会话逻辑。

服务账号

建议使用服务账号来管理 SDM API 订阅和事件消息。服务账号由应用或虚拟机（而非个人）使用，并且具有自己的唯一账号密钥。

Pub/Sub API 的服务账号授权使用双向 OAuth (2LO)。

在 2LO 授权流程中：

• developer 使用服务密钥请求访问令牌。
• developer 在调用 API 时使用访问令牌。

如需详细了解 Google 2LO 以及如何进行设置，请参阅针对服务器对服务器应用使用 OAuth 2.0。

授权

服务账号应已获得使用 Pub/Sub API 的授权：

1. 在 Google Cloud 中启用 Cloud Pub/Sub API。
2. 按照创建服务账号中的说明创建服务账号和服务账号密钥。 我们建议仅为其授予 Pub/Sub Subscriber 角色。请务必将服务账号密钥下载到将使用 Pub/Sub API 的机器上。
3. 按照上一步中的网页上的说明，向应用代码提供您的身份验证凭据（服务账号密钥），或者使用 oauth2l 手动获取访问令牌（如果您想快速测试 API 访问权限）。
4. 使用服务账号凭据或访问令牌通过 Pub/Sub project.subscriptions API 拉取和确认消息。

oauth2l

Google oauth2l 是一款使用 Go 编写的 OAuth 命令行工具。您可以使用 Go 在 Mac 或 Linux 上安装该工具。

1. 如果您的系统上没有 Go，请先下载并安装它。
2. 安装 Go 后，安装 oauth2l 并将其位置添加到 PATH 环境变量中：

   go install github.com/google/oauth2l@latest
   export PATH=$PATH:~/go/bin

3. 使用 oauth2l 通过适当的 OAuth 范围获取 API 的访问令牌：

   oauth2l fetch --credentials path-to-service-key.json --scope https://www.googleapis.com/auth/pubsub
   https://www.googleapis.com/auth/cloud-platform

   例如，如果您的服务密钥位于 ~/myServiceKey-eb0a5f900ee3.json：

   oauth2l fetch --credentials ~/myServiceKey-eb0a5f900ee3.json --scope https://www.googleapis.com/auth/pubsub
   https://www.googleapis.com/auth/cloud-platform
   ya29.c.Elo4BmHXK5...

如需了解更多使用信息，请参阅 oauth2l README。

Google API 客户端库

有多个适用于 Google API 的客户端库使用 OAuth 2.0。如需详细了解您选择的语言，请参阅 Google API 客户端库。

将这些库与 Pub/Sub API搭配使用时，请使用以下范围字符串：

https://www.googleapis.com/auth/pubsub
https://www.googleapis.com/auth/cloud-platform

错误

以下错误代码可能会与本指南相关联地返回：

如需查看完整的 API 错误代码列表，请参阅 API 错误代码参考文档。