Report State は、Home アクションが QUERY
インテントを待つのではなく、ユーザーのデバイスの最新ステータスを事前に Google Home Graph に報告できるようにするための重要な機能です。
Report State は、指定された agentUserId
が関連付けられている(元の SYNC
リクエストで送信された)ユーザー デバイスの状態を Google に報告します。Google Assistant がデバイスの現在の状態を把握する必要があるアクションを実行する場合、EXECUTE
インテントを発行する前に、さまざまなサードパーティ クラウドに QUERY
インテントを発行する代わりに、Home Graph で状態情報を検索できます。
Report State を使用しない場合、リビングルームにある複数のプロバイダから照明が与えられた場合、OK Google, リビングを明るくするというコマンドを使用するには、以前に報告された内容に基づいて現在の明るさの値を確認するのではなく、複数のクラウドに送信された複数の QUERY
インテントを解決する必要があります。最適なユーザー エクスペリエンスを実現するには、Assistant がデバイスを往復することなく、デバイスの現在の状態を持っている必要があります。
デバイスの最初の SYNC
の後に、プラットフォームは QUERY
インテントを送信し、デバイスの状態を収集して Home Graph に取り込みます。それ以降は Home Graph は Report State で送信された状態のみを保存します。
Report State を呼び出すときは、必ず特定のトレイトの完全な状態データを提供してください。Home Graph は、トレイトごとに状態を更新し、Report State が呼び出されたときにそのトレイトのすべてのデータを上書きします。たとえば、StartStop トレイトの状態を報告する場合、ペイロードに isRunning
と isPaused
の両方の値を含める必要があります。
はじめに
Report State を実装する手順は次のとおりです。
Google HomeGraph API を有効にする
-
Google Cloud Console で、HomeGraph API ページに移動します。
[HomeGraph API] ページに移動 - smart home プロジェクト ID と一致するプロジェクトを選択します。
- [有効にする] をクリックします。
サービス アカウント キーを作成する
Google Cloud Console からサービス アカウント キーを生成する手順は次のとおりです。
-
Google Cloud Console で、[サービス アカウント キーの作成] ページに移動します。
[サービス アカウント キーの作成] ページに移動 - [サービス アカウント] リストから [新しいサービス アカウント] を選択します。
- [サービス アカウント名] フィールドに名前を入力します。
- [サービス アカウント ID] フィールドに ID を入力します。
[ロール] リストから、[サービス アカウント] > [サービス アカウント トークン作成者] を選択します。
[キーのタイプ] として [JSON] を選択します。
- [作成] をクリックします。キーが含まれている JSON ファイルがパソコンにダウンロードされます。
API を呼び出す
以下のタブから選択してください。
HTTP
Home Graph は HTTP エンドポイントを提供します。
- ダウンロードしたサービス アカウントの JSON ファイルを使用して、JSON ウェブトークン(JWT)を作成します。詳細については、サービス アカウントを使用した認証をご覧ください。
- oauth2l を使用し、
https://www.googleapis.com/auth/homegraph
スコープを指定して OAuth 2.0 アクセス トークンを取得します。 agentUserId
を使用して JSON リクエストを作成します。 次に Report State と Notification の JSON リクエストの例を示します。- Google ホームグラフ エンドポイントに送信する HTTP POST リクエストに、Report State JSON、Notification JSON、アクセス トークンを含めます。次の例では、テストとして
curl
を使用してコマンドラインでリクエストを行う方法を示します。
oauth2l fetch --credentials service-account.json \ --scope https://www.googleapis.com/auth/homegraph
{ "requestId": "123ABC", "agentUserId": "user-123", "payload": { "devices": { "states": { "light-123": { "on": true } } } } }
curl -X POST -H "Authorization: Bearer ACCESS_TOKEN" \ -H "Content-Type: application/json" \ -d @request-body.json \ "https://homegraph.googleapis.com/v1/devices:reportStateAndNotification"
gRPC
Home Graph は gRPC エンドポイントを提供します。
- HomeGraph API 用のプロトコル バッファ サービス定義を取得します。
- gRPC デベロッパー向けドキュメントに沿って、サポートされている言語のうちいずれかのクライアント スタブを生成します。
- ReportStateAndNotification メソッドを呼び出します。
Node.js
Google API Node.js Client は Home Graph API のバインディングを提供します。
- アプリケーションのデフォルト認証情報を使用して、
google.homegraph
サービスを初期化します。 - ReportStateAndNotificationRequest を使用して
reportStateAndNotification
メソッドを呼び出します。ReportStateAndNotificationResponse で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 用 HomeGraph API クライアント ライブラリは、HomeGraph API 用のバインディングを提供します。
- アプリケーションのデフォルト認証情報を使用して
HomeGraphApiService
を初期化します。 ReportStateAndNotificationRequest
を使用してreportStateAndNotification
メソッドを呼び出します。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(); // 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 をテストすることが重要です。
そのためには、ダウンロードやデプロイが不要なスタンドアロン ウェブアプリである Home Graph ビューアツールを使用することをおすすめします。
Report State ダッシュボードは引き続き利用できますが、非推奨になり、サポートを終了しました。
Report State ダッシュボード
Prerequisites
アクションをテストするには、サービス アカウント キーと agentUserId
が必要です。サービス アカウント キーと agentUserId
がすでにある場合は、Report State ダッシュボードをデプロイするをご覧ください。
Report State ダッシュボードをデプロイする
プロジェクトのサービス アカウント キーとエージェント ユーザー ID を取得したら、Report State ダッシュボードから最新バージョンをダウンロードしてデプロイします。最新バージョンをダウンロードしたら、付属の README.MD
ファイルの手順に沿って操作します。
Report State ダッシュボードをデプロイしたら、次の URL からダッシュボードにアクセスします(your_project_id は実際のプロジェクト ID に置き換えます)。
http://<your-project-id>.appspot.com
ダッシュボードで、以下の手順を行います。
- アカウントキー ファイルを選択する
- agentUserId を追加する
次に、[List](リスト)をクリックします。
すべてのデバイスが一覧表示されます。一覧が表示されると、[Refresh](更新)ボタンを使用してデバイスのステータスを更新できます。デバイスのステータスが変化した場合、その行は緑色でハイライト表示されます。
エラー レスポンス
Report State を呼び出すと、次のいずれかのエラー レスポンスが返される場合があります。これらのレスポンスは、HTTP ステータス コードの形で受け取ります。
400 Bad Request
- 無効な構文のため、サーバーがクライアントから送信されたリクエストを処理できませんでした。一般的な原因は、不正な形式の JSON や、文字列値に "" でなくnull
を使用していることなどです。404 Not Found
- リクエストされたリソースは見つかりませんでしたが、将来使用できるようになる可能性があります。通常、リクエストされたデバイスが見つからないことを意味します。ユーザー アカウントが Google にリンクされていないか、無効なagentUserId
を受け取った可能性もあります。agentUserId
が SYNC レスポンスで提供された値と一致していること、DISCONNECT インテントが適切に処理されていることを確認してください。