Solicitar sincronización

La sincronización de solicitudes activa una solicitud SYNC a tu entrega para cualquier usuario de Google con dispositivos que tengan asociado el agentUserId especificado (que enviaste en la solicitud SYNC original). 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 trait, o agregas una nueva función.

Comenzar

Para implementar la sincronización de solicitudes, sigue estos pasos:

Cómo habilitar la API de Google HomeGraph

  1. En Google Cloud Console, ve a la página de la API de HomeGraph.

    Ir a la página de la API de HomeGraph
  2. Selecciona el proyecto que coincida con el ID del proyecto smart home.
  3. Haz clic en HABILITAR.

Crea una clave de cuenta de servicio

Sigue estas instrucciones para generar una clave de cuenta de servicio a partir de Google Cloud Console:

Nota: Asegúrate de usar el proyecto de GCP correcto cuando sigas estos pasos. Este es el proyecto que coincide con el ID del proyecto smart home.
  1. En Google Cloud Console, ve a la página Crea una clave de cuenta de servicio.

    Ir a la página Crear clave de la cuenta de servicio
  2. En la lista Cuenta de servicio, selecciona Nueva cuenta de servicio.
  3. Ingresa un nombre en el campo Nombre de cuenta de servicio.
  4. En el campo ID de cuenta de servicio, ingresa un ID.
  5. En la lista Función, selecciona Cuentas de servicio > Creador de tokens de cuenta de servicio.

  6. En Tipo de clave, selecciona la opción JSON.

  7. Haz clic en Crear. Se descargará en tu computadora un archivo JSON con la clave.

Llama a la API

HTTP

La API de Home Graph proporciona un extremo HTTP

  1. 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 Cómo autenticar con una cuenta de servicio.
  2. Obtén un token de acceso de OAuth 2.0 con el alcance https://www.googleapis.com/auth/homegraph mediante oauth2l:
  3. oauth2l fetch --credentials service-account.json \
      --scope https://www.googleapis.com/auth/homegraph
    
  4. Crea la solicitud JSON con el agentUserId. A continuación, se incluye un ejemplo de solicitud JSON para solicitar la sincronización:
  5. {
      "agentUserId": "user-123"
    }
    
  6. Combina el JSON de la solicitud de sincronización y el token en tu solicitud HTTP POST al extremo de Google Home Graph. Este es un ejemplo de cómo realizar la solicitud en la línea de comandos usando curl como prueba:
  7. 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

  1. Obtén la definición del servicio de búferes de protocolo para la API de Home Graph.
  2. Sigue la documentación para desarrolladores de gRPC a fin de generar stubs de cliente para uno de los lenguajes compatibles.
  3. 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.

  1. Inicializa el servicio google.homegraph con las credenciales predeterminadas de la aplicación.
  2. Llama al método requestSync con RequestSyncDevicesRequest. Muestra una Promise 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 a la API de Home Graph.

  1. Inicializa HomeGraphApiService con las credenciales predeterminadas de la aplicación.
  2. Llama al método requestSync con RequestSyncDevicesRequest. Se mostrará un ReportStateAndNotificationResponse 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 la sincronización de solicitudes. Estas respuestas vienen 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 JSON con errores de formato o usar null en lugar de “” para un valor de string.
  • 403 Forbidden: El servidor no pudo procesar la solicitud de agentUserId determinado debido a un error mientras se actualizaba el token. Asegúrate de que tu extremo de OAuth responda de forma correcta a las solicitudes de token 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 puede estar disponible en el futuro. Por lo general, esto significa que la cuenta de usuario no está vinculada a Google o que recibimos un agentUserId no válido. Asegúrate de que el agentUserId coincida con el valor proporcionado en tu respuesta SYNC y de que controlas correctamente los intents DISCONNECT.
  • 429 Too Many Requests: Se superó la cantidad máxima de solicitudes de sincronización simultáneas para la agentUserId determinada. Un llamador solo puede emitir una solicitud de sincronización simultánea, a menos que la marca async esté configurada como verdadera.