Índice
DevicesPlatformService
(interface)CreateDeviceModelRequest
(mensagem)CreateDeviceRequest
(mensagem)DeleteDeviceModelRequest
(mensagem)DeleteDeviceRequest
(mensagem)Device
(mensagem)Device.ClientType
(enum)DeviceModel
(mensagem)DeviceModel.ExecutionMode
(enum)GetDeviceModelRequest
(mensagem)GetDeviceRequest
(mensagem)ListDeviceModelsRequest
(mensagem)ListDeviceModelsResponse
(mensagem)ListDevicesRequest
(mensagem)ListDevicesResponse
(mensagem)Manifest
(mensagem)UpdateDeviceModelRequest
(mensagem)
Serviço de plataforma de dispositivos
Este serviço gerencia dispositivos que não são do Google. Atualmente, ela oferece aos desenvolvedores: * uma API para registro de modelo de dispositivo; * uma API para registro de instância de dispositivo.
O registro do modelo de dispositivo cria e gerencia o modelo, que contém os recursos e as configurações compartilhados por todos os dispositivos nesse modelo.
O registro da instância de dispositivo instancia uma instância de dispositivo com base nos recursos e nas configurações definidos no modelo e também permite que o desenvolvedor defina alguns atributos que variam entre os dispositivos. Durante o tempo de execução após o registro, tanto o device_model_id quanto o device_id são necessários em cada solicitação gRPC, e a Google Assistente API requer que ambos os códigos já estejam registrados. Caso contrário, um erro será retornado.
Criar dispositivo | |
---|---|
Registre um dispositivo e devolva-o em caso de sucesso ou erro.
|
CriarModeloModelo | |
---|---|
Crie um modelo de dispositivo de terceiros.
|
Excluir dispositivo | |
---|---|
Exclui um dispositivo específico do usuário. Retornará vazio se for bem-sucedido. Caso contrário, será um erro informando que o dispositivo não foi encontrado ou não conseguiu excluir.
|
Excluir modelododispositivo | |
---|---|
Excluir um modelo de dispositivo de terceiros.
|
GetDevice | |
---|---|
Receber informações de configuração de um dispositivo específico do usuário, devolvê-lo em caso de êxito ou erro em caso de falha.
|
GetDeviceModel | |
---|---|
Dado um código de modelo de dispositivo, retorna um modelo de dispositivo.
|
ListarDispositivosModelo | |
---|---|
Lista modelos de dispositivo para o ID do projeto associado a esta chamada da API REST.
|
Listar dispositivos | |
---|---|
Obtém a lista de dispositivos de propriedade do usuário do project_id fornecido no token OAuth. O URL e o token precisam ter o mesmo project_id.
|
Atualizar modelo do dispositivo | |
---|---|
Atualiza um modelo de dispositivo, retorna a nova versão do modelo. Observação: esta é uma atualização completa, o que significa que você precisa enviar todo o modelo de dispositivo para atualização.
|
CreateDeviceModelRequest
Mensagem de solicitação para DevicesPlatformService.CreateDeviceModel.
Campos | |
---|---|
parent |
Nome do recurso do projeto em que o modelo de dispositivo será criado, no formato |
device_model |
O device_model a ser criado. |
CreateDeviceRequest
Mensagem de solicitação para DevicesPlatformService.CreateDevice.
Campos | |
---|---|
device |
Informações brutas do dispositivo fornecidas pelo usuário. O atributo device_id deve ser exclusivo no projeto e atribuído pelo proprietário. |
parent |
O nome do projeto a que o dispositivo pertence, no formato |
Excluir ModeloModeloSolicitação
Mensagem de solicitação para DevicesPlatformService.DeleteDeviceModel.
Campos | |
---|---|
name |
Nome do recurso do projeto em que o modelo de dispositivo será excluído, no formato |
DeleteDeviceRequest
Mensagem de solicitação para DevicesPlatformService.DeleteDevice.
Campos | |
---|---|
name |
Nome do recurso do projeto em que o dispositivo será excluído, no formato |
Dispositivo
Campos | |
---|---|
name |
Nome do recurso do dispositivo, no formato |
id |
Obrigatório. Código do dispositivo exclusivo no escopo do projeto. O formato é definido pelo desenvolvedor, por exemplo, "06ba29e5-5f1c-1a89-303c-22de2580f2e2". Precisa corresponder a DeviceConfig.device_id ao enviar uma RPC Converse. Este código pode ser redefinido para FDR. |
nickname |
Apelido do dispositivo especificado por , que será usado para reconhecimento de fala e segmentação de dispositivo quando o usuário falar com um dispositivo. Por exemplo, o usuário pode dizer "mover meu robô inteligente para a esquerda" quando tiver um dispositivo chamado "meu robô inteligente". |
model_id |
Obrigatório. Identifica de forma exclusiva a "classe" do dispositivo (modelo), entre todos os dispositivos para o ID do agente, por exemplo, "manufacturer-2017-v2". Um projeto pode ter vários modelos de dispositivos diferentes. |
client_type |
Obrigatório. O SDK do Assistente oferece duas opções para integrar o Assistente ao seu dispositivo. Esse campo serve para identificar se o cliente é baseado na biblioteca do SDK do Assistente ou chamar a API de serviço do SDK. |
Tipo de cliente
Identifica o tipo de cliente.
Enums | |
---|---|
CLIENT_TYPE_UNSPECIFIED |
O tipo de cliente não é conhecido, o valor padrão. |
SDK_SERVICE |
Para a API de serviço do SDK gRPC, que expõe uma API de baixo nível que manipula diretamente os bytes de áudio de uma solicitação e resposta do Assistente. Service |
SDK_LIBRARY |
Para a biblioteca de cliente do Google Assistente, uma solução pronta para uso com uma API de alto nível baseada em eventos. |
Modelo do dispositivo
Define metadados para uma família de dispositivos. Um modelo de dispositivo também define recursos comuns para uma família de dispositivos.
Campos | |
---|---|
name |
Nome do recurso do modelo do dispositivo, no formato |
device_model_id |
Obrigatório. Código exclusivo global especificado pelo desenvolvedor, como "comcast-voice-assistant-2017-v1". Se já houver um código de modelo de dispositivo, um erro será retornado. |
project_id |
Obrigatório. ID do projeto do Cloud associado ao modelo do dispositivo. Cada projeto pode criar vários modelos de dispositivos. |
device_type |
Obrigatório. Alguns tipos de dispositivos válidos: "action.devices.types.LIGHT" "action.devices.types.OUTLET" "action.devices.types.SWITCH" "action.devices.types.AC_HEATING" |
traits[] |
Lista opcional de características integradas compatíveis com o dispositivo. Por exemplo: "action.devices.traits.OnOff" |
manifest |
Obrigatório. Metadados que descrevem o modelo e o fabricante do dispositivo. Essa informação será mostrada no SDK Console, nos painéis de métricas e em outras interfaces visuais relacionadas. |
execution_modes[] |
Modo de execução opcional para Ações do dispositivo. Se DIRECT_RESPONSE estiver definido, os dispositivos serão ativados para controle de dispositivos. |
Modo de execução
Modo de execução para Ações do dispositivo, no momento só é compatível com resposta direta.
Enums | |
---|---|
MODE_UNSPECIFIED |
Não especificado. |
DIRECT_RESPONSE |
O dispositivo é compatível com execução direta. Para consultas provenientes do dispositivo, o assistente retornará DeviceControlRequest, incluindo o comando e os parâmetros. |
GetDeviceModelRequest
Mensagem de solicitação para DevicesPlatformService.GetDeviceModel.
Campos | |
---|---|
name |
Nome do recurso do projeto em que um modelo de dispositivo será recebido, no formato |
GetDeviceRequest
Mensagem de solicitação para DevicesPlatformService.GetDevice.
Campos | |
---|---|
name |
Nome do recurso para receber um dispositivo, no formato |
ListDeviceModelsRequest
Mensagem de solicitação para DevicesPlatformService.ListDeviceModel.
Campos | |
---|---|
parent |
O nome do recurso dos modelos de dispositivo está sendo solicitado, no formato |
ListDeviceModelsResponse
Mensagem de resposta para DevicesPlatformService.CreateDeviceModel.
Campos | |
---|---|
device_models[] |
|
ListDevicesRequest
Mensagem de solicitação para DevicesPlatformService.ListDevices.
Campos | |
---|---|
parent |
O nome do projeto cujos dispositivos você quer listar, no formato "projects/{project_id}". |
ListDevicesResponse
Mensagem de resposta para DevicesPlatformService.ListDevices.
Campos | |
---|---|
devices[] |
todos os dispositivos deste usuário no projeto. |
Manifesto
Metadados que descrevem o modelo e o fabricante do dispositivo. Essa informação será mostrada no SDK Console, nos painéis de métricas e em outras interfaces visuais relacionadas.
Campos | |
---|---|
manufacturer |
Obrigatório. Fabricante deste dispositivo, como "Google". |
product_name |
Obrigatório. Nome do produto voltado ao consumidor para este modelo de dispositivo, como "protótipo de protótipo do Google Assistente". |
device_description |
Descrição opcional desse modelo de dispositivo, como "Alto-falante inteligente do Google com Google Assistente integrado". |
Atualização de ModelDeviceRequest
Mensagem de solicitação para DevicesPlatformService.UpdateDeviceModel.
Campos | |
---|---|
name |
Nome do recurso do projeto em que o modelo de dispositivo será atualizado, no formato |
device_model |
O novo desenvolvedor de modelo de dispositivo quer atualizar. |