Richiedi sincronizzazione

Request Sync attiva una richiesta SYNC al tuo fulfillment per qualsiasi utente Google con dispositivi che hanno l'agentUserId specificato associato (che hai inviato nella richiesta SYNC originale). In questo modo puoi aggiornare i dispositivi degli utenti senza scollegare e ricollegare il loro account. Tutti gli utenti collegati a questo identificatore riceveranno una richiesta di SYNC.

Devi attivare una richiesta SYNC:

  • Se l'utente aggiunge un nuovo dispositivo.
  • Se l'utente rimuove un dispositivo esistente.
  • Se l'utente rinomina un dispositivo esistente.
  • Se implementi un nuovo tipo di dispositivo, tratto o aggiungi una nuova funzionalità del dispositivo.

Inizia

Per implementare Request Sync:

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 che corrisponde al tuo ID progetto smart home.
  3. Fai clic su ABILITA.

Crea una chiave del service account

Segui queste istruzioni per generare una chiave del service account da Google Cloud Console:

Nota: assicurati di utilizzare il progetto Google Cloud corretto quando esegui questi passaggi. Questo è il progetto che corrisponde al tuo ID progetto smart home.
  1. In Google Cloud Console, vai alla pagina Service account.

    Vai alla pagina Service account.

    Potresti dover selezionare un progetto prima di accedere alla pagina Service Account.

  2. Fai clic su Crea service account.

  3. Nel campo Nome account di servizio, inserisci un nome.

  4. Nel campo ID account di servizio, inserisci un ID.

  5. Nel campo Descrizione service account, inserisci una descrizione.

  6. Fai clic su Crea e continua.

  7. Dal menu a discesa Ruolo, seleziona Account di servizio > Service Account OpenID Connect Identity Token Creator.

  8. Fai clic su Continua.

  9. Fai clic su Fine.

  10. Seleziona l'account di servizio appena creato dall'elenco degli account di servizio e seleziona Gestisci chiavi dal menu Azioni.

  11. Seleziona Aggiungi chiave > Crea nuova chiave.

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

  13. Fai clic su Crea. Un file JSON contenente la chiave viene scaricato sul computer.

Per istruzioni dettagliate e informazioni sulla creazione delle chiavi degli account di servizio, vedi Creare ed eliminare le chiavi degli account di servizio nel sito di assistenza della console Google Cloud.

Chiama l'API

HTTP

L'API HomeGraph fornisce un endpoint HTTP

  1. Utilizza il file JSON dell'account di servizio scaricato per creare un JSON Web Token (JWT). Per maggiori informazioni, vedi Autenticazione tramite un service account.
  2. Ottieni un token di accesso OAuth 2.0 con l'ambito https://www.googleapis.com/auth/homegraph utilizzando oauth2l:
  3. oauth2l fetch --credentials service-account.json \
      --scope https://www.googleapis.com/auth/homegraph
    
  4. Crea la richiesta JSON con agentUserId. Ecco una richiesta JSON di esempio per Request Sync:
  5. {
      "agentUserId": "user-123"
    }
  6. Combina il JSON Request Sync e il token nella richiesta HTTP POST all'endpoint Google Home Graph. Ecco un esempio di come effettuare la richiesta nella riga di comando utilizzando curl, come test:
  7. curl -X POST -H "Authorization: Bearer ACCESS_TOKEN" \
      -H "Content-Type: application/json" \
      -d @request-body.json \
      "https://homegraph.googleapis.com/v1/devices:requestSync"
    

gRPC

L'API Home Graph fornisce un endpoint gRPC

  1. Ottieni la definizione del servizio dei buffer di protocollo per l'API Home Graph.
  2. Segui la documentazione per sviluppatori gRPC per generare stub client per una delle lingue supportate.
  3. Chiama il metodo RequestSync.

Node.js

Il client Node.js delle API di Google fornisce associazioni per l'API Home Graph.

  1. Inizializza il servizio google.homegraph utilizzando le credenziali predefinite dell'applicazione.
  2. Chiama il metodo requestSync con RequestSyncDevicesRequest. Restituisce un Promise con un RequestSyncDevicesResponse vuoto.
const homegraphClient = homegraph({
  version: 'v1',
  auth: new GoogleAuth({
    scopes: 'https://www.googleapis.com/auth/homegraph'
  })
});

const res = await homegraphClient.devices.requestSync({
  requestBody: {
    agentUserId: 'PLACEHOLDER-USER-ID',
    async: false
  }
});
    

Java

La libreria client dell'API HomeGraph per Java fornisce associazioni per l'API HomeGraph.

  1. Inizializza HomeGraphApiService utilizzando le credenziali predefinite dell'applicazione.
  2. Chiama il metodo requestSync con RequestSyncDevicesRequest. Restituisce un ReportStateAndNotificationResponse vuoto.
// 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();

// Request sync.
RequestSyncDevicesRequest request =
    new RequestSyncDevicesRequest().setAgentUserId("PLACEHOLDER-USER-ID").setAsync(false);
homegraphService.devices().requestSync(request);
    

Risposte di errore

Quando chiami Request Sync, 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 stringa.
  • 403 Forbidden - Il server non è riuscito a elaborare la richiesta per agentUserId a causa di un errore durante l'aggiornamento del token. Assicurati che l'endpoint OAuth risponda correttamente alle richieste di token di aggiornamento e controlla lo stato del collegamento dell'account dell'utente.
  • 404 Not Found - Impossibile trovare la risorsa richiesta, ma potrebbe essere disponibile in futuro. In genere, questo significa che l'account utente non è collegato a Google o abbiamo ricevuto un agentUserId non valido. Assicurati che agentUserId corrisponda al valore fornito nella risposta SYNC e che tu gestisca correttamente gli intent DISCONNECT.
  • 429 Too Many Requests - È stato superato il numero massimo di richieste di sincronizzazione simultanea per il agentUserId specificato. Un chiamante può inviare una sola richiesta di sincronizzazione simultanea, a meno che il flag async non sia impostato su true.