Package google.assistant.devices.v1alpha2

Índice

DevicesPlatformService

Este serviço gerencia dispositivos que não são do Google. Atualmente, fornece 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 em todos os dispositivos do modelo em questão.

O registro de instância de dispositivo instancia uma instância de dispositivo com base nos recursos e 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, device_model_id e device_id são obrigatórios em cada solicitação gRPC. A API Google Assistant exige que os dois IDs já estejam registrados. Caso contrário, um erro será retornado.

CreateDevice

rpc CreateDevice(CreateDeviceRequest) returns (Device)

Registre um dispositivo e devolva-o em caso de êxito ou erro se o dispositivo já existir ou tiver falhado.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/assistant-sdk-prototype

Para mais informações, consulte o Guia de autenticação.
CreateDeviceModel

rpc CreateDeviceModel(CreateDeviceModelRequest) returns (DeviceModel)

Crie um modelo de dispositivo de terceiros.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/assistant-sdk-prototype

Para mais informações, consulte o Guia de autenticação.
DeleteDevice

rpc DeleteDevice(DeleteDeviceRequest) returns (Empty)

Exclui um dispositivo específico do usuário. Retornará vazio se for bem-sucedido. Caso contrário, um erro informando que o dispositivo não foi encontrado ou falha ao excluir.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/assistant-sdk-prototype

Para mais informações, consulte o Guia de autenticação.
DeleteDeviceModel

rpc DeleteDeviceModel(DeleteDeviceModelRequest) returns (Empty)

Exclui um modelo de dispositivo de terceiros.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/assistant-sdk-prototype

Para mais informações, consulte o Guia de autenticação.
GetDevice

rpc GetDevice(GetDeviceRequest) returns (Device)

Receba informações de configuração de um dispositivo específico do usuário. Devolva o dispositivo em caso de êxito ou erro em caso de falha.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/assistant-sdk-prototype

Para mais informações, consulte o Guia de autenticação.
GetDeviceModel

rpc GetDeviceModel(GetDeviceModelRequest) returns (DeviceModel)

Com um ID de modelo de dispositivo, retorna um modelo de dispositivo.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/assistant-sdk-prototype

Para mais informações, consulte o Guia de autenticação.
ListDeviceModels

rpc ListDeviceModels(ListDeviceModelsRequest) returns (ListDeviceModelsResponse)

Liste os modelos de dispositivo para o ID do projeto associado a esta chamada da API REST.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/assistant-sdk-prototype

Para mais informações, consulte o Guia de autenticação.
ListDevices

rpc ListDevices(ListDevicesRequest) returns (ListDevicesResponse)

Obtenha a lista de dispositivos que o usuário pertence ao project_id especificado no token OAuth. É preciso verificar se o URL e o token têm o mesmo project_id.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/assistant-sdk-prototype

Para mais informações, consulte o Guia de autenticação.
UpdateDeviceModel

rpc UpdateDeviceModel(UpdateDeviceModelRequest) returns (DeviceModel)

Atualiza um modelo de dispositivo e retorna a nova versão do modelo. Observação: esta é uma atualização completa, o que significa que você precisa enviar todo o modelo do dispositivo para atualização.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/assistant-sdk-prototype

Para mais informações, consulte o Guia de autenticação.

CreateDeviceModelRequest

Mensagem de solicitação para DevicesPlatformService.CreateDeviceModel.

Campos
parent

string

Nome do recurso do projeto em que o modelo de dispositivo será criado, no formato projects/{project_id}.

device_model

DeviceModel

O device_model a ser criado.

CreateDeviceRequest

Mensagem de solicitação para DevicesPlatformService.CreateDevice.

Campos
device

Device

Informações brutas do dispositivo fornecidas pelo usuário. O device_id precisa ser exclusivo no projeto e atribuído pelo proprietário.

parent

string

O nome do projeto ao qual o dispositivo pertence, no formato projects/{project_id}

DeleteDeviceModelRequest

Mensagem de solicitação para DevicesPlatformService.DeleteDeviceModel.

Campos
name

string

Nome do recurso do projeto em que o modelo de dispositivo será excluído, no formato projects/{project_id}/deviceModels/{device_model_id}

DeleteDeviceRequest

Mensagem de solicitação para DevicesPlatformService.DeleteDevice.

Campos
name

string

Nome do recurso do projeto em que o dispositivo será excluído, no formato projects/{project_id}/devices/{device_id}.

Dispositivo

Campos
name

string

Nome do recurso do dispositivo, no formato projects/{project_id}/devices/{device_id}. O nome é ignorado ao criar um dispositivo.

id

string

Obrigatório. ID 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 da Converse. Esse ID pode ser redefinido para FDR.

nickname

string

O apelido do dispositivo especificado por, que seria usado para reconhecimento de fala e segmentação por dispositivo quando o usuário fala com um dispositivo. Por exemplo, o usuário pode dizer "mover meu robô inteligente para a esquerda" quando ela tem um dispositivo chamado "meu robô inteligente".

model_id

string

Obrigatório. Identifica exclusivamente a "classe" (modelo) do dispositivo, entre todos os dispositivos para o agent-id, por exemplo, "manufacturer-2017-v2". Um projeto pode ter vários modelos de dispositivo diferentes.

client_type

ClientType

Obrigatório. O SDK do Google Assistente oferece duas opções para integrá-lo ao dispositivo. Esse campo serve para identificar se o cliente está baseado na biblioteca do SDK do Assistente ou na chamada da API de serviço do SDK.

ClientType

Identifica o tipo de cliente.

Enums
CLIENT_TYPE_UNSPECIFIED O tipo do cliente não é conhecido, o valor padrão.
SDK_SERVICE Para a API do serviço gRPC do SDK, que expõe uma API de baixo nível que manipula diretamente os bytes de áudio de uma solicitação e uma 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.

DeviceModel

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

string

Nome do recurso do modelo do dispositivo, no formato projects/project-id/deviceModels/device-model-id

device_model_id

string

Obrigatório. ID exclusivo global especificado pelo desenvolvedor, como "comcast-voice-assistant-2017-v1". Se já houver um ID de modelo de dispositivo, um erro será retornado.

project_id

string

Obrigatório. ID do projeto do Cloud associado ao modelo do dispositivo. Cada projeto pode criar vários modelos de dispositivo.

device_type

string

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[]

string

Lista opcional de características integradas compatíveis com o dispositivo. Por exemplo: "action.devices.traits.OnOff"

manifest

Manifest

Obrigatório. Metadados que descrevem o modelo e o fabricante do dispositivo. Ele vai aparecer no console do SDK, nos painéis de métricas e em outras interfaces visuais relacionadas.

execution_modes[]

ExecutionMode

Modo de execução opcional para ações do dispositivo. Se DIRECT_RESPONSE estiver definido, o controle de dispositivos será ativado nos dispositivos.

ExecutionMode

Modo de execução para ações no dispositivo. No momento, ele oferece suporte apenas a respostas diretas.

Enums
MODE_UNSPECIFIED Não especificado.
DIRECT_RESPONSE O dispositivo oferece suporte à 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

string

Nome do recurso do projeto em que um modelo de dispositivo será recebido, no formato projects/{project_id}/deviceModels/{device_model_id}

GetDeviceRequest

Mensagem de solicitação para DevicesPlatformService.GetDevice.

Campos
name

string

Nome do recurso para receber um dispositivo, no formato projects/{project_id}/devices/{device_id}.

ListDeviceModelsRequest

Mensagem de solicitação para DevicesPlatformService.ListDeviceModel.

Campos
parent

string

O nome de recurso dos modelos de dispositivo está sendo solicitado, no formato projects/{project_id}

ListDeviceModelsResponse

Mensagem de resposta para DevicesPlatformService.CreateDeviceModel.

Campos
device_models[]

DeviceModel

ListDevicesRequest

Mensagem de solicitação para DevicesPlatformService.ListDevices.

Campos
parent

string

O nome do projeto cujos dispositivos gostaríamos de listar, no formato `projects/{project_id}'.

ListDevicesResponse

Mensagem de resposta para DevicesPlatformService.ListDevices.

Campos
devices[]

Device

todos os dispositivos deste usuário em determinado projeto.

Manifesto

Metadados que descrevem o modelo e o fabricante do dispositivo. Ele vai aparecer no console do SDK, nos painéis de métricas e em outras interfaces visuais relacionadas.

Campos
manufacturer

string

Obrigatório. Fabricante do dispositivo, como "Google".

product_name

string

Obrigatório. Nome do produto voltado ao consumidor para este modelo de dispositivo, como "Protótipo do Google Assistente".

device_description

string

Descrição opcional desse modelo de dispositivo, como "Alto-falante inteligente do Google com Google Assistente integrado".

UpdateDeviceModelRequest

Mensagem de solicitação para DevicesPlatformService.UpdateDeviceModel.

Campos
name

string

Nome do recurso do projeto em que o modelo de dispositivo será atualizado, no formato projects/{project_id}/deviceModels/{device_model_id}

device_model

DeviceModel

O desenvolvedor do novo modelo de dispositivo quer atualizar.