Demander la synchronisation

La requête de synchronisation déclenche une requête SYNC pour votre traitement pour tout utilisateur Google dont les appareils auxquels sont associés les agentUserId spécifiés (que vous avez envoyée dans la requête SYNC initiale). Cela vous permet de mettre à jour les appareils des utilisateurs sans dissocier ni réassocier leur compte. Tous les utilisateurs associés à cet identifiant recevront une requête SYNC.

Vous devez déclencher une requête SYNC:

• Si l'utilisateur ajoute un nouvel appareil
• Si l'utilisateur supprime un appareil existant.
• si l'utilisateur renomme un appareil existant ;
• vous implémentez un nouveau type d'appareil ou une nouvelle caractéristique, ou ajoutez une nouvelle fonctionnalité d'appareil ;

Premiers pas

Pour implémenter Request Sync, procédez comme suit:

• Activer l'API Google HomeGraph
• Créer une clé de compte de service
• Appeler l'API

Activer l'API Google HomeGraph

1. Dans Google Cloud Console, accédez à la page API HomeGraph.

   Accéder à la page de l'API HomeGraph
2. Sélectionnez le projet qui correspond à l'ID de votre projet smart home.
3. Cliquez sur ENABLE (ACTIVER).

Créer une clé de compte de service

Suivez ces instructions pour générer une clé de compte de service à partir de Google Cloud Console:

1. Dans Google Cloud Console, accédez à la page Créer une clé de compte de service.

   Accéder à la page Créer une clé de compte de service
2. Dans la liste Compte de service, sélectionnez Nouveau compte de service.
3. Dans le champ Nom du compte de service, saisissez un nom.
4. Dans le champ ID du compte de service, saisissez un ID.

5. Dans la liste Rôle, sélectionnez Comptes de service > Créateur de jetons du compte de service.

6. Pour le type de clé, sélectionnez l'option JSON.

7. Cliquez sur Créer. Un fichier JSON contenant votre clé est téléchargé sur votre ordinateur.

Appeler l'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);
    

Réponses d'erreur

Vous pouvez recevoir l'une des réponses d'erreur suivantes lorsque vous appelez Request Sync. Ces réponses se présentent sous la forme de codes d'état HTTP.

• 400 Bad Request : le serveur n'a pas pu traiter la requête envoyée par le client en raison d'une syntaxe non valide. Les causes courantes incluent le format JSON incorrect ou l'utilisation de null au lieu de "" pour une valeur de chaîne.
• 403 Forbidden : le serveur n'a pas pu traiter la requête pour le agentUserId donné en raison d'une erreur lors de l'actualisation du jeton. Assurez-vous que votre point de terminaison OAuth répond correctement à l'actualisation des requêtes de jeton et vérifiez l'état de l'association du compte de l'utilisateur.
• 404 Not Found : la ressource demandée est introuvable, mais elle pourrait l'être ultérieurement. En règle générale, cela signifie que le compte utilisateur n'est pas associé à Google ou que nous avons reçu un agentUserId non valide. Assurez-vous que agentUserId correspond à la valeur fournie dans votre réponse SYNC et que vous gérez correctement les intents DISCONNECT.
• 429 Too Many Requests : le nombre maximal de requêtes de synchronisation simultanées a été dépassé pour le agentUserId donné. Un appelant ne peut émettre qu'une seule requête de synchronisation simultanée, sauf si l'option async est définie sur "true".