Yêu cầu đồng bộ hoá

Tính năng Yêu cầu đồng bộ hoá kích hoạt một yêu cầu SYNC đối với quá trình thực hiện cho bất kỳ người dùng Google nào có thiết bị được liên kết với agentUserId đã chỉ định (mà bạn đã gửi trong yêu cầu SYNC ban đầu). Tính năng này cho phép bạn cập nhật thiết bị của người dùng mà không cần huỷ liên kết và liên kết lại tài khoản của họ. Tất cả người dùng được liên kết với mã nhận dạng này sẽ nhận được một yêu cầu SYNC.

Bạn phải kích hoạt một yêu cầu SYNC:

• Nếu người dùng thêm một thiết bị mới.
• Nếu người dùng xoá một thiết bị hiện có.
• Nếu người dùng đổi tên một thiết bị hiện có.
• Nếu bạn triển khai một loại thiết bị, đặc điểm mới hoặc thêm một tính năng mới cho thiết bị.

Bắt đầu

Để triển khai tính năng Yêu cầu đồng bộ hoá, hãy làm theo các bước sau:

• Bật Google HomeGraph API
• Tạo khoá tài khoản dịch vụ
• Gọi API

Bật Google HomeGraph API

1. Trong Google Cloud Console, hãy chuyển đến trang HomeGraph API.

   Chuyển đến trang HomeGraph API
2. Chọn dự án khớp với mã dự án smart home của bạn.
3. Nhấp vào BẬT.

Tạo khoá tài khoản dịch vụ

Làm theo các hướng dẫn sau để tạo khoá tài khoản dịch vụ từ Google Cloud Console:

1. Trong Google Cloud Console, hãy chuyển đến trang Tài khoản dịch vụ.

   Chuyển đến trang Tài khoản dịch vụ.

   Bạn có thể cần chọn một dự án trước khi được chuyển đến trang Tài khoản dịch vụ.

2. Nhấp vào addTạo tài khoản dịch vụ.

3. Trong trường Tên tài khoản dịch vụ, hãy nhập tên.

4. Trong trường Mã tài khoản dịch vụ, hãy nhập mã.

5. Trong trường Nội dung mô tả tài khoản dịch vụ, hãy nhập nội dung mô tả.

6. Nhấp vào Tạo và tiếp tục.

7. Trong trình đơn thả xuống Vai trò, hãy chọn Tài khoản dịch vụ > Trình tạo mã thông báo nhận dạng OpenID Connect của tài khoản dịch vụ.

8. Nhấp vào Tiếp tục.

9. Nhấp vào Xong.

10. Chọn tài khoản dịch vụ mà bạn vừa tạo trong danh sách tài khoản dịch vụ rồi chọn Quản lý khoá trong trình đơn more_vert Thao tác.

11. Chọn Thêm khoá > Tạo khoá mới.

12. Đối với Loại khoá, hãy chọn tuỳ chọn JSON.

13. Nhấp vào Tạo. Một tệp JSON chứa khoá của bạn sẽ được tải xuống máy tính.

Gọi API

const homegraphClient = homegraph({
  version: 'v1',
  auth: new GoogleAuth({
    scopes: 'https://www.googleapis.com/auth/homegraph'
  })
});

const res = await homegraphClient.devices.requestSync({
  requestBody: {
    agentUserId: 'PLACEHOLDER-USER-ID',
    async: false
  }
});
    

// 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();

// Request sync.
RequestSyncDevicesRequest request =
    new RequestSyncDevicesRequest().setAgentUserId("PLACEHOLDER-USER-ID").setAsync(false);
homegraphService.devices().requestSync(request);
    

Phản hồi báo lỗi

Bạn có thể nhận được một trong các phản hồi báo lỗi sau đây khi gọi tính năng Yêu cầu đồng bộ hoá. Các phản hồi này có dạng mã trạng thái HTTP.

• 400 Bad Request – Máy chủ không thể xử lý yêu cầu do ứng dụng gửi vì cú pháp không hợp lệ. Các nguyên nhân thường gặp bao gồm JSON không hợp lệ hoặc sử dụng null thay vì "" cho giá trị chuỗi.
• 403 Forbidden - Máy chủ không thể xử lý yêu cầu cho agentUserId đã cho do xảy ra lỗi khi làm mới mã thông báo. Đảm bảo điểm cuối OAuth của bạn phản hồi chính xác các yêu cầu làm mới mã thông báo và kiểm tra trạng thái liên kết tài khoản của người dùng.
• 404 Not Found – Không tìm thấy tài nguyên được yêu cầu nhưng có thể sẽ có trong tương lai. Thông thường, điều này có nghĩa là tài khoản người dùng không được liên kết với Google hoặc chúng tôi đã nhận được agentUserId không hợp lệ. Đảm bảo rằng agentUserId khớp với giá trị được cung cấp trong phản hồi SYNC và bạn đang xử lý đúng cách các ý định DISCONNECT.
• 429 Too Many Requests – Đã vượt quá số lượng yêu cầu đồng bộ hoá đồng thời tối đa cho agentUserId. Trình gọi chỉ có thể đưa ra một yêu cầu đồng bộ hoá đồng thời, trừ phi cờ async được đặt thành true.