Solicitar sincronização

uma ordem

A sincronização de solicitação aciona uma solicitação SYNC para o fulfillment para qualquer usuário do Google com dispositivos que tenham o agentUserId especificado associado a eles (que você enviou na solicitação SYNC original). Isso permite que você atualize os dispositivos dos usuários sem desvincular e vincular novamente a conta. Todos os usuários vinculados a ele receberão uma solicitação SYNC.

É preciso acionar uma solicitação SYNC:

  • Se o usuário adicionar um novo dispositivo.
  • Se o usuário remover um dispositivo existente,
  • Se o usuário renomeia um dispositivo existente.
  • Se você implementar um novo tipo ou característica de dispositivo ou adicionar um novo recurso de dispositivo.

Começar

Para implementar a sincronização de solicitações, siga estas etapas:

Ativar a API Google HomeGraph

  1. Em Google Cloud Console, acesse a página API HomeGraph.

    Acessar a página da API HomeGraph
  2. Selecione o projeto que corresponde ao ID do projeto smart home.
  3. Clique em ATIVAR.

Criar uma chave de conta de serviço

Siga estas instruções para gerar uma chave de conta de serviço do Google Cloud Console:

Observação: verifique se você está usando o projeto correto do GCP ao realizar essas etapas. Este é o projeto que corresponde ao ID do projeto smart home.

  1. No Google Cloud Console, acesse a página Criar chave da conta de serviço.

    Acessar página "Criar chave da conta de serviço"
  2. Na lista Conta de serviço, selecione Nova conta de serviço.
  3. No campo Nome da conta de serviço, insira um nome.
  4. No campo ID da conta de serviço, digite um ID.

  5. Na lista Papel, selecione Contas de serviço > Criador de token de conta de serviço.

  6. Em Tipo de chave, selecione a opção JSON.

  7. Clique em Criar. O download de um arquivo JSON com a chave é feito no computador.

Chamar a API

HTTP

A API Home Graph fornece um endpoint HTTP

  1. Use o arquivo JSON da conta de serviço salvo para criar um JSON Web Token (JWT). Para mais informações, consulte Como autenticar usando uma conta de serviço.
  2. Consiga um token de acesso do OAuth 2.0 com o escopo https://www.googleapis.com/auth/homegraph usando oauth2l:
    3. oauth2l fetch --credentials service-account.json \
  --scope https://www.googleapis.com/auth/homegraph
  3. Crie a solicitação JSON com o agentUserId. Veja um exemplo de solicitação JSON para a sincronização de solicitações:
    4. {
  "agentUserId": "user-123"
}
  4. Combine o JSON de sincronização de solicitações e o token na solicitação HTTP POST para o endpoint do Google Home Graph. Confira um exemplo de como fazer a solicitação na linha de comando usando curl, como teste:
    5. 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

A API Home Graph oferece um endpoint gRPC (em inglês)

  1. Acesse a definição de serviço de buffers de protocolo para a API Home Graph.
  2. Siga a documentação do desenvolvedor do gRPC para gerar stubs de cliente para um dos idiomas compatíveis.
  3. Chame o método RequestSync.

Node.js

O cliente Node.js das APIs do Google fornece vinculações para a API Home Graph.

  1. Inicialize o serviço google.homegraph usando o Application Default Credentials.
  2. Chame o método requestSync com o RequestSyncDevicesRequest. Ela retorna um Promise com um RequestSyncDevicesResponse vazio.
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

A biblioteca de cliente da API HomeGraph para Java fornece vinculações para a API Home Graph.

  1. Inicialize o HomeGraphApiService usando o Application Default Credentials.
  2. Chame o método requestSync com o RequestSyncDevicesRequest. Ela retorna um ReportStateAndNotificationResponse vazio.
// 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);

Respostas de erro

Você pode receber uma das seguintes respostas de erro ao chamar a sincronização de solicitações. Essas respostas vêm na forma de códigos de status HTTP.

  • 400 Bad Request: o servidor não conseguiu processar a solicitação enviada pelo cliente devido a uma sintaxe inválida. Causas comuns incluem JSON malformado ou uso de null em vez de "" para um valor de string.
  • 403 Forbidden: o servidor não conseguiu processar a solicitação de agentUserId devido a um erro ao atualizar o token. Verifique se o endpoint do OAuth responde corretamente para atualizar as solicitações do token e verificar o status de vinculação da conta do usuário.
  • 404 Not Found: o recurso solicitado não foi encontrado, mas pode estar disponível no futuro. Normalmente, isso significa que a conta de usuário não está vinculada ao Google ou que recebemos um erro agentUserId inválido. Verifique se agentUserId corresponde ao valor fornecido na resposta SYNC e se você está processando as intents DISCONNECT corretamente.
  • 429 Too Many Requests: o número máximo de solicitações de sincronização simultâneas foi excedido para o agentUserId especificado. Um autor da chamada só pode emitir uma solicitação de sincronização simultânea, a menos que a sinalização async esteja definida como verdadeira.
Anterior
Desconectar
Próxima
Implementar estado do relatório