Thông báo cho phép tính năng tích hợp Cloud-to-cloud sử dụng Google Assistant để thông báo cho người dùng về các sự kiện hoặc thay đổi quan trọng liên quan đến thiết bị. Bạn có thể triển khai thông báo để cảnh báo người dùng về các sự kiện thiết bị kịp thời, chẳng hạn như khi có người ở cửa hoặc để báo cáo về thay đổi trạng thái thiết bị được yêu cầu, chẳng hạn như khi chốt khoá cửa đã được kích hoạt thành công hoặc bị kẹt.
Tính năng tích hợp Cloud-to-cloud có thể gửi các loại thông báo sau đây cho người dùng:
Thông báo chủ động: Cảnh báo người dùng về một sự kiện thiết bị smart home mà không có yêu cầu nào trước đó của người dùng đối với thiết bị của họ, chẳng hạn như chuông cửa reo.
Phản hồi tiếp theo: Xác nhận rằng yêu cầu lệnh thiết bị thành công hoặc không thành công, ví dụ: khi khoá cửa. Sử dụng các cảnh báo này cho các lệnh thiết bị cần thời gian để hoàn tất. Hệ thống chỉ hỗ trợ phản hồi tiếp theo khi các yêu cầu lệnh thiết bị được gửi từ loa thông minh và màn hình thông minh.
Assistant cung cấp các thông báo này cho người dùng dưới dạng thông báo trên loa thông minh và màn hình thông minh. Theo mặc định, thông báo chủ động sẽ bị tắt. Người dùng có thể bật hoặc tắt tất cả thông báo chủ động từ Google Home app (GHA).
Các sự kiện kích hoạt thông báo
Khi sự kiện thiết bị xảy ra, phương thức thực hiện của bạn sẽ gửi yêu cầu thông báo đến Google. Các đặc điểm thiết bị mà tính năng tích hợp Cloud-to-cloud hỗ trợ sẽ xác định những loại sự kiện thông báo có sẵn và dữ liệu mà bạn có thể đưa vào các thông báo đó.
Các đặc điểm sau đây hỗ trợ thông báo chủ động:
Đặc điểm | Sự kiện |
---|---|
ObjectDetection | Các đối tượng mà thiết bị phát hiện, chẳng hạn như khi phát hiện một khuôn mặt đã được nhận dạng ở cửa. Ví dụ: "Alice và Bob đang ở cửa trước." |
RunCycle | Thiết bị hoàn tất một chu kỳ. Ví dụ: "Chu kỳ giặt của máy giặt đã hoàn tất." |
SensorState | Thiết bị phát hiện trạng thái cảm biến được hỗ trợ. Ví dụ: "Máy dò khói phát hiện thấy khói." |
Các đặc điểm sau đây hỗ trợ phản hồi tiếp theo:
Đặc điểm | Sự kiện |
---|---|
LockUnlock | Trạng thái hoàn thành và trạng thái thay đổi sau khi thực thi lệnh thiết bị action.devices.commands.LockUnlock . Ví dụ: "Cửa trước đã bị khoá" hoặc "Cửa trước bị kẹt".
|
NetworkControl | Trạng thái hoàn thành và trạng thái thay đổi sau khi thực thi lệnh thiết bị action.devices.commands.TestNetworkSpeed . Ví dụ: "Quy trình kiểm tra tốc độ mạng của bạn đã hoàn tất. Tốc độ tải xuống trên bộ định tuyến tại văn phòng hiện tại là 80,2 Kb/giây và tốc độ tải lên là 9,3 Kb/giây".
|
OpenClose | Trạng thái hoàn thành và trạng thái thay đổi sau khi thực thi lệnh thiết bị action.devices.commands.OpenClose . Ví dụ: "Cửa trước đã mở" hoặc "Không thể mở cửa trước".
|
Tất cả các loại thiết bị đều hỗ trợ thông báo cho các đặc điểm hiện có.
Tạo thông báo cho chế độ tích hợp Cloud-to-cloud
Thêm thông báo vào quá trình tích hợp Cloud-to-cloud ở các giai đoạn sau:
- Cho Google biết liệu thông báo có được bật từ ứng dụng thiết bị smart home hay không. Nếu người dùng bật hoặc tắt thông báo trong ứng dụng của bạn, hãy gửi yêu cầu
SYNC
để thông báo cho Google về thay đổi đối với thiết bị. - Khi một sự kiện hoặc thay đổi trạng thái thiết bị có liên quan xảy ra và kích hoạt thông báo, hãy gửi yêu cầu thông báo bằng cách gọi API Report State
reportStateAndNotification
. Nếu trạng thái thiết bị thay đổi, bạn có thể gửi cả trạng thái và tải trọng thông báo cùng nhau trong lệnh gọi Report State và Notification.
Các phần sau đây sẽ trình bày chi tiết hơn về các bước này.
Cho biết liệu thông báo có được bật trong ứng dụng của bạn hay không
Người dùng có thể chọn nhận thông báo chủ động bằng cách bật tính năng này trong GHA. Trong ứng dụng dành cho thiết bị smart home, bạn cũng có thể tuỳ ý thêm tính năng cho phép người dùng bật/tắt thông báo một cách rõ ràng từ thiết bị, chẳng hạn như từ phần cài đặt ứng dụng.
Cho Google biết rằng bạn đã bật thông báo cho thiết bị bằng cách thực hiện lệnh gọi Yêu cầu đồng bộ hoá để cập nhật dữ liệu thiết bị. Bạn nên gửi yêu cầu SYNC
như thế này bất cứ khi nào người dùng thay đổi chế độ cài đặt này trong ứng dụng.
Trong phản hồi SYNC
, hãy gửi một trong những nội dung cập nhật sau:
- Nếu người dùng bật thông báo một cách rõ ràng trong ứng dụng trên thiết bị của bạn hoặc nếu bạn không cung cấp tuỳ chọn bật/tắt, hãy đặt thuộc tính
devices.notificationSupportedByAgent
thànhtrue
. - Nếu người dùng tắt thông báo một cách rõ ràng trong ứng dụng trên thiết bị, hãy đặt thuộc tính
devices.notificationSupportedByAgent
thànhfalse
.
Đoạn mã sau đây cho thấy ví dụ về cách đặt phản hồi SYNC:
devices: [{
id: 'device123',
...
notificationSupportedByAgent: true,
}]
Gửi yêu cầu thông báo cho Google
Để kích hoạt thông báo trên Assistant, phương thức thực hiện đơn hàng sẽ gửi một gói dữ liệu thông báo đến Google Home Graph thông qua Report State và lệnh gọi API Thông báo.
Bật API Google HomeGraph
-
Trong Google Cloud Console, hãy chuyển đến trang HomeGraph API.
Chuyển đến trang HomeGraph API - Chọn dự án khớp với mã dự án smart home.
- Nhấp vào BẬT.
Tạo khoá tài khoản dịch vụ
Làm theo hướng dẫn sau để tạo khoá tài khoản dịch vụ từ Google Cloud Console:
-
Trong Google Cloud Console, hãy chuyển đến trang Tạo khoá tài khoản dịch vụ.
Chuyển đến trang Tạo khoá tài khoản dịch vụ - Trong danh sách Tài khoản dịch vụ, hãy chọn Tài khoản dịch vụ mới.
- Trong trường Tên tài khoản dịch vụ, hãy nhập tên.
- Trong trường Mã tài khoản dịch vụ, hãy nhập một mã nhận dạng.
Trong danh sách Vai trò, hãy chọn Tài khoản dịch vụ > Trình tạo mã thông báo tài khoản dịch vụ.
Đối với Loại khoá, hãy chọn JSON.
- Nhấp vào Tạo. Tệp JSON chứa khoá của bạn sẽ tải xuống máy tính.
Gửi thông báo
Thực hiện lệnh gọi yêu cầu thông báo bằng API devices.reportStateAndNotification
.
Yêu cầu JSON của bạn phải bao gồm eventId
. Đây là mã nhận dạng duy nhất do nền tảng của bạn tạo ra cho sự kiện kích hoạt thông báo. eventId
phải là một mã nhận dạng ngẫu nhiên khác nhau mỗi khi bạn gửi yêu cầu thông báo.
Trong đối tượng notifications
mà bạn truyền vào lệnh gọi API, hãy thêm giá trị priority
để xác định cách hiển thị thông báo. Đối tượng notifications
có thể bao gồm nhiều trường tuỳ thuộc vào đặc điểm của thiết bị.
Hãy làm theo một trong các đường dẫn sau để đặt trọng tải và gọi API:
Gửi tải trọng thông báo chủ động
Để gọi API, hãy chọn một tuỳ chọn trong một trong các thẻ sau:
HTTP
API Home Graph cung cấp một điểm cuối HTTP
- Sử dụng tệp JSON của tài khoản dịch vụ đã tải xuống để tạo Mã thông báo web JSON (JWT). Để biết thêm thông tin, hãy xem phần Xác thực bằng tài khoản dịch vụ.
- Nhận mã truy cập OAuth 2.0 với phạm vi
https://www.googleapis.com/auth/homegraph
bằng cách sử dụng oauth2l: - Tạo yêu cầu JSON bằng
agentUserId
. Dưới đây là một yêu cầu JSON mẫu cho Report State và Thông báo: - Kết hợp Report State và JSON thông báo cùng với mã thông báo trong yêu cầu HTTP POST đến điểm cuối Biểu đồ Google Home. Sau đây là ví dụ về cách tạo yêu cầu trong dòng lệnh bằng
curl
, dưới dạng kiểm thử:
oauth2l fetch --credentials service-account.json \ --scope https://www.googleapis.com/auth/homegraph
{ "agentUserId": "PLACEHOLDER-USER-ID", "eventId": "PLACEHOLDER-EVENT-ID", "requestId": "PLACEHOLDER-REQUEST-ID", "payload": { "devices": { "notifications": { "PLACEHOLDER-DEVICE-ID": { "ObjectDetection": { "priority": 0, "detectionTimestamp": 1534875126750, "objects": { "named": [ "Alice" ], "unclassified": 2 } } } } } } }
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
API Home Graph cung cấp một điểm cuối gRPC
- Nhận định nghĩa dịch vụ vùng đệm giao thức cho API Home Graph.
- Làm theo tài liệu dành cho nhà phát triển gRPC để tạo mã giả lập ứng dụng cho một trong các ngôn ngữ được hỗ trợ .
- Gọi phương thức ReportStateAndNotification .
Node.js
Ứng dụng Node.js của API Google cung cấp các liên kết cho API Home Graph.
- Khởi chạy dịch vụ
google.homegraph
bằng Thông tin xác thực mặc định của ứng dụng. - Gọi phương thức
reportStateAndNotification
bằng ReportStateAndNotificationRequest. Phương thức này trả về mộtPromise
có ReportStateAndNotificationResponse.
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', eventId: 'PLACEHOLDER-EVENT-ID', requestId: 'PLACEHOLDER-REQUEST-ID', payload: { devices: { notifications: { 'PLACEHOLDER-DEVICE-ID': { ObjectDetection: { priority: 0, detectionTimestamp: 1534875126750, objects: { named: ['Alice'], unclassified: 2 } } } } } } } });
Java
Thư viện ứng dụng API HomeGraph cho Java cung cấp các liên kết cho API Home Graph.
- Khởi chạy
HomeGraphApiService
bằng Thông tin xác thực mặc định của ứng dụng. - Gọi phương thức
reportStateAndNotification
bằngReportStateAndNotificationRequest
. Hàm này trả về mộtReportStateAndNotificationResponse
.
// 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 notification payload. Map<?, ?> notifications = Map.of( "ObjectDetection", Map.of( "priority", 0, "detectionTimestamp", 1534875126, "objects", Map.of("named", List.of("Alice"), "unclassifed", 2))); // Send notification. ReportStateAndNotificationRequest request = new ReportStateAndNotificationRequest() .setRequestId("PLACEHOLDER-REQUEST-ID") .setAgentUserId("PLACEHOLDER-USER-ID") .setEventId("PLACEHOLDER-EVENT-ID") .setPayload( new StateAndNotificationPayload() .setDevices( new ReportStateAndNotificationDevice() .setNotifications(Map.of("PLACEHOLDER-DEVICE-ID", notifications)))); homegraphService.devices().reportStateAndNotification(request);
Gửi tải trọng phản hồi tiếp theo
Trọng tải cho phản hồi tiếp theo chứa trạng thái của yêu cầu, mã lỗi cho các sự kiện không thành công (nếu có) và followUpToken
hợp lệ được cung cấp trong yêu cầu ý định EXECUTE
. Bạn phải sử dụng followUpToken
trong vòng 5 phút để mã này vẫn hợp lệ và liên kết chính xác phản hồi với yêu cầu ban đầu.
Đoạn mã sau đây cho thấy một tải trọng yêu cầu EXECUTE
mẫu có trường followUpToken
.
{ "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf", "inputs": [{ "intent": "action.devices.EXECUTE", "payload": { "commands": [{ "devices": [{ "id": "123", }], "execution": [{ "command": "action.devices.commands.TestNetworkSpeed", "params": { "testDownloadSpeed": true, "testUploadSpeed": false, "followUpToken": "PLACEHOLDER" } }] }] } }] };
Google sử dụng followUpToken
để chỉ đưa ra thông báo trên thiết bị mà người dùng ban đầu đang tương tác, chứ không phát đi trên tất cả thiết bị của người dùng.
Để gọi API, hãy chọn một tuỳ chọn trong một trong các thẻ sau:
HTTP
API Home Graph cung cấp một điểm cuối HTTP
- Sử dụng tệp JSON của tài khoản dịch vụ đã tải xuống để tạo Mã thông báo web JSON (JWT). Để biết thêm thông tin, hãy xem phần Xác thực bằng tài khoản dịch vụ.
- Nhận mã truy cập OAuth 2.0 với phạm vi
https://www.googleapis.com/auth/homegraph
bằng cách sử dụng oauth2l: - Tạo yêu cầu JSON bằng
agentUserId
. Dưới đây là một yêu cầu JSON mẫu cho Report State và Thông báo: - Kết hợp Report State và JSON thông báo cùng với mã thông báo trong yêu cầu HTTP POST đến điểm cuối Biểu đồ Google Home. Sau đây là ví dụ về cách tạo yêu cầu trong dòng lệnh bằng
curl
, dưới dạng kiểm thử:
oauth2l fetch --credentials service-account.json \ --scope https://www.googleapis.com/auth/homegraph
{ "agentUserId": "PLACEHOLDER-USER-ID", "eventId": "PLACEHOLDER-EVENT-ID", "requestId": "PLACEHOLDER-REQUEST-ID", "payload": { "devices": { "notifications": { "PLACEHOLDER-DEVICE-ID": { "NetworkControl": { "priority": 0, "followUpResponse": { "status": "SUCCESS", "followUpToken": "PLACEHOLDER", "networkDownloadSpeedMbps": 23.3, "networkUploadSpeedMbps": 10.2 } } } } } } }
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
API Home Graph cung cấp một điểm cuối gRPC
- Nhận định nghĩa dịch vụ vùng đệm giao thức cho API Home Graph.
- Làm theo tài liệu dành cho nhà phát triển gRPC để tạo mã giả lập ứng dụng cho một trong các ngôn ngữ được hỗ trợ.
- Gọi phương thức ReportStateAndNotification.
Node.js
Ứng dụng Node.js của API Google cung cấp các liên kết cho API Home Graph.
- Khởi chạy dịch vụ
google.homegraph
bằng Thông tin xác thực mặc định của ứng dụng. - Gọi phương thức
reportStateAndNotification
bằng ReportStateAndNotificationRequest. Phương thức này trả về mộtPromise
có ReportStateAndNotificationResponse.
const followUpToken = executionRequest.inputs[0].payload.commands[0].execution[0].params.followUpToken; 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', eventId: 'PLACEHOLDER-EVENT-ID', requestId: 'PLACEHOLDER-REQUEST-ID', payload: { devices: { notifications: { 'PLACEHOLDER-DEVICE-ID': { NetworkControl: { priority: 0, followUpResponse: { status: 'SUCCESS', followUpToken, networkDownloadSpeedMbps: 23.3, networkUploadSpeedMbps: 10.2, } } } } } } } });
Java
Thư viện ứng dụng API HomeGraph cho Java cung cấp các liên kết cho API Home Graph.
- Khởi chạy
HomeGraphApiService
bằng Thông tin xác thực mặc định của ứng dụng - Gọi phương thức
reportStateAndNotification
bằngReportStateAndNotificationRequest
. Hàm này trả về mộtReportStateAndNotificationResponse
// 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(); // Extract follow-up token. ExecuteRequest.Inputs executeInputs = (Inputs) executeRequest.getInputs()[0]; String followUpToken = (String) executeInputs .getPayload() .getCommands()[0] .getExecution()[0] .getParams() .get("followUpToken"); // Build device follow-up response payload. Map<?, ?> followUpResponse = Map.of( "NetworkControl", Map.of( "priority", 0, "followUpResponse", Map.of( "status", "SUCCESS", "followUpToken", followUpToken, "networkDownloadSpeedMbps", 23.3, "networkUploadSpeedMbps", 10.2))); // Send follow-up response. ReportStateAndNotificationRequest request = new ReportStateAndNotificationRequest() .setRequestId("PLACEHOLDER-REQUEST-ID") .setAgentUserId("PLACEHOLDER-USER-ID") .setEventId("PLACEHOLDER-EVENT-ID") .setPayload( new StateAndNotificationPayload() .setDevices( new ReportStateAndNotificationDevice() .setNotifications(Map.of("PLACEHOLDER-DEVICE-ID", followUpResponse)))); homegraphService.devices().reportStateAndNotification(request);
Ghi nhật ký
Thông báo hỗ trợ tính năng ghi nhật ký sự kiện như được nêu trong phần Ghi nhật ký trên đám mây cho giao thức từ đám mây đến đám mây. Các nhật ký này hữu ích cho việc kiểm thử và duy trì chất lượng thông báo trong Hành động.
Sau đây là giản đồ của mục nhập notificationLog
:
Thuộc tính | Mô tả |
---|---|
requestId |
Mã yêu cầu thông báo. |
structName |
Tên của cấu trúc thông báo, chẳng hạn như "ObjectDetection". |
status |
Cho biết trạng thái của thông báo. |
Trường status
bao gồm nhiều trạng thái có thể cho biết lỗi trong tải trọng thông báo. Một số trong số này có thể chỉ có trên những Hành động chưa được phát hành công khai.
Sau đây là một số ví dụ về trạng thái:
Trạng thái | Mô tả |
---|---|
EVENT_ID_MISSING |
Cho biết thiếu trường eventId bắt buộc.
|
PRIORITY_MISSING |
Cho biết trường priority bị thiếu.
|
NOTIFICATION_SUPPORTED_BY_AGENT_FALSE |
Cho biết thuộc tính notificationSupportedByAgent của thiết bị thông báo được cung cấp trong SYNC là sai.
|
NOTIFICATION_ENABLED_BY_USER_FALSE |
Cho biết người dùng chưa bật thông báo trên thiết bị thông báo trong GHA. Trạng thái này chỉ có trên các công cụ tích hợp chưa được phát hành công khai. |
NOTIFYING_DEVICE_NOT_IN_STRUCTURE |
Cho biết người dùng chưa chỉ định thiết bị thông báo cho một Nhà/Cấu trúc. Trạng thái này chỉ có trên các chế độ tích hợp chưa được triển khai công khai. |
Ngoài các trạng thái chung này có thể áp dụng cho tất cả thông báo, trường status
cũng có thể bao gồm các trạng thái dành riêng cho đặc điểm nếu có (ví dụ: OBJECT_DETECTION_DETECTION_TIMESTAMP_MISSING
).