Request Sync déclenche une requête SYNC sur votre traitement pour tout utilisateur Google auquel des appareils agentUserId sont associés (ce que vous avez envoyé dans la requête SYNC d'origine). 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 appareil
- Si l'utilisateur supprime un appareil existant
- Si l'utilisateur renomme un appareil existant.
- si vous implémentez un nouveau type d'appareil, une caractéristique ou ajoutez une fonctionnalité d'appareil.
Premiers pas
Pour implémenter la synchronisation des requêtes, procédez comme suit:
Activer l'API Google HomeGraph
-
Dans Google Cloud Console, accédez à la page API HomeGraph.
Accéder à la page de l'API HomeGraph - Sélectionnez le projet correspondant à votre ID de projet smart home.
- 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:
-
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 - Dans la liste Compte de service, sélectionnez Nouveau compte de service.
- Dans le champ Nom du compte de service, saisissez un nom.
- Dans le champ ID de compte de service, saisissez un ID.
Dans la liste Rôle, sélectionnez Comptes de service > Créateur de jetons du compte de service.
Dans le champ Type de clé, sélectionnez l'option JSON.
- Cliquez sur Créer. Un fichier JSON contenant votre clé est téléchargé sur votre ordinateur.
Appeler l'API
HTTP
L'API Home Graph fournit un point de terminaison HTTP
- Utilisez le fichier JSON du compte de service téléchargé pour créer un jeton Web JSON (JWT). Pour en savoir plus, consultez S'authentifier à l'aide d'un compte de service.
- Obtenez un jeton d'accès OAuth 2.0 avec le champ d'application
https://www.googleapis.com/auth/homegraphà l'aide de la section oauth2l: - Créez la requête JSON avec
agentUserId. Voici un exemple de requête JSON pour Request Sync: - Combinez le fichier JSON de requête de synchronisation et le jeton de votre requête HTTP POST au point de terminaison Google Home Graph. Voici un exemple d'exécution de la requête dans la ligne de commande à l'aide de
curl, à titre de test:
oauth2l fetch --credentials service-account.json \ --scope https://www.googleapis.com/auth/homegraph
{
"agentUserId": "user-123"
}
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 fournit un point de terminaison gRPC
- Obtenez la définition du service de tampons de protocole pour l'API Home Graph.
- Suivez la documentation destinée aux développeurs gRPC pour générer des bouchons client dans l'un des langages compatibles.
- Appelez la méthode RequestSync.
Node.js
Le client Node.js des API Google fournit des liaisons pour l'API Home Graph.
- Initialisez le service
google.homegraphà l'aide des identifiants par défaut de l'application. - Appelez la méthode
requestSyncavec RequestSyncDevicesRequest. Elle renvoie unPromiseavec un RequestSyncDevicesResponse vide.
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 bibliothèque cliente de l'API HomeGraph pour Java fournit des liaisons pour l'API Home Graph.
- Initialisez
HomeGraphApiServiceà l'aide des identifiants par défaut de l'application. - Appelez la méthode
requestSyncavecRequestSyncDevicesRequest. Elle renvoie une valeurReportStateAndNotificationResponsevide.
// 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
Lorsque vous appelez Request Sync, l'une des réponses suivantes peut s'afficher. 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 les plus courantes sont des fichiers JSON incorrects ou l'utilisation denullau lieu de "" pour une valeur de chaîne.403 Forbidden: le serveur n'a pas pu traiter la requête concernantagentUserIddonné en raison d'une erreur lors de l'actualisation du jeton. Assurez-vous que votre point de terminaison OAuth répond correctement pour actualiser les requêtes de jeton et vérifiez l'état d'association du compte de l'utilisateur.404 Not Found: la ressource demandée est introuvable, mais peut être disponible à l'avenir. En général, cela signifie que le compte utilisateur n'est pas associé à Google ou que nous avons reçu unagentUserIdnon valide. Assurez-vous queagentUserIdcorrespond à la valeur fournie dans votre réponse SYNC et que vous gérez correctement les intents DÉCONNECTER.429 Too Many Requests: vous avez dépassé le nombre maximal de requêtes de synchronisation simultanées pour leagentUserIddonné. Un appelant ne peut émettre qu'une seule requête de synchronisation simultanée, sauf si l'optionasyncest définie sur "true".