Stato rapporto

Report State è una funzionalità importante che consente all'Google Home Action di segnalare in modo proattivo lo stato più recente del dispositivo dell'utente a Google Home Graph anziché attendere un intento QUERY.

Report State segnala a Google gli stati dei dispositivi degli utenti con il agentUserId specificato associato (inviato nella richiesta SYNC originale). Quando Google Assistant vuole intraprendere un'azione che richiede la comprensione dello stato corrente di un dispositivo, può semplicemente cercare le informazioni sullo stato in Home Graph anziché emettere un intento QUERY a vari cloud di terze parti prima di emettere l'intento EXECUTE.

Senza Report State, dato che le luci di più fornitori si trovano in un soggiorno, il comando Hey Google, alza la luminosità del soggiorno richiede la risoluzione di più intent QUERY inviati a più cloud, anziché semplicemente cercare i valori di luminosità attuali in base a quanto è stato registrato in precedenza. Per un'esperienza utente ottimale,Assistant deve avere lo stato corrente di un dispositivo, senza richiedere un viaggio di andata e ritorno al dispositivo.

Dopo il messaggio SYNC iniziale per un dispositivo, la piattaforma invia un'intenzione QUERY che raccoglie lo stato del dispositivo per compilare Home Graph. Dopodiché, Home Graph memorizza solo lo stato inviato con Report State.

Quando chiami Report State, assicurati di fornire dati completi dello stato per un determinato tratto. Home Graph aggiorna gli stati su base alle caratteristiche e sovrascrive tutti i dati relativi a quella caratteristica quando viene eseguita una chiamata Report State. Ad esempio, se stai registrando lo stato per l'attributo StartStop, il payload deve includere i valori sia per isRunning sia per isPaused.

Inizia

Per implementare Report State:

• Abilita l'API Google HomeGraph
• Creare una chiave dell'account di servizio
• Chiama l'API

Abilita l'API Google HomeGraph

1. In Google Cloud Console, vai alla pagina API HomeGraph.

   Vai alla pagina dell'API HomeGraph
2. Seleziona il progetto corrispondente al tuo ID progetto smart home.
3. Fai clic su ABILITA.

Creare una chiave dell'account di servizio

Segui queste istruzioni per generare una chiave dell'account di servizio da Google Cloud Console:

1. In Google Cloud Console, vai alla pagina Crea chiave account di servizio.

   Vai alla pagina Crea chiave dell'account di servizio
2. Nell'elenco Account di servizio, seleziona Nuovo account di servizio.
3. Inserisci un nome nel campo Nome account di servizio.
4. Nel campo ID account di servizio, inserisci un ID.

5. Nell'elenco Ruolo, seleziona Account di servizio > Creatore token account di servizio.

6. In Tipo di chiave, seleziona l'opzione JSON.

7. Fai clic su Crea. Sul computer viene scaricato un file JSON contenente la chiave.

Chiama l'API

Seleziona un'opzione dalle schede seguenti:

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
          }
        }
      }
    }
  }
});
    

  // 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);
}
    

Stato del report del test

Per preparare l'integrazione di Cloud-to-cloud alla certificazione, è importante testare Report State.

Per farlo, ti consigliamo di utilizzare lo strumento di visualizzazione Home Graph, che è un'app web autonoma che non richiede download o implementazione.

La dashboard Report State è ancora disponibile, ma è stata ritirata e non è più supportata.

Dashboard Stato report

Prerequisiti

Prima di poter testare l'integrazione di Cloud-to-cloud, devi avere la chiave dell'account di servizio e agentUserId. Se hai già la chiave dell'account di servizio e agentUserId, consulta Eseguire il deployment della dashboard Report State.

Esegui il deployment della dashboard Stato report

Dopo aver ottenuto la chiave dell'account di servizio e l'ID utente dell'agente per il tuo progetto, scarica e esegui il deployment della versione più recente dalla dashboard Report State. Una volta scaricata la versione più recente, segui le istruzioni riportate nel file README.MD incluso.

Dopo aver disegnato la dashboard Report State, accedi alla dashboard dal seguente URL (sostituisci your_project_id con il tuo ID progetto):

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

Nella dashboard:

• Scegli il file della chiave dell'account
• Aggiungi il tuo agentUserId

Quindi, fai clic su Elenco.

Tutti i tuoi dispositivi sono elencati. Una volta compilato l'elenco, puoi utilizzare il pulsante Aggiorna per aggiornare gli stati dei dispositivi. Se si verifica una modifica dello stato del dispositivo, la riga viene evidenziata in verde.

Risposte di errore

Quando chiami Report State, potresti ricevere una delle seguenti risposte di errore. Queste risposte si presentano sotto forma di codici di stato HTTP.

• 400 Bad Request - Il server non è riuscito a elaborare la richiesta inviata dal client a causa di una sintassi non valida. Le cause comuni includono JSON non valido o l'utilizzo di null anziché "" per un valore di stringa.
• 404 Not Found - La risorsa richiesta non è stata trovata, ma potrebbe essere disponibile in futuro. In genere, significa che non possiamo trovare il dispositivo richiesto. Potrebbe anche significare che l'account utente non è collegato a Google o che abbiamo ricevuto un agentUserId non valido. Assicurati che agentUserId corrisponda al valore fornito nella risposta SYNC e gestisci correttamente gli intent DISCONNECT.