Trang này được dịch bởi Cloud Translation API.

Sự kiện

Các sự kiện không đồng bộ và do Google Cloud Pub/Sub quản lý, trong một chủ đề duy nhất cho mỗi Project. Sự kiện cung cấp thông tin cập nhật cho tất cả thiết bị và cấu trúc, đồng thời đảm bảo việc nhận được sự kiện miễn là người dùng không thu hồi mã thông báo truy cập và thông báo sự kiện chưa hết hạn.

Bật sự kiện

Sự kiện là một tính năng không bắt buộc của API SDM. Hãy xem bài viết Bật sự kiện để tìm hiểu cách bật sự kiện cho Project.

Google Cloud Pub/Sub

Hãy xem tài liệu về Google Cloud Pub/Sub để tìm hiểu thêm về cách hoạt động của Pub/Sub. Cụ thể:

Tìm hiểu kiến thức cơ bản về Pub/Sub qua Hướng dẫn cách thực hiện.
Tìm hiểu cách hoạt động của tính năng Xác thực.
Chọn một Thư viện ứng dụng được cung cấp hoặc tự viết thư viện của riêng bạn và sử dụng giao diện API REST/HTTP hoặc gRPC.

Đăng ký sự kiện

Khi bật sự kiện cho Project, bạn sẽ được cung cấp một chủ đề dành riêng cho mã Project đó, ở dạng:

projects/sdm-prod/topics/enterprise-project-id

Để nhận sự kiện, hãy tạo gói thuê bao kéo hoặc đẩy cho chủ đề đó, tuỳ thuộc vào trường hợp sử dụng của bạn. Hỗ trợ nhiều gói thuê bao cho chủ đề SDM. Hãy xem phần Quản lý gói thuê bao để biết thêm thông tin.

Bắt đầu sự kiện

Để bắt đầu sự kiện lần đầu tiên sau khi tạo gói thuê bao Pub/Sub, hãy tạo lệnh gọi API devices.list làm trình kích hoạt một lần. Các sự kiện cho tất cả cấu trúc và thiết bị sẽ xuất bản sau lệnh gọi này.

Ví dụ: hãy xem trang Uỷ quyền trong Hướng dẫn bắt đầu nhanh.

Thứ tự sự kiện

Pub/Sub không đảm bảo việc phân phối sự kiện theo thứ tự và thứ tự nhận sự kiện có thể không tương ứng với thứ tự sự kiện thực sự xảy ra. Sử dụng trường timestamp để hỗ trợ việc điều chỉnh thứ tự sự kiện. Các sự kiện cũng có thể đến riêng lẻ hoặc được kết hợp thành một thông báo sự kiện duy nhất.

Để biết thêm thông tin, hãy xem phần Sắp xếp thông báo.

Mã nhận dạng người dùng

Nếu quá trình triển khai của bạn dựa trên người dùng (thay vì cấu trúc hoặc thiết bị), hãy sử dụng trường userID từ tải trọng sự kiện để liên kết tài nguyên và sự kiện. Trường này là một mã nhận dạng đã làm rối mã nguồn đại diện cho một người dùng cụ thể.

userID cũng có trong tiêu đề phản hồi HTTP của mỗi lệnh gọi API.

Sự kiện liên quan

Sự kiện liên quan thể hiện nội dung cập nhật liên quan cho một tài nguyên. Ví dụ: khi một thiết bị được thêm vào một cấu trúc hoặc khi một thiết bị bị xoá khỏi một cấu trúc.

Có 3 loại sự kiện liên quan:

ĐÃ TẠO
ĐÃ XÓA
ĐÃ CẬP NHẬT

Tải trọng cho sự kiện liên quan như sau:

Dung lượng

{
  "eventId" : "d5c0f0bd-de65-44fd-ac60-686c302e56eb",
  "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"
}

Trong một sự kiện liên quan, object là tài nguyên đã kích hoạt sự kiện và subject là tài nguyên mà object hiện có mối quan hệ. Trong ví dụ trên, user đã cấp quyền truy cập vào thiết bị cụ thể này cho developervà thiết bị được uỷ quyền của userhiện liên quan đến cấu trúc được uỷ quyền của họ, điều này sẽ kích hoạt sự kiện.

subject chỉ có thể là một phòng hoặc một cấu trúc. Nếu a developer không có quyền xem cấu trúc của user, thì subject sẽ luôn trống.

Trường

Trường	Mô tả	Loại dữ liệu
`eventId`	Giá trị nhận dạng duy nhất của sự kiện.	`string` Ví dụ: "64b87b46-1aec-42a4-8c01-997a407814df"
`timestamp`	Thời gian xảy ra sự kiện.	`string` Ví dụ: "2019-01-01T00:00:01Z"
`relationUpdate`	Một đối tượng cung cấp thông tin chi tiết về nội dung cập nhật mối quan hệ.	`object`
`userId`	Giá trị nhận dạng duy nhất, được làm rối mã nguồn đại diện cho người dùng.	`string` Ví dụ: "AVPHwEuBfnPOnTqzVFT4IONX2Qqhu9EJ4ubO-bNnQ-yi"

Hãy xem phần Sự kiện để biết thêm thông tin về các loại sự kiện và cách hoạt động của các sự kiện đó.

Ví dụ

Trọng tải sự kiện khác nhau tuỳ theo từng loại sự kiện liên quan:

ĐÃ TẠO

Đã tạo cấu trúc

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

Thiết bị đã được tạo

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

Thiết bị đã được tạo

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

ĐÃ CẬP NHẬT

Thiết bị đã được di chuyển

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

ĐÃ XÓA

Cấu trúc đã bị xoá

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

Đã xoá thiết bị

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

Đã xoá thiết bị

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

Sự kiện liên quan sẽ không được gửi khi:

Xoá phòng

Sự kiện tài nguyên

Sự kiện tài nguyên đại diện cho một nội dung cập nhật dành riêng cho một tài nguyên. Lệnh này có thể là để phản hồi một thay đổi trong giá trị của trường đặc điểm, chẳng hạn như thay đổi chế độ của máy điều nhiệt. Thuộc tính này cũng có thể biểu thị một thao tác trên thiết bị không thay đổi trường thuộc tính, chẳng hạn như nhấn nút trên thiết bị.

Một sự kiện được tạo để phản hồi sự thay đổi về giá trị của trường đặc điểm chứa một đối tượng traits, tương tự như lệnh gọi GET của thiết bị:

Dung lượng

{
  "eventId" : "a88bc884-d2b8-42d6-adba-b7be92c232a3",
  "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"
  ]
}

Hãy sử dụng tài liệu về từng đặc điểm để hiểu định dạng tải trọng cho mọi sự kiện thay đổi tài nguyên trường đặc điểm.

Một sự kiện được tạo để phản hồi một hành động của thiết bị không thay đổi trường đặc điểm cũng có tải trọng với đối tượng resourceUpdate, nhưng với đối tượng events thay vì đối tượng traits:

Dung lượng

{
  "eventId" : "4f80de08-1b77-42a4-b33e-40876a2a1865",
  "timestamp" : "2019-01-01T00:00:01Z",
  "resourceUpdate" : {
    "name" : "enterprises/project-id/devices/device-id",
    "events" : {
      "sdm.devices.events.CameraMotion.Motion" : {
        "eventSessionId" : "CjY5Y3VKaTZwR3o4Y19YbTVfMF...",
        "eventId" : "MWJ253hZMPAsJZJWbrGM4ThsKM...",
      }
    }
  }
  "userId" : "AVPHwEuBfnPOnTqzVFT4IONX2Qqhu9EJ4ubO-bNnQ-yi",
  "eventThreadId" : "d67cd3f7-86a7-425e-8bb3-462f92ec9f59",
  "eventThreadState" : "STARTED",
  "resourceGroup" : [
    "enterprises/project-id/devices/device-id"
  ]
}

Những loại sự kiện tài nguyên này được xác định trong các đặc điểm cụ thể. Ví dụ: sự kiện Chuyển động được xác định trong đặc điểm CameraMotion . Hãy xem tài liệu của từng đặc điểm để hiểu định dạng tải trọng cho các loại sự kiện tài nguyên này.

Trường

Trường	Mô tả	Loại dữ liệu
`eventId`	Giá trị nhận dạng duy nhất của sự kiện.	`string` Ví dụ: "4f80de08-1b77-42a4-b33e-40876a2a1865"
`timestamp`	Thời gian xảy ra sự kiện.	`string` Ví dụ: "2019-01-01T00:00:01Z"
`resourceUpdate`	Một đối tượng cung cấp thông tin chi tiết về nội dung cập nhật tài nguyên.	`object`
`userId`	Giá trị nhận dạng duy nhất, được làm rối mã nguồn đại diện cho người dùng.	`string` Ví dụ: "AVPHwEuBfnPOnTqzVFT4IONX2Qqhu9EJ4ubO-bNnQ-yi"
`eventThreadId`	Giá trị nhận dạng duy nhất của luồng sự kiện.	`string` Ví dụ: "d67cd3f7-86a7-425e-8bb3-462f92ec9f59"
`eventThreadState`	Trạng thái của luồng sự kiện.	`string` Giá trị: "STARTED" (BẮT ĐẦU), "UPDATED" (CẬP NHẬT), "ENDED" (KẾT THÚC)
`resourceGroup`	Một đối tượng cho biết các tài nguyên có thể có nội dung cập nhật tương tự như sự kiện này. Tài nguyên của chính sự kiện (từ đối tượng `resourceUpdate`) sẽ luôn có trong đối tượng này.	`object`

Hãy xem phần Sự kiện để biết thêm thông tin về các loại sự kiện và cách hoạt động của các sự kiện đó.

Thông báo có thể cập nhật

Bạn có thể triển khai thông báo dựa trên sự kiện tài nguyên trong một ứng dụng, chẳng hạn như cho Android hoặc iOS. Để giảm số lượng thông báo được gửi, bạn có thể triển khai một tính năng có tên là thông báo có thể cập nhật, trong đó thông báo hiện có được cập nhật bằng thông tin mới dựa trên các sự kiện tiếp theo trong cùng một luồng sự kiện.

Một số sự kiện được hỗ trợ tính năng thông báo có thể cập nhật và được gắn thẻ là Có thể cập nhật trong tài liệu. Các sự kiện này có một trường bổ sung tên là eventThreadId trong tải trọng. Sử dụng trường này để liên kết các sự kiện riêng lẻ với nhau nhằm mục đích cập nhật thông báo hiện có đã hiển thị cho người dùng.

Luồng sự kiện không giống với phiên sự kiện. Luồng sự kiện xác định trạng thái cập nhật cho một sự kiện trước đó trong cùng một luồng. Phiên sự kiện xác định các sự kiện riêng biệt có liên quan với nhau và có thể có nhiều luồng sự kiện cho một phiên sự kiện nhất định.

Đối với mục đích thông báo, các loại sự kiện được nhóm thành nhiều luồng.

Logic nhóm và thời gian của luồng này do Google xử lý và có thể thay đổi bất cứ lúc nào. developer sẽ cập nhật thông báo dựa trên các luồng sự kiện và phiên do API SDM cung cấp.

Trạng thái luồng

Các sự kiện hỗ trợ thông báo có thể cập nhật cũng có trường eventThreadState cho biết trạng thái của luồng sự kiện tại thời điểm đó. Trường này có các giá trị sau:

STARTED (BẮT ĐẦU) – Sự kiện đầu tiên trong luồng sự kiện.
ĐÃ CẬP NHẬT — Một sự kiện trong chuỗi sự kiện đang diễn ra. Có thể không có hoặc có nhiều sự kiện có trạng thái này trong một luồng.
ENDED (KẾT THÚC) – Sự kiện cuối cùng trong chuỗi sự kiện, có thể trùng lặp với sự kiện ĐÃ CẬP NHẬT gần đây nhất, tuỳ thuộc vào loại chuỗi.

Bạn có thể dùng trường này để theo dõi tiến trình của một luồng sự kiện và thời điểm luồng đó kết thúc.

Lọc sự kiện

Trong một số trường hợp, các sự kiện do thiết bị phát hiện có thể bị lọc ra khỏi việc phát hành lên chủ đề Pub/Sub SDM. Hành vi này được gọi là lọc sự kiện. Mục đích của tính năng lọc sự kiện là tránh phát hành quá nhiều thông báo sự kiện tương tự trong một khoảng thời gian ngắn.

Ví dụ: một thông báo có thể được phát hành cho một chủ đề SDM cho một sự kiện Chuyển động ban đầu. Các thông báo khác cho Motion sau đó sẽ bị lọc ra khỏi việc xuất bản cho đến khi hết khoảng thời gian đã đặt. Sau khi khoảng thời gian đó trôi qua, thông báo sự kiện cho loại sự kiện đó có thể được phát hành lại.

Trong Ứng dụng Google Home (GHA), các sự kiện đã được lọc vẫn sẽ xuất hiện trong nhật ký sự kiện của user. Tuy nhiên, các sự kiện như vậy không tạo ra thông báo ứng dụng (ngay cả khi loại thông báo đó được bật).

Mỗi loại sự kiện đều có logic lọc sự kiện riêng do Google xác định và có thể thay đổi bất cứ lúc nào. Logic lọc sự kiện này độc lập với luồng sự kiện và logic phiên.

Tài khoản dịch vụ

Bạn nên sử dụng tài khoản dịch vụ để quản lý các gói thuê bao và thông báo sự kiện của API SDM. Tài khoản dịch vụ do một ứng dụng hoặc máy ảo sử dụng, chứ không phải một người, và có khoá tài khoản riêng biệt.

Quy trình uỷ quyền tài khoản dịch vụ cho API Pub/Sub sử dụng OAuth hai bên (2LO).

Trong quy trình uỷ quyền 2LO:

developer yêu cầu mã truy cập bằng khoá dịch vụ.
developer sử dụng mã thông báo truy cập với các lệnh gọi đến API.

Để tìm hiểu thêm về Google 2LO và cách thiết lập, hãy xem phần Sử dụng OAuth 2.0 cho ứng dụng từ máy chủ đến máy chủ.

Ủy quyền

Tài khoản dịch vụ phải được uỷ quyền để sử dụng với API Pub/Sub:

Bật API Cloud Pub/Sub trong Google Cloud.
Tạo tài khoản dịch vụ và khoá tài khoản dịch vụ như mô tả trong phần Tạo tài khoản dịch vụ. Bạn chỉ nên cấp cho tài khoản này vai trò Người đăng ký Pub/Sub. Hãy nhớ tải khoá tài khoản dịch vụ xuống máy sẽ sử dụng API Pub/Sub.
Cung cấp thông tin xác thực (khoá tài khoản dịch vụ) cho mã ứng dụng bằng cách làm theo hướng dẫn trên trang ở bước trước, hoặc lấy mã thông báo truy cập theo cách thủ công bằng oauth2l nếu bạn muốn kiểm thử nhanh quyền truy cập API.
Sử dụng thông tin xác thực tài khoản dịch vụ hoặc mã truy cập với API Pub/Sub project.subscriptions để lấy và xác nhận thông báo.

oauth2l

Google oauth2l là một công cụ dòng lệnh cho OAuth được viết bằng Go. Hãy cài đặt công cụ này cho Mac hoặc Linux bằng Go.

Nếu bạn chưa có Go trên hệ thống, hãy tải và cài đặt Go trước.
Sau khi cài đặt Go, hãy cài đặt oauth2l và thêm vị trí của Go vào biến môi trường PATH:
```
go install github.com/google/oauth2l@latest
export PATH=$PATH:~/go/bin
```

Sử dụng oauth2l để lấy mã truy cập cho API, bằng cách sử dụng(các) phạm vi OAuth thích hợp:

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

Ví dụ: nếu khoá dịch vụ của bạn nằm ở ~/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...

Hãy xem oauth2l README để biết thêm thông tin về cách sử dụng.

Thư viện ứng dụng Google API

Có một số thư viện ứng dụng dành cho các API của Google sử dụng OAuth 2.0. Hãy xem Thư viện ứng dụng API của Google để biết thêm thông tin về ngôn ngữ bạn chọn.

Khi sử dụng các thư viện này với Pub/Sub API, hãy sử dụng(các) chuỗi phạm vi sau:

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

Lỗi

(Các) mã lỗi sau đây có thể được trả về liên quan đến hướng dẫn này:

Thông báo Lỗi	RPC	Khắc phục sự cố
Bạn không thể tải hình ảnh chụp bằng máy ảnh xuống nữa.	`DEADLINE_EXCEEDED`	Hình ảnh sự kiện sẽ hết hạn 30 giây sau khi sự kiện được xuất bản. Hãy nhớ tải hình ảnh xuống trước khi hết hạn.
Mã sự kiện không thuộc về máy ảnh.	`FAILED_PRECONDITION`	Sử dụng đúng `eventID` do sự kiện máy ảnh trả về.

Hãy xem Tài liệu tham khảo về mã lỗi API để biết danh sách đầy đủ các mã lỗi API.