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

Yêu cầu đồng bộ hoá sẽ kích hoạt một yêu cầu SYNC đến phương thức thực hiện của bạn cho bất kỳ người dùng Google nào có thiết bị có agentUserId được chỉ định liên kết với họ (mà bạn đã gửi trong yêu cầu SYNC ban đầu). Điều 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 giá trị nhận dạng này sẽ nhận được 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

  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:

Lưu ý: Đảm bảo rằng bạn đang sử dụng đúng dự án GCP khi thực hiện các bước này. Đây là dự án khớp với mã dự án smart home của bạn.
  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 Tạ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ột mã nhận dạng.

  5. Trong trường 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 Role (Vai trò), hãy chọn Service Accounts (Tài khoản dịch vụ) > Service Account OpenID Connect Identity Token Creator (Trình tạo mã thông báo danh tính 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ụ 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 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 mục 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.

Để biết hướng dẫn chi tiết và thông tin về cách tạo khoá tài khoản dịch vụ, hãy xem bài viết Tạo và xoá khoá tài khoản dịch vụ trên trang web Trợ giúp của Google Cloud Console.

Gọi API

HTTP

Home Graph API cung cấp một điểm cuối HTTP

  1. 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 bài viết Xác thực bằng tài khoản dịch vụ.
  2. Lấy mã truy cập OAuth 2.0 có phạm vi https://www.googleapis.com/auth/homegraph bằng oauth2l:
  3. oauth2l fetch --credentials service-account.json \
      --scope https://www.googleapis.com/auth/homegraph
    
  4. Tạo yêu cầu JSON bằng agentUserId. Dưới đây là yêu cầu JSON mẫu cho tính năng Yêu cầu đồng bộ hoá:
  5. {
      "agentUserId": "user-123"
    }
  6. Kết hợp JSON của yêu cầu đồng bộ hoá và mã thông báo trong yêu cầu HTTP POST đến điểm cuối Google Home Graph. Sau đây là ví dụ về cách gửi yêu cầu trong dòng lệnh bằng curl, dưới dạng thử nghiệm:
  7. curl -X POST -H "Authorization: Bearer ACCESS_TOKEN" \
      -H "Content-Type: application/json" \
      -d @request-body.json \
      "https://homegraph.googleapis.com/v1/devices:requestSync"
    

gRPC

Home Graph API cung cấp một điểm cuối gRPC

  1. Tải định nghĩa dịch vụ vùng đệm giao thức cho Home Graph API.
  2. 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ợ.
  3. Gọi phương thức RequestSync.

Node.js

Ứng dụng Node.js của API Google cung cấp các liên kết cho Home Graph API.

  1. 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.
  2. Gọi phương thức requestSync bằng RequestSyncDevicesRequest. Hàm này trả về một Promise có RequestSyncDevicesResponse trống.
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
  }
});
    

Java

Thư viện ứng ứng dụng API HomeGraph cho Java cung cấp các liên kết cho Home Graph API.

  1. Khởi chạy HomeGraphApiService bằng Thông tin xác thực mặc định của ứng dụng.
  2. Gọi phương thức requestSync bằng RequestSyncDevicesRequest. Phương thức này trả về một ReportStateAndNotificationResponse trống.
// 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 lỗi

Bạn có thể nhận được một trong các phản hồi lỗi sau đây khi gọi Request Sync. Những 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 đúng định dạng 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 trong 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 về mã làm mới 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ể tài nguyên này 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 một 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 ý đị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 đã cho. Người 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.