보고서 상태

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 GraphReport State와 함께 전송된 상태만 저장합니다.

Report State를 호출할 때는 지정된 특성에 관한 완전한 상태 데이터를 제공해야 합니다. Home Graph는 특성별로 상태를 업데이트하고 Report State 호출 시 이 특성의 모든 데이터를 덮어씁니다. 예를 들어 StartStop 특성에 대한 상태를 보고하는 경우 페이로드에 isRunningisPaused의 값을 모두 포함해야 합니다.

시작하기

Report State를 구현하려면 다음 단계를 따르세요.

Google HomeGraph API 사용 설정

  1. Google Cloud Console에서 HomeGraph API 페이지로 이동합니다.

    HomeGraph API 페이지로 이동
  2. smart home 프로젝트 ID와 일치하는 프로젝트를 선택합니다.
  3. 사용 설정을 클릭합니다.

서비스 계정 키 만들기

다음 안내에 따라 Google Cloud Console에서 서비스 계정 키를 생성합니다.

참고: 다음 단계를 수행할 때 올바른 GCP 프로젝트를 사용해야 합니다. smart home 프로젝트 ID와 일치하는 프로젝트입니다.
  1. Google Cloud Console에서 서비스 계정 키 만들기 페이지로 이동합니다.

    서비스 계정 키 만들기 페이지로 이동
  2. 서비스 계정 목록에서 새 서비스 계정을 선택합니다.
  3. 서비스 계정 이름 필드에 이름을 입력합니다.
  4. 서비스 계정 ID 필드에 ID를 입력합니다.
  5. 역할 목록에서 서비스 계정 > 서비스 계정 토큰 생성자를 선택합니다.

  6. 키 유형JSON 옵션을 선택합니다.

  7. 만들기를 클릭합니다. 키가 포함된 JSON 파일이 컴퓨터에 다운로드됩니다.

API 호출

아래 탭에서 옵션을 선택하세요.

HTTP

Home GraphHTTP 엔드포인트를 제공합니다.

  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 요청을 만듭니다. 다음은 보고서 상태 및 알림에 대한 JSON 요청의 예입니다.
  5. {
      "requestId": "123ABC",
      "agentUserId": "user-123",
      "payload": {
        "devices": {
          "states": {
            "light-123": {
              "on": true
            }
          }
        }
      }
    }
    
  6. Google Home Graph 엔드포인트에 대한 HTTP POST 요청의 보고서 상태 및 알림 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"
    

gRPC

Home GraphgRPC 엔드포인트를 제공합니다.

  1. Home Graph API의 프로토콜 버퍼 서비스 정의를 가져옵니다.
  2. gRPC 개발자 문서에 따라 지원되는 언어 중 하나에 대한 클라이언트 스텁을 생성하세요.
  3. ReportStateAndNotification 메서드를 호출합니다.

Node.js

Google API Node.js 클라이언트Home Graph API의 바인딩을 제공합니다.

  1. 애플리케이션 기본 사용자 인증 정보를 사용하여 google.homegraph 서비스를 초기화합니다.
  2. ReportStateAndNotificationRequestreportStateAndNotification 메서드를 호출합니다. 이 메서드는 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

자바용 HomeGraph API 클라이언트 라이브러리는 Home Graph API의 바인딩을 제공합니다.

  1. 애플리케이션 기본 사용자 인증 정보를 사용하여 HomeGraphApiService를 초기화합니다.
  2. 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

대시보드에서 다음을 수행합니다.

  • 계정 키 파일 선택
  • AgentUserId 추가

그런 다음 목록을 클릭합니다.

모든 기기가 표시됩니다. 목록이 채워지면 Refresh 버튼을 사용하여 기기 상태를 업데이트할 수 있습니다. 기기 상태가 변경되면 행이 녹색으로 강조표시됩니다.

오류 응답

Report State를 호출할 때 다음 오류 응답 중 하나가 표시될 수 있습니다. 이러한 응답은 HTTP 상태 코드 형식으로 제공됩니다.

  • 400 Bad Request - 서버에서 잘못된 구문으로 인해 클라이언트가 보낸 요청을 처리하지 못했습니다. 일반적인 원인으로는 잘못된 형식의 JSON이나 문자열 값에 "" 대신 null이 사용된 것이 있습니다.
  • 404 Not Found - 요청된 리소스를 찾을 수 없지만 나중에 사용 가능할 수 있습니다. 일반적으로 이는 요청된 기기를 찾을 수 없음을 의미합니다. 또한 사용자 계정이 Google과 연결되지 않았거나 잘못된 agentUserId이 수신되었음을 의미할 수도 있습니다. agentUserIdSYNC 응답에 제공된 값과 일치하고 DISCONNECT 인텐트를 제대로 처리하고 있는지 확인합니다.