Le notifiche consentono all'azione smart home di utilizzare Google Assistant per comunicare con gli utenti su eventi o modifiche importanti relativi ai dispositivi. Puoi implementare notifiche per avvisare gli utenti di eventi tempestivi del dispositivo, ad esempio quando c'è qualcuno alla porta, o per segnalare una richiesta di modifica dello stato del dispositivo, ad esempio quando un chiavistello della serratura della porta è stato attivato correttamente o si è bloccato.
L'azione smart home può inviare i seguenti tipi di notifiche agli utenti:
Notifiche proattive: avvisa l'utente di un evento del dispositivo smart home senza alcuna precedente richiesta dell'utente ai suoi dispositivi, ad esempio il campanello che suona.
Risposte di follow-up: una conferma che una richiesta di comando del dispositivo è riuscita o meno, ad esempio durante la chiusura di una porta. Usa questi avvisi per i comandi del dispositivo il cui completamento richiede tempo. Le risposte di follow-up sono supportate solo quando le richieste di comando del dispositivo vengono inviate da smart speaker e smart display.
Assistant fornisce queste notifiche agli utenti come annunci su smart speaker e smart display. Le notifiche proattive sono disattivate per impostazione predefinita. Gli utenti hanno la possibilità di attivare o disattivare tutte le notifiche proattive da Google Home app (GHA).
Eventi che attivano le notifiche
Quando si verificano eventi del dispositivo, l'evasione degli ordini dell'azione invia una richiesta di notifica a Google. I trait del dispositivo supportati dall'Azione smart home determinano i tipi di eventi di notifica disponibili e i dati che puoi includere in queste notifiche.
Le notifiche proattive sono supportate dai seguenti tratti:
Tratto | Eventi |
---|---|
ObjectDetection | Oggetti rilevati dal dispositivo, ad esempio quando viene rilevato un volto riconosciuto alla porta. Ad esempio: "Alice e Bob sono alla porta." |
RunCycle | Il dispositivo completa un ciclo. Ad esempio: "Il ciclo della lavatrice è terminato". |
SensorState | Il dispositivo rileva uno stato del sensore supportato. Ad esempio: "Il rilevatore di fumo rileva fumo". |
TemperatureControl | Il dispositivo raggiunge un set-point di temperatura. Ad esempio: "Il forno è stato preriscaldato a 350 gradi". |
ArmDisarm | Il sistema entra in uno stato di pre-sveglia con un conto alla rovescia per l'accesso, attivato da una porta aperta. |
CameraStream | Link al live streaming della videocamera dopo che il dispositivo rileva un oggetto o un movimento. |
MotionDetection | "È stato rilevato un movimento alle 12:00 del 1° luglio 2020." |
Le seguenti caratteristiche supportano le risposte di follow-up:
Tratto | Eventi |
---|---|
ArmDisarm | Stato di completamento e modifica dello stato dopo l'esecuzione del
comando action.devices.commands.ArmDisarm del dispositivo. Ad esempio:
"Il sistema di sicurezza è stato abilitato."
|
LockUnlock | Stato di completamento e modifica dello stato dopo l'esecuzione del
comando action.devices.commands.LockUnlock del dispositivo. Ad
esempio: "La porta principale è stata chiusa" o "La porta principale è inceppata".
|
NetworkControl | Stato di completamento e modifica dello stato dopo l'esecuzione del
comando action.devices.commands.TestNetworkSpeed del dispositivo. Ad
esempio: "Il test di velocità della rete è terminato. La velocità di download sul router dell'ufficio attualmente è di 80,2 Kbps e di caricamento di 9,3 Kbps."
|
OpenClose | Stato di completamento e modifica dello stato dopo l'esecuzione del
comando action.devices.commands.OpenClose del dispositivo. Ad
esempio: "La porta principale si è aperta" o "Impossibile aprire la porta principale".
|
StartStop | Stato di completamento e modifica dello stato dopo l'esecuzione del
comando action.devices.commands.StartStop del dispositivo. Ad
esempio: "L'aspirapolvere è stato avviato."
|
Tutti i tipi di dispositivi supportano le notifiche per i trait applicabili.
Crea notifiche per la tua azione smart home
Aggiungi notifiche all'azione smart home in queste fasi:
- Indica a Google se le notifiche sono attivate dall'app del dispositivo smart home. Se gli utenti attivano o disattivano le notifiche nella tua app, invia una richiesta
SYNC
per informare Google della modifica del dispositivo. - Quando si verifica un evento o un cambiamento dello stato pertinente del dispositivo che attiva una
notifica, invia una richiesta di notifica chiamando l'API
Report State
reportStateAndNotification
. Se lo stato del dispositivo è cambiato, puoi inviare insieme uno stato e un payload di notifica nella chiamata Report State e nella chiamata di notifica.
Questi passaggi vengono descritti nelle sezioni seguenti in modo più dettagliato.
Indica se le notifiche sono attivate nella tua app
Gli utenti possono scegliere se ricevere o meno notifiche proattive attivando questa funzionalità in GHA. Nell'app del tuo dispositivo smart home, se vuoi, puoi anche consentire agli utenti di attivare/disattivare in modo esplicito le notifiche dal dispositivo, ad esempio dalle impostazioni dell'app.
Indica a Google che le notifiche sono attivate per il tuo dispositivo effettuando una chiamata Richiedi SINC per aggiornare i dati del dispositivo. Devi inviare una richiesta SYNC
come questa ogni volta
che gli utenti modificano questa impostazione nell'app.
Nella risposta di SYNC
, invia uno di questi aggiornamenti:
- Se l'utente ha attivato esplicitamente le notifiche nell'app del tuo dispositivo o se
non fornisci un'opzione di attivazione/disattivazione, imposta la
proprietà
devices.notificationSupportedByAgent
sutrue
. - Se l'utente ha disattivato esplicitamente le notifiche nell'app del dispositivo, imposta la proprietà
devices.notificationSupportedByAgent
sufalse
.
Il seguente snippet mostra un esempio di come impostare la risposta SYNC:
devices: [{
id: 'device123',
...
notificationSupportedByAgent: true,
}]
Invia richieste di notifica a Google
Per attivare le notifiche su Assistant, il tuo evasione degli ordini invia un payload di notifica a Google Home Graph tramite una chiamata Report State e API Notification.
Attiva l'API Google HomeGraph
-
In Google Cloud Console, vai alla pagina dell'API HomeGraph.
Vai alla pagina dell'API HomeGraph - Seleziona il progetto che corrisponde al tuo ID progetto smart home.
- Fai clic su ABILITA.
Creare una chiave dell'account di servizio
Segui queste istruzioni per generare una chiave dell'account di servizio dal Google Cloud Console:
-
In Google Cloud Console, vai alla pagina Crea chiave account di servizio.
Vai alla pagina Crea chiave dell'account di servizio - Dall'elenco Account di servizio, seleziona Nuovo account di servizio.
- Inserisci un nome nel campo Nome account di servizio.
- Nel campo ID account di servizio, inserisci un ID.
Nell'elenco Ruolo, seleziona Account di servizio > Creatore token account di servizio.
In Tipo di chiave, seleziona l'opzione JSON.
- Fai clic su Crea. Un file JSON contenente la chiave viene scaricato sul computer.
Invia la notifica
Effettua la chiamata di richiesta di notifica utilizzando
l'API devices.reportStateAndNotification
.
La richiesta JSON deve includere un eventId
, ovvero un ID univoco generato dalla tua piattaforma per l'evento che attiva la notifica. eventId
dovrebbe
essere un ID casuale diverso ogni volta che invii una richiesta di notifica.
Nell'oggetto notifications
che passi nella chiamata API, includi un
valore priority
che definisce il modo in cui deve essere presentata la notifica. L'oggetto
notifications
potrebbe includere campi diversi a seconda delle caratteristiche
del dispositivo.
Segui uno di questi percorsi per impostare il payload e chiamare l'API:
Invia un payload di notifica proattiva
Per chiamare l'API, seleziona un'opzione da una delle seguenti schede:
HTTP
L'API Home Graph fornisce un endpoint HTTP
- Utilizza il file JSON dell'account di servizio scaricato per creare un token web JSON (JWT). Per maggiori informazioni, consulta la sezione Autenticazione con un account di servizio.
- Ottieni un token di accesso OAuth 2.0 con l'ambito
https://www.googleapis.com/auth/homegraph
utilizzando oauth2l: - Crea la richiesta JSON con
agentUserId
. Ecco un esempio di richiesta JSON per Report State e Notification: - Combina i dati JSON Report State e Notification e il token nella richiesta HTTP POST
all'endpoint di Google Home Graph. Ecco un esempio di come effettuare la richiesta nella riga di comando utilizzando
curl
, come test:
oauth2l fetch --credentials service-account.json \ --scope https://www.googleapis.com/auth/homegraph
{ "agentUserId": "PLACEHOLDER-USER-ID", "eventId": "PLACEHOLDER-EVENT-ID", "requestId": "PLACEHOLDER-REQUEST-ID", "payload": { "devices": { "notifications": { "PLACEHOLDER-DEVICE-ID": { "ObjectDetection": { "priority": 0, "detectionTimestamp": 1534875126750, "objects": { "named": [ "Alice" ], "unclassified": 2 } } } } } } }
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
L'API Home Graph fornisce un endpoint gRPC
- Ottieni la definizione del servizio dei buffer di protocollo per l'API Home Graph.
- Segui la documentazione per gli sviluppatori gRPC per generare stub client per uno dei lingue supportati.
- Chiama il metodo ReportStateAndNotification.
Node.js
Il client Node.js delle API di Google fornisce associazioni per l'API Home Graph.
- Inizializza il servizio
google.homegraph
utilizzando Credenziali predefinite dell'applicazione. - Chiama il metodo
reportStateAndNotification
con ReportStateAndNotificationRequest. Restituisce un valorePromise
con ReportStateAndNotificationResponse.
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', eventId: 'PLACEHOLDER-EVENT-ID', requestId: 'PLACEHOLDER-REQUEST-ID', payload: { devices: { notifications: { 'PLACEHOLDER-DEVICE-ID': { ObjectDetection: { priority: 0, detectionTimestamp: 1534875126750, objects: { named: ['Alice'], unclassified: 2 } } } } } } } });
Java
La libreria client dell'API HomeGraph per Java fornisce associazioni per l'API Home Graph.
- Inizializza
HomeGraphApiService
utilizzando Credenziali predefinite dell'applicazione. - Chiama il metodo
reportStateAndNotification
conReportStateAndNotificationRequest
. Restituisce un valoreReportStateAndNotificationResponse
.
// 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 notification payload. Map<?, ?> notifications = Map.of( "ObjectDetection", Map.of( "priority", 0, "detectionTimestamp", 1534875126, "objects", Map.of("named", List.of("Alice"), "unclassifed", 2))); // Send notification. ReportStateAndNotificationRequest request = new ReportStateAndNotificationRequest() .setRequestId("PLACEHOLDER-REQUEST-ID") .setAgentUserId("PLACEHOLDER-USER-ID") .setEventId("PLACEHOLDER-EVENT-ID") .setPayload( new StateAndNotificationPayload() .setDevices( new ReportStateAndNotificationDevice() .setNotifications(Map.of("PLACEHOLDER-DEVICE-ID", notifications)))); homegraphService.devices().reportStateAndNotification(request);
Invia un payload di risposta di follow-up
Il payload per una risposta di follow-up contiene lo stato della richiesta, i codici di errore per gli errori degli eventi, se applicabili, e il valore followUpToken
valido, fornito durante la richiesta di intent EXECUTE
. followUpToken
deve essere utilizzato entro cinque minuti per rimanere valido e associare correttamente la risposta alla richiesta originale.
Il seguente snippet mostra un esempio di payload di richiesta EXECUTE
con un
campo followUpToken
.
{ "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf", "inputs": [{ "intent": "action.devices.EXECUTE", "payload": { "commands": [{ "devices": [{ "id": "123", }], "execution": [{ "command": "action.devices.commands.TestNetworkSpeed", "params": { "testDownloadSpeed": true, "testUploadSpeed": false, "followUpToken": "PLACEHOLDER" } }] }] } }] };
Google utilizza followUpToken
per inviare la notifica solo sul dispositivo
con cui l'utente stava inizialmente interagendo e non per trasmetterla su tutti
i dispositivi dell'utente.
Per chiamare l'API, seleziona un'opzione da una delle seguenti schede:
HTTP
L'API Home Graph fornisce un endpoint HTTP
- Utilizza il file JSON dell'account di servizio scaricato per creare un token web JSON (JWT). Per maggiori informazioni, consulta la sezione Autenticazione con un account di servizio.
- Ottieni un token di accesso OAuth 2.0 con l'ambito
https://www.googleapis.com/auth/homegraph
utilizzando oauth2l: - Crea la richiesta JSON con
agentUserId
. Ecco un esempio di richiesta JSON per Report State e Notification: - Combina i dati JSON Report State e Notification e il token nella richiesta HTTP POST
all'endpoint di Google Home Graph. Ecco un esempio di come effettuare la richiesta nella riga di comando utilizzando
curl
, come test:
oauth2l fetch --credentials service-account.json \ --scope https://www.googleapis.com/auth/homegraph
{ "agentUserId": "PLACEHOLDER-USER-ID", "eventId": "PLACEHOLDER-EVENT-ID", "requestId": "PLACEHOLDER-REQUEST-ID", "payload": { "devices": { "notifications": { "PLACEHOLDER-DEVICE-ID": { "NetworkControl": { "priority": 0, "followUpResponse": { "status": "SUCCESS", "followUpToken": "PLACEHOLDER", "networkDownloadSpeedMbps": 23.3, "networkUploadSpeedMbps": 10.2 } } } } } } }
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
L'API Home Graph fornisce un endpoint gRPC
- Ottieni la definizione del servizio dei buffer di protocollo per l'API Home Graph.
- Segui la documentazione per gli sviluppatori gRPC per generare stub client per uno dei lingue supportati.
- Chiama il metodo ReportStateAndNotification.
Node.js
Il client Node.js delle API di Google fornisce associazioni per l'API Home Graph.
- Inizializza il servizio
google.homegraph
utilizzando Credenziali predefinite dell'applicazione. - Chiama il metodo
reportStateAndNotification
con ReportStateAndNotificationRequest. Restituisce un valorePromise
con ReportStateAndNotificationResponse.
const followUpToken = executionRequest.inputs[0].payload.commands[0].execution[0].params.followUpToken; 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', eventId: 'PLACEHOLDER-EVENT-ID', requestId: 'PLACEHOLDER-REQUEST-ID', payload: { devices: { notifications: { 'PLACEHOLDER-DEVICE-ID': { NetworkControl: { priority: 0, followUpResponse: { status: 'SUCCESS', followUpToken, networkDownloadSpeedMbps: 23.3, networkUploadSpeedMbps: 10.2, } } } } } } } });
Java
La libreria client dell'API HomeGraph per Java fornisce associazioni per l'API Home Graph.
- Inizializza
HomeGraphApiService
utilizzando Credenziali predefinite dell'applicazione - Chiama il metodo
reportStateAndNotification
conReportStateAndNotificationRequest
. Restituisce un elementoReportStateAndNotificationResponse
// 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(); // Extract follow-up token. ExecuteRequest.Inputs executeInputs = (Inputs) executeRequest.getInputs()[0]; String followUpToken = (String) executeInputs .getPayload() .getCommands()[0] .getExecution()[0] .getParams() .get("followUpToken"); // Build device follow-up response payload. Map<?, ?> followUpResponse = Map.of( "NetworkControl", Map.of( "priority", 0, "followUpResponse", Map.of( "status", "SUCCESS", "followUpToken", followUpToken, "networkDownloadSpeedMbps", 23.3, "networkUploadSpeedMbps", 10.2))); // Send follow-up response. ReportStateAndNotificationRequest request = new ReportStateAndNotificationRequest() .setRequestId("PLACEHOLDER-REQUEST-ID") .setAgentUserId("PLACEHOLDER-USER-ID") .setEventId("PLACEHOLDER-EVENT-ID") .setPayload( new StateAndNotificationPayload() .setDevices( new ReportStateAndNotificationDevice() .setNotifications(Map.of("PLACEHOLDER-DEVICE-ID", followUpResponse)))); homegraphService.devices().reportStateAndNotification(request);
Logging
Le notifiche supportano il logging degli eventi come descritto in Accedere ai log eventi con Cloud Logging. Questi log sono utili per testare e mantenere la qualità delle notifiche nell'azione.
Di seguito è riportato lo schema di una voce notificationLog
:
Proprietà | Descrizione |
---|---|
requestId |
ID richiesta di notifica. |
structName |
Nome dello struct di notifica, ad esempio "ObjectDetection". |
status |
Indica lo stato della notifica. |
Il campo status
include vari stati che potrebbero indicare errori nel payload delle notifiche. Alcune di queste potrebbero essere disponibili solo per le azioni
che non sono state lanciate in produzione.
Ecco alcuni esempi di stati:
Stato | Descrizione |
---|---|
EVENT_ID_MISSING |
Indica che manca il campo obbligatorio eventId .
|
PRIORITY_MISSING |
Indica che manca un campo priority .
|
NOTIFICATION_SUPPORTED_BY_AGENT_FALSE |
Indica che la proprietà notificationSupportedByAgent del dispositivo di notifica specificata in SYNC è falsa.
|
NOTIFICATION_ENABLED_BY_USER_FALSE |
Indica che l'utente non ha attivato le notifiche sul dispositivo di notifica in GHA. Questo stato è disponibile solo per le azioni che non sono state lanciate in produzione. |
NOTIFYING_DEVICE_NOT_IN_STRUCTURE |
Indica che l'utente non ha assegnato il dispositivo di notifica a una casa/struttura. Questo stato è disponibile solo per le azioni che non sono state lanciate in produzione. |
Oltre a questi stati generali che possono essere applicati a tutte le notifiche, il campo status
può anche includere stati specifici trait, ove applicabile (ad es. OBJECT_DETECTION_DETECTION_TIMESTAMP_MISSING
).