Report State

Report State は、スマートホーム アクションが QUERY インテントを待つのではなく、ユーザーのデバイスの最新ステータスを Google のホームグラフに事前に通知する重要な機能です。

Report State は、ユーザー デバイスのステータスを、そのデバイスに関連付けられた(元の SYNC リクエストで送信された)特定の agentUserId とともに Google に通知します。これにより、デバイスの現在のステータスがわからなければ実行できないアクションが要求された場合、Google アシスタントはホームグラフでステータス情報を調べるだけで済みます。さまざまなサードパーティ クラウドに QUERY インテントを発行してから EXECUTE インテントを発行する必要はありません。

Report State がなければ、たとえばリビングルームにある複数のライトのプロバイダがそれぞれ異なる場合、「OK Google, リビングルームを明るくして」というコマンドを受けると、まず複数のクラウドに複数の QUERY インテントを送信して解決しなければなりません。Report State があれば、前回の通知をもとに現在の輝度値を調べるだけで済みます。最高のユーザー エクスペリエンスを実現するために、Google アシスタントはデバイスまで往復せずにデバイスの現在のステータスを把握する必要があります。

デバイスに関する最初の SYNC リクエストの後、プラットフォームは QUERY インテントを送信してホームグラフに入力するデバイスのステータスを収集します。その後は、Report State で送信されたステータスのみがホームグラフに保存されます。

Report State を呼び出すときは、デバイスの特定のトレイトの完全なステータス データを提供してください。ホームグラフではトレイトごとにステータスが更新され、Report State が呼び出されるたびにそのトレイトのデータがすべて上書きされます。たとえば、StartStop トレイトのステータスを通知している場合、ペイロードには isRunningisPaused の両方の値を含める必要があります。

実装方法

Report State を実装する手順は次のとおりです。

Google HomeGraph API を有効にする

  1. Google Cloud Platform Console で、[HomeGraph API] ページに移動します。

    [HomeGraph API] ページに移動
  2. 自分のスマートホーム プロジェクトと ID が一致するプロジェクトを選択します。
  3. [有効にする] をクリックします。

サービス アカウント キーを作成する

GCP Console からサービス アカウント キーを生成する手順は次のとおりです。

: 以下の手順を行う場合は、正しい GCP プロジェクト(スマートホーム プロジェクト ID と一致するプロジェクト)を使用していることをご確認ください。
  1. GCP Console で [サービス アカウント キーの作成] ページに移動します。

    [サービス アカウント キーの作成] ページに移動
  2. [サービス アカウント] リストから [新しいサービス アカウント] を選択します。
  3. [サービス アカウント名] フィールドに名前を入力します。
  4. [サービス アカウント ID] フィールドに ID を入力します。
  5. [ロール] リストから、[サービス アカウント] > [サービス アカウント トークン作成者] を選択します。

  6. [キーのタイプ] として [JSON] を選択します。

  7. [作成] をクリックするとキーが含まれている JSON ファイルがパソコンにダウンロードされます。

API を呼び出す

以下のタブから選択してください。

HTTP POST

  1. ダウンロードしたサービス アカウントの JSON ファイルを使用して、JSON ウェブトークン(JWT)を作成します。詳細については、サービス アカウントを使用した認証をご覧ください。
  2. oauth2l を使用し、https://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 リクエストを作成します。 Report State に対する JSON リクエストの例を次に示します。
  5. {
      "requestId": "123ABC",
      "agentUserId": "user-123",
      "payload": {
        "devices": {
          "states": {
            "light-123": {
              "on": true
            }
          }
        }
      }
    }
    
  6. Google ホームグラフ エンドポイントに送信する HTTP POST リクエストに Report State JSON とアクセス トークンを含めます。次の例では、テストとして 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:reportStateAndNotification"
    

Node.js

Node.js 用の Actions on Google ライブラリは、HTTP 経由の Report State をサポートします。

  1. ダウンロードしたサービス アカウント JSON をプロジェクト ディレクトリに配置します。
  2. ファイルの場所を smarthome コンストラクタに渡します。
  3. ペイロードを使用して reportState メソッドを呼び出すと、Promise が返されます。
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',
    requestId: 'PLACEHOLDER-REQUEST-ID',
    payload: {
      devices: {
        states: {
          "PLACEHOLDER-DEVICE-ID": {
            on: true
          }
        }
      }
    }
  }
});
    

Java

Java 用 Actions on Google ライブラリは、gRPC 経由の Report State をサポートします。

  1. ダウンロードしたサービス アカウント JSON をプロジェクト ディレクトリに配置します。
  2. ファイルの場所を読み取り、GoogleCredentials オブジェクトを生成します。
  3. ペイロードを使用して reportState メソッドを呼び出すと、サーバー レスポンスが返されます。
  // 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 state payload.
  Map<?, ?> states = Map.of("on", true);

  // Report device state.
  ReportStateAndNotificationRequest request =
      new ReportStateAndNotificationRequest()
          .setRequestId("PLACEHOLDER-REQUEST-ID")
          .setAgentUserId("PLACEHOLDER-USER-ID")
          .setPayload(
              new StateAndNotificationPayload()
                  .setDevices(
                      new ReportStateAndNotificationDevice()
                          .setStates(Map.of("PLACEHOLDER-DEVICE-ID", states))));
  homegraphService.devices().reportStateAndNotification(request);
}
    

Report State をテストする

アクションの認定に向けての準備として、Report State をテストすることが重要です。

前提条件

アクションをテストするには、サービス アカウント キーと agentUserId が必要です。すでにサービス アカウント キーと agentUserId がある場合は、Report State ダッシュボードのデプロイをご覧ください。

Report State ダッシュボードをデプロイする

プロジェクトのサービス アカウント キーと agentUserId を取得したら、Report State ダッシュボードから最新バージョンをダウンロードしてデプロイします。 最新バージョンをダウンロードしたら、含まれている README.MD ファイルに記載された手順を行います。

Report State ダッシュボードをデプロイしたら、次の URL からダッシュボードにアクセスします(your_project_id を自分のプロジェクト ID に置き換えます)。

http://<your-project-id>.appspot.com

ダッシュボードで、以下の手順を行います。

  • アカウントキー ファイルを選択する
  • agentUserId を追加する

次に、[List](リスト)をクリックします。

すべてのデバイスが一覧表示されます。一覧が表示されると、[Refresh](更新)ボタンを使用してデバイスのステータスを更新できます。デバイスのステータスが変化した場合、その行は緑色でハイライト表示されます。

エラー レスポンス

Report State を呼び出したとき、次のいずれかのエラー レスポンスが返される場合があります。レスポンスは、HTTP ステータス コードの形で受け取ります。

  • 400 - 失敗: 不正な構文のため、サーバーがクライアントから送信されたリクエストを処理できませんでした。一般的な原因としては、不正な形式の JSON や、文字列値に "" でなく null を使っていることなどが挙げられます。
  • 404 - 失敗: リクエストされたリソースは見つかりませんでしたが、将来使用可能になる可能性があります。このエラーは通常、リクエストされたデバイスが見つからないことを意味します。ユーザー アカウントが Google とリンクしていないか、無効な agentUserId を受け取った可能性があります。agentUserIdSYNC レスポンスで提供された値と一致していること、DISCONNECT インテントが適切に処理されていることを確認してください。