要求同步處理

如果 Google 使用者的裝置具有與指定 agentUserId 相關聯的裝置 (您在原始 SYNC 要求中傳送),要求 Sync 就會觸發 SYNC 要求至您的執行要求。這可讓您更新使用者的裝置,而不必取消連結帳戶再重新連結。連結至這個 ID 的所有使用者都會收到 SYNC 要求。

您必須觸發 SYNC 要求:

  • 使用者新增裝置時。
  • 使用者移除現有裝置時。
  • 當使用者為現有裝置重新命名時。
  • 如果您導入了新的裝置類型、特性或新增裝置功能。

立即開始

如要執行「要求同步」,請按照下列步驟操作:

啟用 Google HomeGraph API

  1. 前往 Google Cloud Console 的「HomeGraph API」頁面。

    前往 HomeGraph API 頁面
  2. 選取與 smart home 專案 ID 相符的專案。
  3. 按一下「ENABLE」(啟用)

建立服務帳戶金鑰

請按照下列操作說明,從 Google Cloud Console 產生服務帳戶金鑰:

注意:執行下列步驟時,請務必使用正確的 GCP 專案。這個專案與您的 smart home 專案 ID 相符。
  1. 前往 Google Cloud Console 的「建立服務帳戶金鑰」頁面。

    前往「Create Service Account Key」(建立服務帳戶金鑰) 頁面。
  2. 從「Service account」(服務帳戶) 清單中選取「New service account」(新增服務帳戶)
  3. 在 [Service account name] (服務帳戶名稱) 欄位中輸入一個名稱。
  4. 在「Service account ID」(服務帳戶 ID) 欄位中輸入 ID。
  5. 從「角色」清單中,依序選取「服務帳戶」 >「服務帳戶憑證建立者」

  6. 針對「Key type」(金鑰類型),選取「JSON」選項。

  7. 按一下「建立」,內含金鑰的 JSON 檔案會下載至電腦。

呼叫 API

HTTP

Home Graph API 提供 HTTP 端點

  1. 使用下載的服務帳戶 JSON 檔案建立 JSON Web Token (JWT)。詳情請參閱「 使用服務帳戶驗證」。
  2. 使用 OAuth2lhttps://www.googleapis.com/auth/homegraph 範圍取得 OAuth 2.0 存取權杖:
  3. oauth2l fetch --credentials service-account.json \
      --scope https://www.googleapis.com/auth/homegraph
    
  4. 使用 agentUserId 建立 JSON 要求。以下是「要求同步處理」的 JSON 要求範例:
  5. {
      "agentUserId": "user-123"
    }
    
  6. 將 Request Sync JSON 和 HTTP POST 要求中的權杖結合至 Google Home Graph 端點。以下範例說明如何在指令列中使用 curl 來進行測試:
  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 提供 gRPC 端點

  1. 取得 Home Graph API 的通訊協定緩衝區服務定義
  2. 請按照 gRPC 開發人員說明文件,為其中一種支援的語言產生用戶端虛設常式。
  3. 呼叫 RequestSync 方法。

Node.js

Google API Node.js 用戶端提供適用於 Home Graph API 的繫結。

  1. 使用應用程式預設憑證來初始化 google.homegraph 服務。
  2. 使用 RequestSyncDevicesRequest 呼叫 requestSync 方法。它會傳回包含空白 RequestSyncDevicesResponsePromise
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

Java 適用的 HomeGraph API 用戶端程式庫提供適用於 Home Graph API 的繫結。

  1. 使用應用程式預設憑證來初始化 HomeGraphApiService
  2. 使用 RequestSyncDevicesRequest 呼叫 requestSync 方法。並傳回空白的 ReportStateAndNotificationResponse
// 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);
    

錯誤回應

呼叫「要求同步」時,可能會收到下列其中一則錯誤回應。 這些回應會採用 HTTP 狀態碼的形式。

  • 400 Bad Request:伺服器因語法無效而無法處理用戶端傳送的要求。常見原因包括 JSON 格式錯誤,或以 null 取代字串值。
  • 403 Forbidden - 重新整理權杖時發生錯誤,因此伺服器無法處理指定 agentUserId 的要求。請確認您的 OAuth 端點正確回應重新整理憑證要求,並檢查使用者的帳戶連結狀態。
  • 404 Not Found:找不到要求的資源,但日後可能會提供。通常這表示使用者帳戶未與 Google 連結,或我們收到無效的 agentUserId。確認 agentUserIdSYNC 回應中提供的值相符,且您已妥善處理 DISCONNECT 意圖。
  • 429 Too Many Requests:指定 agentUserId 的並行同步要求數量已超出上限。除非 async 標記設為 true,呼叫端只能發出一個並行同步處理要求。