Poproś o synchronizację

Synchronizacja żądań wywołuje żądanie SYNC do Twojej usługi realizacji w przypadku każdego użytkownika Google który ma urządzenia powiązane z określonym agentUserId (wysłanym w pierajtnym żądaniu SYNC). Umożliwia to aktualizowanie urządzeń użytkowników bez odłączania i ponownego łączenia ich kont. Wszyscy użytkownicy powiązani z tym identyfikatorem otrzymają żądanie SYNC.

Musisz wywołać żądanie SYNC:

• gdy użytkownik doda nowe urządzenie,
• gdy użytkownik usunie istniejące urządzenie,
• gdy użytkownik zmieni nazwę istniejącego urządzenia,
• gdy zaimplementujesz nowy typ urządzenia, cechę lub dodasz nową funkcję urządzenia.

Rozpocznij

Aby zaimplementować synchronizację żądań:

• włącz interfejs Google HomeGraph API,
• utwórz klucz konta usługi,
• wywołaj interfejs API.

Włączanie interfejsu Google HomeGraph API

1. W Google Cloud Console otwórz stronę HomeGraph API.

   Otwórz stronę HomeGraph API
2. Wybierz projekt, który odpowiada identyfikatorowi projektu smart home.
3. Kliknij WŁĄCZ.

Tworzenie klucza konta usługi

Aby wygenerować klucz konta usługi z Google Cloud Console:

1. W Google Cloud Console otwórz stronę Konta usługi.

   Otwórz stronę Konta usługi.

   Zanim przejdziesz na stronę Konta usługi, może być konieczne wybranie projektu.

2. Kliknij addUtwórz konto usługi.

3. W polu Nazwa konta usługi wpisz nazwę.

4. W polu Identyfikator konta usługi wpisz identyfikator.

5. W polu Opis konta usługi wpisz opis.

6. Kliknij Utwórz i kontynuuj.

7. W menu Rola wybierz Konta usługi > Twórca tokenów tożsamości OpenID Connect konta usługi.

8. Kliknij Dalej.

9. Kliknij Gotowe.

10. Na liście kont usługi wybierz utworzone konto usługi i wybierz Zarządzaj kluczami z menu more_vert Działania.

11. Kliknij Dodaj klucz > Utwórz nowy klucz.

12. W polu Typ klucza wybierz opcję JSON.

13. Kliknij Utwórz. Na komputer zostanie pobrany plik JSON zawierający klucz.

Wywoływanie interfejsu API

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

Odpowiedzi na błędy

Podczas wywoływania synchronizacji żądań możesz otrzymać jedną z tych odpowiedzi na błędy. Te odpowiedzi mają postać kodów stanu HTTP.

• 400 Bad Request – serwer nie mógł przetworzyć żądania wysłanego przez klienta z powodu nieprawidłowej składni. Typowe przyczyny to nieprawidłowy format JSON lub użycie wartości null zamiast "" w przypadku wartości ciągu znaków.
• 403 Forbidden – serwer nie mógł przetworzyć żądania dla danego agentUserId z powodu błędu podczas odświeżania tokena. Upewnij się, że punkt końcowy protokołu OAuth prawidłowo odpowiada na żądania tokena odświeżania, i sprawdź stan połączenia konta użytkownika.
• 404 Not Found – nie udało się znaleźć żądanego zasobu, ale może on być dostępny w przyszłości. Zwykle oznacza to, że konto użytkownika nie jest połączone z Google lub że otrzymaliśmy nieprawidłowy identyfikator agentUserId. Upewnij się, że identyfikator agentUserId jest zgodny z wartością podaną w Twojej odpowiedzi SYNC i że prawidłowo obsługujesz intencje DISCONNECT.
• 429 Too Many Requests – przekroczono maksymalną liczbę równoczesnych żądań synchronizacji dla danego agentUserId. Wywołujący może wysłać tylko 1 równoczesne żądanie synchronizacji, chyba że flaga async jest ustawiona na true.