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 mọi người dùng Google 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). Đ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 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 hoặc thêm một tính năng thiết bị mới.

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 API Google HomeGraph

  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.
  3. 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:

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ạo khoá tài khoản dịch vụ.

    Chuyển đến trang Tạo khoá tài khoản dịch vụ
  2. Trong danh sách Tài khoản dịch vụ, hãy chọn Tài khoản dịch vụ mới.
  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 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ụ.

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

  7. 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 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 phần Xác thực bằng tài khoản dịch vụ.
  2. 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:
  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à một 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 Yêu cầu đồng bộ hoá và mã thông báo trong yêu cầu HTTP POST với đ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ử:
  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. Nhận định nghĩa dịch vụ bộ đệm giao thức cho API Biểu đồ nhà.
  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 API Biểu đồ nhà.

  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. Phương thức này trả về một PromiseRequestSyncDevicesResponse 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 dụng HomeGraph API 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 (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 do cú pháp không hợp lệ. Các nguyên nhân thường gặp bao gồm JSON có định dạng không chính xác 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 lỗi trong khi làm mới mã thông báo. Đảm bảo điểm cuối OAuth phản hồi chính xác để làm mới các yêu cầu 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 bạn 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 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 các ý định DISCONNECT.
  • 429 Too Many Requests – Đã vượt quá số lượng yêu cầu đồng bộ hoá tối đa cho agentUserId đã cho. Phương thức 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.