Package google.assistant.devices.v1alpha2

Índice

DevicesPlatformService

Este servicio administra dispositivos que no son de Google. Actualmente ofrece a los desarrolladores: * una API para el registro de modelos de dispositivos; * una API para el registro de instancias de dispositivos.

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

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

CreateDevice

rpc CreateDevice(CreateDeviceRequest) returns (Device)

Registra un dispositivo y devuelve el dispositivo si se produce un error o 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)

Crear 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.
DeleteDevice

rpc DeleteDevice(DeleteDeviceRequest) returns (Empty)

Borra un dispositivo específico que es propiedad del usuario. El valor se muestra vacío si se ejecuta correctamente; de lo contrario, se muestra un error que indica que el dispositivo no se encontró o no se pudo borrar.

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.
DeleteDeviceModel

rpc DeleteDeviceModel(DeleteDeviceModelRequest) returns (Empty)

Borrar 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.
GetDevice

rpc GetDevice(GetDeviceRequest) returns (Device)

Obtén información sobre los parámetros de configuración de un dispositivo específico que pertenece al usuario y devuelve el dispositivo si se completa correctamente o si falla el 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, 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.
ListDevices

rpc ListDevices(ListDevicesRequest) returns (ListDevicesResponse)

Obtén una lista de los dispositivos que pertenecen al usuario y que pertenecen al project_id determinado en el token de OAuth. Es necesario 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 nueva versión 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.

CreateDeviceModelRequest

Mensaje de solicitud para DevicesPlatformService.CreateDeviceModel.

Campos
parent

string

Nombre del recurso del proyecto en el que se creará el modelo de 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

Información sin procesar del dispositivo proporcionada por el usuario. device_id debe ser único en el proyecto, asignado por el propietario del proyecto.

parent

string

El nombre del proyecto al que pertenece el dispositivo, con 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 de dispositivo, con el formato projects/{project_id}/deviceModels/{device_model_id}

DeleteDeviceRequest

Mensaje de solicitud para DevicesPlatformService.DeleteDevice.

Campos
name

string

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

Dispositivo

Campos
name

string

Nombre del recurso del dispositivo, con el formato projects/{project_id}/devices/{device_id}. Se ignorará el nombre cuando se cree un dispositivo.

id

string

Obligatorio. Es un 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 inversa. Este ID se puede restablecer para restablecer la configuración de fábrica.

nickname

string

Es el sobrenombre de este dispositivo especificado por, que se utilizará para el reconocimiento de voz y la segmentación por dispositivo cuando el usuario le habla a un dispositivo (p.ej., "mover mi robot inteligente hacia la izquierda") cuando tiene un dispositivo llamado "mi robot inteligente".

model_id

string

Obligatorio. Identifica de manera única la “clase” (modelo) de dispositivo, entre todos los dispositivos para el ID del agente, 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 integrarlo en tu dispositivo. Este campo sirve para identificar si el cliente se basa en la biblioteca del SDK de Asistente o llama a la API del servicio del SDK.

ClientType

Identifica el tipo de cliente.

Enumeradores
CLIENT_TYPE_UNSPECIFIED No se conoce el tipo de cliente (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 de Asistente. Service
SDK_LIBRARY Para la biblioteca cliente de Asistente de Google, una solución lista para usar con una API de alto nivel basada en eventos.

DeviceModel

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

Campos
name

string

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

device_model_id

string

Obligatorio. Es un 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. El ID del proyecto de la nube asociado con el modelo de dispositivo. Cada proyecto puede crear varios modelos de dispositivos.

device_type

string

Obligatorio. Un tipo de dispositivo válido: "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 puede admitir el dispositivo. Por ejemplo: “action.devices.traits.OnOff”.

manifest

Manifest

Obligatorio. Son los metadatos que describen el modelo y fabricante del dispositivo. 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, los dispositivos se habilitarán para controlarlos.

ExecutionMode

Modo de ejecución para Acciones del dispositivo; actualmente solo admite respuesta directa.

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

GetDeviceModelRequest

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

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

ListDeviceModelsRequest

Mensaje de solicitud para DevicesPlatformService.ListDeviceModel.

Campos
parent

string

Se solicita un nombre de recurso de los modelos de dispositivos en el formato projects/{project_id}.

ListDeviceModelsResponse

Mensaje de respuesta para DevicesPlatformService.CreateDeviceModel.

Campos
device_models[]

DeviceModel

ListDevicesRequest

Mensaje de solicitud para DevicesPlatformService.ListDevices.

Campos
parent

string

Es el nombre del proyecto de los dispositivos que queremos enumerar, en 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

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

Campos
manufacturer

string

Obligatorio. Es el fabricante del dispositivo, como “Google”.

product_name

string

Obligatorio. Es el nombre del producto para este modelo de dispositivo, como "dispositivo prototipo del 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 actualizará el modelo de dispositivo, con el formato projects/{project_id}/deviceModels/{device_model_id}

device_model

DeviceModel

El nuevo desarrollador del modelo de dispositivo quiere actualizar el modelo.