Package google.assistant.devices.v1alpha2

Índice

Servicio de la plataforma de dispositivos

Este servicio administra dispositivos que no son de Google. Actualmente, ofrece lo siguiente a los desarrolladores: * una API para registrar modelos de dispositivos; * una API para registrar instancias de dispositivos.

El registro del modelo de dispositivo crea y administra un modelo de dispositivo, que contiene las capacidades y configuraciones compartidas en todos los dispositivos de ese modelo.

El registro de la instancia del dispositivo crea una instancia del dispositivo en función de las capacidades y configuraciones definidas en su modelo y también permite que el desarrollador defina algunos atributos que varían entre los dispositivos. Durante el tiempo de ejecución después del registro, se requieren device_model_id y device_id en cada solicitud de gRPC, y la API de Asistente de Google requiere ambos ID. De lo contrario, se mostrará un error.

CreateDevice

rpc CreateDevice(CreateDeviceRequest) returns (Device)

Registrar un dispositivo, devolver el dispositivo si se ejecuta correctamente o mostrar un error si el dispositivo ya existe o falló

Alcances de la autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la Guía de Auth.
CreateDeviceModel

rpc CreateDeviceModel(CreateDeviceModelRequest) returns (DeviceModel)

Crea un modelo de dispositivos de terceros.

Alcances de la autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la Guía de Auth.
Borrar dispositivo

rpc DeleteDevice(DeleteDeviceRequest) returns (Empty)

Borra un dispositivo específico del usuario. Si no se muestra, muestra un valor vacío si no ves el mensaje o indicas que no se borró el dispositivo.

Alcances de la autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la Guía de Auth.
BorrarModeloDeDispositivo

rpc DeleteDeviceModel(DeleteDeviceModelRequest) returns (Empty)

Borra un modelo de dispositivo de terceros.

Alcances de la autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la Guía de Auth.
Obtener dispositivo

rpc GetDevice(GetDeviceRequest) returns (Device)

Obtén información sobre la configuración de un dispositivo específico del usuario, muestra el dispositivo si se ejecuta correctamente o muestra un error si se produce un error.

Alcances de la autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la Guía de Auth.
GetDeviceModel

rpc GetDeviceModel(GetDeviceModelRequest) returns (DeviceModel)

Con un ID de modelo de dispositivo, se muestra un modelo de dispositivo.

Alcances de la autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la Guía de Auth.
ListDeviceModels

rpc ListDeviceModels(ListDeviceModelsRequest) returns (ListDeviceModelsResponse)

Enumera los modelos de dispositivos para el ID del proyecto asociado con esta llamada a la API de REST.

Alcances de la autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la Guía de Auth.
Enumerar dispositivos

rpc ListDevices(ListDevicesRequest) returns (ListDevicesResponse)

Obtiene una lista de los dispositivos que el usuario posee del ID del proyecto especificado en el token de OAuth. Debes verificar que la URL y el token tengan el mismo project_id.

Alcances de la autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la Guía de Auth.
UpdateDeviceModel

rpc UpdateDeviceModel(UpdateDeviceModelRequest) returns (DeviceModel)

Actualiza un modelo de dispositivo y muestra la versión nueva del modelo. Nota: Esta es una actualización completa, lo que significa que debes enviar todo el modelo del dispositivo para su actualización.

Alcances de la autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la Guía de Auth.

Solicitud de creación de modelos

Mensaje de solicitud para DevicesPlatformService.CreateDeviceModel.

Campos
parent

string

Nombre del recurso del proyecto en el que se creará el modelo del dispositivo, con el formato projects/{project_id}.

device_model

DeviceModel

El device_model que se creará.

CreateDeviceRequest

Mensaje de solicitud para DevicesPlatformService.CreateDevice.

Campos
device

Device

La información del dispositivo sin procesar proporcionada por el usuario debe ser única en el proyecto y debe ser asignada por el propietario del proyecto.

parent

string

El nombre del proyecto al que pertenece el dispositivo, en el formato projects/{project_id}

DeleteDeviceModelRequest

Mensaje de solicitud para DevicesPlatformService.DeleteDeviceModel.

Campos
name

string

Nombre del recurso del proyecto en el que se borrará el modelo del dispositivo, con el formato projects/{project_id}/deviceModels/{device_model_id}

DeleteDeviceRequest

Mensaje de solicitud para DevicesPlatformService.DeleteDevice.

Campos
name

string

Es el nombre de recurso del proyecto en el que se borrará el dispositivo, con el formato projects/{project_id}/devices/{device_id}.

Dispositivo

Campos
name

string

Es el nombre de recurso del dispositivo, con el formato projects/{project_id}/devices/{device_id}. El nombre se ignora cuando se crea un dispositivo.

id

string

Obligatorio. Es el ID de dispositivo único en el alcance del proyecto. El desarrollador define el formato, p. ej., “06ba29e5-5f1c-1a89-303c-22de2580f2e2”). Debe coincidir con DeviceConfig.device_id cuando se envía una RPC de Converse. Este ID se puede restablecer para restablecer la configuración de fábrica.

nickname

string

Sobrenombre de este dispositivo especificado por, que se usaría para el reconocimiento de voz y la segmentación por dispositivo cuando el usuario hable con un dispositivo, p.ej., puede decir "mover el robot inteligente a la izquierda" cuando tiene un dispositivo llamado "mi robot inteligente".

model_id

string

Obligatorio. Identifica de forma única la "clase" (modelo) del dispositivo, entre todos los dispositivos del agente-id, p.ej., “manufacturer-2017-v2”. Ten en cuenta que un proyecto puede tener varios modelos de dispositivos diferentes.

client_type

ClientType

Obligatorio. El SDK de Asistente ofrece dos opciones para integrar Asistente en tu dispositivo. Este campo permite identificar si el cliente se basa en la biblioteca del SDK de Asistente o si llama a la API de servicio del SDK.

Tipo de cliente

Identifica el tipo de cliente.

Enumeradores
CLIENT_TYPE_UNSPECIFIED No se conoce el tipo de cliente; es el valor predeterminado.
SDK_SERVICE Para la API del servicio de gRPC del SDK, que expone una API de bajo nivel que manipula directamente los bytes de audio de una solicitud y una respuesta del Asistente. Service
SDK_LIBRARY Para la biblioteca cliente de Asistente de Google, es una solución lista para usar con una API de alto nivel basada en eventos.

Modelodeldispositivo

Define metadatos para una familia de dispositivos. Un modelo de dispositivo también define las capacidades comunes de una familia de dispositivos.

Campos
name

string

Nombre del recurso del modelo de dispositivo, con el formato projects/project-id/deviceModels/device-model-id

device_model_id

string

Obligatorio. ID único global especificado por el desarrollador, como "comcast-voice-assistant-2017-v1". Si ya existe un ID de modelo de dispositivo, se mostrará un error.

project_id

string

Obligatorio. ID del proyecto de Cloud asociado con el modelo del dispositivo. Cada proyecto puede crear varios modelos de dispositivos.

device_type

string

Obligatorio. Algunos 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 que el dispositivo admite. Por ejemplo: “action.devices.traits.OnOff”.

manifest

Manifest

Obligatorio. Metadatos que describen el modelo y el fabricante del dispositivo Esto se mostrará en SDK Console, los paneles de métricas y otras interfaces visuales relacionadas.

execution_modes[]

ExecutionMode

Modo de ejecución opcional para Acciones del dispositivo. Si se establece DIRECT_response, se habilitan los dispositivos para el control de dispositivos.

Modo de ejecución

Modo de ejecución para Acciones del dispositivo (actualmente, solo se admite la respuesta directa)

Enumeradores
MODE_UNSPECIFIED No se especifica.
DIRECT_RESPONSE El dispositivo admite la ejecución directa. Para consultas que provengan del dispositivo, Asistente mostrará DeviceControlRequest, incluidos el comando y los parámetros.

Solicitud de modelo de dispositivo

Mensaje de solicitud para DevicesPlatformService.GetDeviceModel.

Campos
name

string

Nombre del recurso del proyecto en el que se obtendrá un modelo de dispositivo, con el formato projects/{project_id}/deviceModels/{device_model_id}.

GetDeviceRequest

Mensaje de solicitud para DevicesPlatformService.GetDevice.

Campos
name

string

El nombre del recurso para obtener un dispositivo, con el formato projects/{project_id}/devices/{device_id}.

Solicitud de ListDeviceModels

Mensaje de solicitud para DevicesPlatformService.ListDeviceModel.

Campos
parent

string

Se solicita el nombre del recurso de los modelos de dispositivo, en el formato projects/{project_id}.

Respuesta de ListDeviceModels

Mensaje de respuesta para DevicesPlatformService.CreateDeviceModel.

Campos
device_models[]

DeviceModel

ListDevicesRequest

Mensaje de solicitud para DevicesPlatformService.ListDevices.

Campos
parent

string

El nombre del proyecto cuyos dispositivos deseamos enumerar, con el formato “projects/{project_id}”.

ListDevicesResponse

Mensaje de respuesta para DevicesPlatformService.ListDevices.

Campos
devices[]

Device

todos los dispositivos que posee este usuario en un proyecto determinado.

Manifest

Metadatos que describen el modelo y el fabricante del dispositivo Esto se mostrará en SDK Console, los paneles de métricas y otras interfaces visuales relacionadas.

Campos
manufacturer

string

Obligatorio. Es el fabricante de este dispositivo, como "Google".

product_name

string

Obligatorio. Es el nombre del producto orientado al consumidor para este modelo de dispositivo, como "Prototipo de Asistente de Google".

device_description

string

Descripción opcional de este modelo de dispositivo, como "Bocina inteligente de Google, con el Asistente de Google integrado"

UpdateDeviceModelRequest

Mensaje de solicitud para DevicesPlatformService.UpdateDeviceModel.

Campos
name

string

Nombre del recurso del proyecto en el que se debe actualizar el modelo del dispositivo, en el formato projects/{project_id}/deviceModels/{device_model_id}

device_model

DeviceModel

Nuevo desarrollador de modelos de dispositivos al que desea actualizar.