„Request Sync“ löst eine SYNC
-Anfrage an deine Auslieferung für alle Google-Nutzer mit Geräten aus, die mit der angegebenen agentUserId
verknüpft sind, die du in der ursprünglichen SYNC-Anfrage gesendet hast. So können Sie die Geräte der Nutzer aktualisieren, ohne die Verknüpfung mit ihrem Konto aufzuheben und wieder herzustellen. Alle Nutzer, die mit dieser Kennung verknüpft sind, erhalten eine SYNC
-Anfrage.
Sie müssen eine SYNC
-Anfrage auslösen:
- Wenn der Nutzer ein neues Gerät hinzufügt.
- Wenn der Nutzer ein vorhandenes Gerät entfernt.
- Wenn der Nutzer ein vorhandenes Gerät umbenennt.
- Wenn Sie einen neuen Gerätetyp oder eine neue Eigenschaft implementieren oder eine neue Gerätefunktion hinzufügen.
Jetzt starten
So implementierst du die Anfragesynchronisierung:
Google HomeGraph API aktivieren
-
Rufen Sie in der Google Cloud Console die Seite HomeGraph API auf.
Zur Seite „HomeGraph API“ - Wählen Sie das Projekt aus, das Ihrer smart home-Projekt-ID entspricht.
- Klicken Sie auf AKTIVIEREN.
Dienstkontoschlüssel erstellen
So generieren Sie einen Dienstkontoschlüssel aus der Google Cloud Console:
-
Rufen Sie in der Google Cloud Console die Seite Dienstkonten auf.
Rufen Sie die Seite „Dienstkonten“ auf.Möglicherweise müssen Sie ein Projekt auswählen, bevor Sie zur Seite „Dienstkonten“ weitergeleitet werden.
Klicken Sie auf
Dienstkonto erstellen.Geben Sie im Feld Dienstkontoname einen Namen ein.
Geben Sie im Feld Dienstkonto-ID eine ID ein.
Geben Sie im Feld Dienstkontobeschreibung eine Beschreibung ein.
Klicken Sie auf Erstellen und fortfahren.
Wählen Sie im Drop-down-Menü Rolle die Option Dienstkonten > Ersteller von OpenID Connect-Identitätstokens für Dienstkonten aus.
Klicken Sie auf Weiter.
Klicken Sie auf Fertig.
Wählen Sie in der Liste der Dienstkonten das gerade erstellte Dienstkonto und dann im Menü
Aktionen die Option Schlüssel verwalten aus.Wählen Sie Schlüssel hinzufügen > Neuen Schlüssel erstellen aus.
Wählen Sie als Schlüsseltyp die Option JSON aus.
Klicken Sie auf Erstellen. Eine JSON-Datei mit Ihrem Schlüssel wird auf Ihren Computer heruntergeladen.
API aufrufen
Die Home Graph API bietet einen HTTP-Endpunkt.
- Verwenden Sie die heruntergeladene JSON-Datei des Dienstkontos, um ein JSON Web Token (JWT) zu erstellen. Weitere Informationen finden Sie unter Authentifizierung mit einem Dienstkonto.
- Rufen Sie mit oauth2l ein OAuth 2.0-Zugriffstoken mit dem Bereich
https://www.googleapis.com/auth/homegraph
ab: - Erstellen Sie die JSON-Anfrage mit der
agentUserId
. Hier ist eine Beispiel-JSON-Anfrage für die Synchronisierungsanfrage: - Kombiniere das JSON-Objekt „Request Sync“ und das Token in deiner HTTP-POST-Anfrage an den Google Home Graph-Endpunkt. Hier ein Beispiel für die Anfrage in der Befehlszeile mit
curl
als Test:
oauth2l fetch --credentials service-account.json \ --scope https://www.googleapis.com/auth/homegraph
{ "agentUserId": "user-123" }
curl -X POST -H "Authorization: BearerACCESS_TOKEN " \ -H "Content-Type: application/json" \ -d @request-body.json \ "https://homegraph.googleapis.com/v1/devices:requestSync"
Die Home Graph API bietet einen gRPC-Endpunkt.
- Rufen Sie die Protocol Buffers-Dienstdefinition für die Home Graph API ab.
- Folgen Sie der gRPC-Entwicklerdokumentation, um Client-Stubs für eine der unterstützten Sprachen zu generieren.
- Rufen Sie die Methode RequestSync auf.
Der Node.js-Client für Google APIs bietet Bindungen für die Home Graph API.
- Initialisieren Sie den Dienst
google.homegraph
mit Standardanmeldedaten für Anwendungen. - Rufen Sie die Methode
requestSync
mit der RequestSyncDevicesRequest auf. Es gibt einePromise
mit einer leeren RequestSyncDevicesResponse zurück.
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 } });
Die Home Graph API-Clientbibliothek für Java bietet Bindungen für die Home Graph API.
- Initialisieren Sie die
HomeGraphApiService
mit Standardanmeldedaten für Anwendungen. - Rufen Sie die Methode
requestSync
mit demRequestSyncDevicesRequest
auf. Es wird eine leereReportStateAndNotificationResponse
zurückgegeben.
// 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);
Fehlerantworten
Wenn Sie „Synchronisierung anfordern“ aufrufen, erhalten Sie möglicherweise eine der folgenden Fehlerantworten. Diese Antworten haben die Form von HTTP-Statuscodes.
400 Bad Request
: Der Server konnte die vom Client gesendete Anfrage aufgrund einer ungültigen Syntax nicht verarbeiten. Häufige Ursachen sind fehlerhafte JSON-Dateien oder die Verwendung vonnull
anstelle von „"" für einen Stringwert.403 Forbidden
: Der Server konnte die Anfrage für die angegebeneagentUserId
aufgrund eines Fehlers beim Aktualisieren des Tokens nicht verarbeiten. Prüfen Sie, ob Ihr OAuth-Endpunkt richtig auf Aktualisierungstokenanfragen reagiert, und prüfen Sie den Kontoverknüpfungsstatus des Nutzers.404 Not Found
– Die angeforderte Ressource konnte nicht gefunden werden, ist aber möglicherweise in Zukunft verfügbar. In der Regel bedeutet das, dass das Nutzerkonto nicht mit Google verknüpft ist oder wir eine ungültigeagentUserId
erhalten haben. Achte darauf, dassagentUserId
mit dem Wert in deiner SYNC-Antwort übereinstimmt und du DISCONNECT-Intents richtig handhabst.429 Too Many Requests
– Die maximale Anzahl gleichzeitiger Synchronisierungsanfragen für die angegebeneagentUserId
wurde überschritten. Ein Aufrufer kann nur eine gleichzeitige Synchronisierungsanfrage senden, es sei denn, dasasync
-Flag ist auf „wahr“ gesetzt.