La sincronización de solicitudes activa una solicitud SYNC
en tu entrega para cualquier usuario de Google con dispositivos que tengan asociado el agentUserId
especificado (que enviaste en la solicitud original de SYNC). Esto te permite actualizar los dispositivos de los usuarios sin desvincular ni volver a vincular su cuenta. Todos los usuarios vinculados a este identificador recibirán una solicitud SYNC
.
Debes activar una solicitud SYNC
:
- Si el usuario agrega un dispositivo nuevo.
- Si el usuario quita un dispositivo existente.
- Si el usuario cambia el nombre de un dispositivo existente.
- Si implementas un nuevo tipo de dispositivo, característica o característica nueva.
Cómo comenzar
Para implementar la sincronización de solicitudes, sigue estos pasos:
Habilitar la API de Google HomeGraph
-
Google Cloud Console , go to the HomeGraph API page.
Ir a la página de la API de HomeGraph - Selecciona el proyecto que coincida con tu smart home ID del proyecto.
- Haz clic en HABILITAR.
Crear una clave de cuenta de servicio
Sigue estas instrucciones para generar una clave de cuenta de servicio desde el Google Cloud Console:
-
En la Google Cloud Console, ve a la página Crear clave de la cuenta de servicio.
Ir a la página Crear clave de la cuenta de servicio - En la lista Cuenta de servicio, selecciona Cuenta de servicio nueva.
- Ingresa un nombre en el campo Nombre de cuenta de servicio.
- Ingresa un ID en el campo ID de cuenta de servicio.
En la lista Función, selecciona Cuentas de servicio > Creador de tokens de cuenta de servicio.
En Tipo de clave, selecciona la opción JSON.
- Haz clic en Crear. Se descargará a tu computadora un archivo JSON con la clave.
Llamar a la API
HTTP
La API de Home Graph proporciona un extremo HTTP
- Usa el archivo JSON descargado de la cuenta de servicio para crear un token web JSON (JWT). Para obtener más información, consulta Autentica mediante una cuenta de servicio.
- Obtén un token de acceso de OAuth 2.0 con el permiso
https://www.googleapis.com/auth/homegraph
mediante oauth2l: - Crea la solicitud JSON con el
agentUserId
. A continuación, se incluye un ejemplo de una solicitud JSON para Request Sync: - Combina el JSON de Request Sync y el token de tu solicitud HTTP POST en el extremo de Google Home Graph. Aquí hay un ejemplo de cómo realizar la solicitud en la línea de comandos mediante
curl
, como una prueba:
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
La API de Home Graph proporciona un extremo gRPC
- Obtén la definición del servicio de los búferes de protocolo para la API de Home Graph.
- Sigue la documentación de gRPC para desarrolladores a fin de generar stubs cliente para uno de los lenguajes compatibles.
- Llama al método RequestSync.
Node.js
El cliente Node.js de las API de Google proporciona vinculaciones para la API de Home Graph.
- Inicializa el servicio
google.homegraph
con las credenciales predeterminadas de la aplicación. - Llama al método
requestSync
con RequestSyncDevicesRequest. Muestra unPromise
con una RequestSyncDevicesResponse vacía.
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 biblioteca cliente de la API de HomeGraph para Java proporciona vínculos a la API de Home Graph.
- Inicializa
HomeGraphApiService
con las credenciales predeterminadas de la aplicación. - Llama al método
requestSync
conRequestSyncDevicesRequest
. Muestra unReportStateAndNotificationResponse
vacío.
// 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);
Respuestas de error
Es posible que recibas una de las siguientes respuestas de error cuando llames a Sync Sync. Estas respuestas se proporcionan en forma de códigos de estado HTTP.
400 Bad Request
: el servidor no pudo procesar la solicitud que envió el cliente debido a la sintaxis no válida. Las causas comunes incluyen JSON con formato incorrecto o el uso denull
en lugar de "" para un valor de string.403 Forbidden
: El servidor no pudo procesar la solicitud deagentUserId
debido a un error mientras se actualizaba el token. Asegúrate de que tu extremo de OAuth responda de forma correcta para actualizar las solicitudes de token y verificar el estado de vinculación de la cuenta del usuario.404 Not Found
: no se pudo encontrar el recurso solicitado, pero podría estar disponible en el futuro. Por lo general, esto significa que la cuenta de usuario no está vinculada con Google o recibimos unagentUserId
no válido. Asegúrate de queagentUserId
coincida con el valor proporcionado en tu respuesta SYNC y de que manejes correctamente los intents DISCONNECT.429 Too Many Requests
: Se superó la cantidad máxima de solicitudes de sincronización simultáneas para laagentUserId
determinada. Un emisor solo puede emitir una solicitud de sincronización simultánea, a menos que la marcaasync
esté configurada como verdadera.