Synchronisierung anfordern

Request Sync löst eine SYNC-Anfrage für die Auftragsausführung für alle Google-Nutzer mit Geräten aus, die die angegebene agentUserId haben, die Sie in der ursprünglichen SYNC-Anfrage gesendet haben. So kannst du die Geräte der Nutzer aktualisieren, ohne die Verknüpfung aufzuheben oder ihr Konto wieder zu verknüpfen. Alle mit dieser ID verknüpften Nutzer 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 du einen neuen Gerätetyp implementierst, eine Eigenschaft machst oder eine neue Gerätefunktion hinzufügst:

Erste Schritte

So implementieren Sie Request Sync:

• Google HomeGraph API aktivieren
• Dienstkontoschlüssel erstellen
• API aufrufen

Google HomeGraph API aktivieren

1. Rufen Sie in Google Cloud Console die Seite HomeGraph API auf.

   Zur Seite „HomeGraph API“
2. Wählen Sie das Projekt aus, das Ihrer smart home-Projekt-ID entspricht.
3. Klicken Sie auf AKTIVIEREN.

Dienstkontoschlüssel erstellen

Folgen Sie dieser Anleitung, um einen Dienstkontoschlüssel aus Google Cloud Console zu generieren:

1. Rufen Sie in Google Cloud Console die Seite Dienstkontoschlüssel erstellen auf.

   Zur Seite Dienstkontoschlüssel erstellen
2. Wählen Sie in der Liste Dienstkonto die Option Neues Dienstkonto aus.
3. Geben Sie im Feld Dienstkontoname einen Namen ein.
4. Geben Sie in das Feld Dienstkonto-ID eine ID ein.

5. Wählen Sie in der Liste Rolle die Option Dienstkonten > Ersteller von Dienstkonto-Tokens aus.

6. Wählen Sie für Schlüsseltyp die Option JSON aus.

7. Klicken Sie auf Erstellen. Eine JSON-Datei mit Ihrem Schlüssel wird auf Ihren Computer heruntergeladen.

API aufrufen

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

// 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 Anfragesynchronisierung aufrufen, erhalten Sie möglicherweise eine der folgenden Fehlermeldungen. Diese Antworten erfolgen in 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 fehlerhafter JSON-Code oder die Verwendung von null anstelle von „“ für einen Stringwert.
• 403 Forbidden: Der Server konnte die Anfrage für den angegebenen agentUserId aufgrund eines Fehlers bei der Aktualisierung des Tokens nicht verarbeiten. Achte darauf, dass dein OAuth-Endpunkt korrekt auf Aktualisierungsanfragen von Tokens reagiert und den Verknüpfungsstatus des Nutzers prüft.
• 404 Not Found: Die angeforderte Ressource wurde nicht gefunden, ist aber möglicherweise in Zukunft verfügbar. In der Regel bedeutet dies, dass das Nutzerkonto nicht mit Google verknüpft ist oder wir eine ungültige agentUserId erhalten haben. Achten Sie darauf, dass agentUserId mit dem Wert in Ihrer SYNC-Antwort übereinstimmt und DISCONNECT-Intents richtig verarbeitet werden.
• 429 Too Many Requests: Die maximale Anzahl gleichzeitiger Synchronisierungsanfragen für den angegebenen agentUserId wurde überschritten. Ein Aufrufer darf nur eine gleichzeitige Synchronisierungsanfrage senden, es sei denn, das Flag async ist auf „true“ gesetzt.