Report State는 Home 작업이 사용자 기기의 최신 상태를 Google Home Graph
rather than waiting for a
QUERY
intent.에 미리 보고할 수 있게 해주는 중요한 기능입니다.
Report State는 지정된 agentUserId
와 연결된 사용자 기기의 상태를 Google에 보고합니다 (원래 SYNC
요청으로 전송됨). Google Assistant
wants to take an action
that requires understanding the current state of a device, it can simply look
up the state information in the
Home Graph instead
of issuing a QUERY
intent to various third-party clouds prior to issuing the
EXECUTE
intent.
Report State를 사용하지 않으면 거실에서 여러 제공업체의 조명을 사용할 수 있기 때문에 Ok Google, 거실 밝기 명령어를 사용하려면 이전에 보고된 내용에 따라 현재 밝기 값을 찾는 것이 아니라 여러 클라우드에 전송된 여러 QUERY
인텐트를 확인해야 합니다. 최상의 사용자 환경을 제공하려면 기기를 왕복하지 않고도 Assistant가 기기의 현재 상태를 알아야 합니다.
기기의 초기 SYNC
에 따라 플랫폼은 Home Graph 상태를 채우기 위해 기기 상태를 수집하는 QUERY
인텐트를 전송합니다.
그 시점이 지나면 Home Graph는 Report State와 함께 전송된 상태만 저장합니다.
Report State를 호출할 때는 지정된 특성의 전체 상태 데이터를 제공해야 합니다.
Home Graph는 특성별로 상태를 업데이트하고 Report State 호출 시 특성의 모든 데이터를 덮어씁니다. 예를 들어 StartStop 특성의 상태를 보고하는 경우 페이로드에 isRunning
및 isPaused
값을 모두 포함해야 합니다.
시작하기
Report State를 구현하려면 다음 단계를 따르세요.
Google HomeGraph API 사용 설정
-
Google Cloud Console , go to the HomeGraph API page.에서
HomeGraph API 페이지로 이동 - smart home project 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 요청을 만듭니다. 다음은 보고서 상태 및 알림에 대한 샘플 JSON 요청입니다.- 보고서 상태, 알림 JSON, HTTP POST 요청의 토큰을 Google Home Graph 엔드포인트에 결합합니다. 다음은 테스트에서
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 엔드포인트를 제공합니다.
- Home Graph API의 프로토콜 버퍼 서비스 정의를 가져옵니다.
- gRPC 개발자 문서에 따라 지원되는 언어 중 하나의 클라이언트 스텁을 생성합니다.
- ReportStateAndNotification 메소드를 호출합니다.
Node.js
Google API Node.js 클라이언트는 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 } } } } } });
자바
자바용 HomeGraph API 클라이언트 라이브러리는 Home Graph 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를 테스트하는 것이 중요합니다.
이렇게 하려면 다운로드나 배포가 필요하지 않은 독립형 웹 앱인 Home Graph 뷰어 도구를 사용하는 것이 좋습니다.
Report State 대시보드는 계속 사용할 수 있지만 지원 중단되었으며 더 이상 지원되지 않습니다.
보고서 상태 대시보드
기본 요건
작업을 테스트하려면 서비스 계정 키와 agentUserId
가 필요합니다. 서비스 계정 키와 agentUserId
가 이미 있는 경우 Report State대시보드 배포를 참조하세요.
보고서 상태 대시보드 배포
프로젝트의 서비스 계정 키와 에이전트 사용자 ID를 가져온 후 Report State 대시보드에서 최신 버전을 다운로드하고 배포합니다.
최신 버전을 다운로드한 후 포함된 README.MD
파일의 안내를 따릅니다.
Report State 대시보드를 배포한 후 다음 URL에서 대시보드에 액세스합니다 (your_project_id를 프로젝트 ID로 변경).
http://<your-project-id>.appspot.com
대시보드에서 다음을 수행합니다.
- 계정 키 파일 선택
- 에이전트 사용자 ID 추가
그런 다음 목록을 클릭합니다.
모든 기기가 표시됩니다. 목록이 채워지면 새로고침 버튼을 사용하여 기기 상태를 업데이트할 수 있습니다. 기기 상태가 변경되면 행이 녹색으로 강조표시됩니다.
오류 응답
Report State 호출 시 다음 오류 응답 중 하나가 발생할 수 있습니다. 이러한 응답은 HTTP 상태 코드 형식으로 제공됩니다.
400 Bad Request
- 잘못된 구문으로 인해 서버에서 클라이언트가 보낸 요청을 처리하지 못했습니다. 일반적인 원인으로는 잘못된 형식의 JSON 또는 문자열 값에 ''' 대신null
사용 등이 있습니다.404 Not Found
- 요청된 리소스를 찾을 수 없지만 향후에 사용 가능할 수 있습니다. 일반적으로 요청된 기기를 찾을 수 없습니다. 또한 사용자 계정이 Google과 연결되지 않았거나 잘못된agentUserId
이 수신되었음을 의미할 수도 있습니다.agentUserId
가 SYNC 응답에 제공된 값과 일치하고 DISCONNECT 인텐트를 제대로 처리하는지 확인하세요.