La sincronización de solicitudes activa una solicitud SYNC
a tu entrega para cualquier usuario de Google que tenga dispositivos que tengan el agentUserId
especificado asociado (que enviaste en la solicitud original de SYNC). Esto te permite actualizar los dispositivos de los usuarios sin desvincular y volver a vincular sus cuentas. 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 o característica, o agregas una nueva función de dispositivo.
Comenzar
Para implementar Solicitar sincronización, sigue estos pasos:
Cómo habilitar la API de Google HomeGraph
-
En Google Cloud Console, ve a la página API de HomeGraph.
Ir a la página de la API de HomeGraph - Selecciona el proyecto que coincida con tu ID del proyecto de smart home.
- Haz clic en HABILITAR.
Crea una clave de cuenta de servicio
Sigue estas instrucciones para generar una clave de cuenta de servicio desde Google Cloud Console:
-
En Google Cloud Console, ve a la página Crear clave de cuenta de servicio.
Ir a la página Crear clave de la cuenta de servicio - En la lista Cuenta de servicio, selecciona Nueva cuenta de servicio.
- Escribe un nombre en el campo Nombre de cuenta de servicio.
- En el campo ID de la cuenta de servicio, ingresa un ID.
En la lista Función, selecciona Cuentas de servicio > Creador de tokens para 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.
Llama a la API
HTTP
La API de Home Graph proporciona un extremo HTTP
- Usa el archivo JSON de la cuenta de servicio que descargaste para crear un token web JSON (JWT). Para obtener más información, consulta Autenticación con 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
. Este es un ejemplo de solicitud JSON para solicitar la sincronización: - Combina el JSON de solicitud de sincronización y el token de tu solicitud HTTP POST al extremo de Google Home Graph. A continuación, se muestra un ejemplo de cómo realizar la solicitud en la línea de comandos con
curl
como 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 de gRPC
- Obtén la definición del servicio de búferes de protocolo para la API de Home Graph.
- Sigue la documentación para desarrolladores de gRPC con el objetivo de generar stubs de cliente para uno de los lenguajes compatibles.
- Llama al método RequestSync.
Node.js
El cliente de Node.js de las APIs 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. Se 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 vinculaciones para la API de Home Graph.
- Inicializa
HomeGraphApiService
con las credenciales predeterminadas de la aplicación. - Llama al método
requestSync
conRequestSyncDevicesRequest
. Se mostrará 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
Cuando llames a Solicitar sincronización, es posible que recibas una de las siguientes respuestas de error. Estas respuestas se presentan en forma de códigos de estado HTTP.
400 Bad Request
: el servidor no pudo procesar la solicitud que envió el cliente debido a una sintaxis no válida. Entre las causas comunes, se incluyen el formato JSON con formato incorrecto o el uso denull
en lugar de “” para un valor de cadena.403 Forbidden
: El servidor no pudo procesar la solicitud delagentUserId
determinado debido a un error durante la actualización del token. Asegúrate de que el extremo de OAuth responda correctamente a las solicitudes de tokens de actualización y verifica el estado de vinculación de la cuenta del usuario.404 Not Found
: no se pudo encontrar el recurso solicitado, pero es posible que esté 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 que estás manejando correctamente los intents DISCONNECT.429 Too Many Requests
: Se superó la cantidad máxima de solicitudes de sincronización simultáneas para elagentUserId
determinado. Un emisor solo puede emitir una solicitud de sincronización simultánea, a menos que la marcaasync
esté configurada como verdadera.