Package google.assistant.devices.v1alpha2

Indice

DevicesPlatformService

Questo servizio gestisce dispositivi non Google. Attualmente fornisce agli sviluppatori: * un'API per la registrazione del modello di dispositivo; * un'API per la registrazione delle istanze del dispositivo.

La registrazione del modello di dispositivo crea e gestisce il modello di dispositivo, che contiene le funzionalità e le configurazioni condivise tra tutti i dispositivi del modello.

La registrazione dell'istanza del dispositivo crea un'istanza di un'istanza del dispositivo in base alle funzionalità e alle configurazioni definite nel modello e consente inoltre allo sviluppatore di definire alcuni attributi che variano a seconda del dispositivo.Durante il tempo di esecuzione successivo alla registrazione, sia device_model_id che device_id sono obbligatori in ogni richiesta gRPC e l'API dell'Assistente Google richiede che entrambi gli ID siano già registrati, altrimenti verrà restituito un errore.

CreateDevice

rpc CreateDevice(CreateDeviceRequest) returns (Device)

Registra un dispositivo e restituiscilo se l'operazione va a buon fine o restituisci il dispositivo se esiste già o si è verificato un errore.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per ulteriori informazioni, consulta la Guida all'autenticazione.
CreateDeviceModel

rpc CreateDeviceModel(CreateDeviceModelRequest) returns (DeviceModel)

Crea un modello di dispositivo di terze parti.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per ulteriori informazioni, consulta la Guida all'autenticazione.
DeleteDevice

rpc DeleteDevice(DeleteDeviceRequest) returns (Empty)

Elimina un dispositivo specifico di proprietà dell'utente. Se l'operazione va a buon fine, restituisci il campo vuoto, altrimenti viene visualizzato un errore che indica che il dispositivo non è stato trovato o non è stato eliminato.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per ulteriori informazioni, consulta la Guida all'autenticazione.
DeleteDeviceModel

rpc DeleteDeviceModel(DeleteDeviceModelRequest) returns (Empty)

Elimina un modello di dispositivo di terze parti.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per ulteriori informazioni, consulta la Guida all'autenticazione.
GetDevice

rpc GetDevice(GetDeviceRequest) returns (Device)

Ottieni le informazioni sulle impostazioni di un utente specifico del dispositivo; restituisci il dispositivo in caso di errore o restituiscilo.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per ulteriori informazioni, consulta la Guida all'autenticazione.
GetDeviceModel

rpc GetDeviceModel(GetDeviceModelRequest) returns (DeviceModel)

Se hai un ID modello di dispositivo, restituisci un modello di dispositivo.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per ulteriori informazioni, consulta la Guida all'autenticazione.
ListDeviceModels

rpc ListDeviceModels(ListDeviceModelsRequest) returns (ListDeviceModelsResponse)

Elenca i modelli di dispositivo per l'ID progetto associato a questa chiamata API REST.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per ulteriori informazioni, consulta la Guida all'autenticazione.
ListDevices

rpc ListDevices(ListDevicesRequest) returns (ListDevicesResponse)

Recupera l'elenco dei dispositivi di proprietà degli utenti appartenenti al project_id specificato nel token OAuth. Devi verificare che l'URL e il token abbiano lo stesso project_id.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per ulteriori informazioni, consulta la Guida all'autenticazione.
UpdateDeviceModel

rpc UpdateDeviceModel(UpdateDeviceModelRequest) returns (DeviceModel)

Aggiorna un modello di dispositivo, restituisce la nuova versione del modello. Nota: si tratta di un aggiornamento completo, il che significa che devi inviare l'intero modello del dispositivo per l'aggiornamento.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per ulteriori informazioni, consulta la Guida all'autenticazione.

CreateDeviceModelRequest

Messaggio di richiesta per DevicesPlatformService.CreateDeviceModel.

Campi
parent

string

Nome della risorsa del progetto in cui creare il modello di dispositivo, nel formato projects/{project_id}

device_model

DeviceModel

Il device_model da creare.

CreateDeviceRequest

Messaggio di richiesta per DevicesPlatformService.CreateDevice.

Campi
device

Device

Informazioni non elaborate sul dispositivo fornite dall'utente. device_id deve essere univoco nel progetto e assegnato dal proprietario del progetto.

parent

string

Il nome del progetto a cui appartiene il dispositivo, nel formato projects/{project_id}

DeleteDeviceModelRequest

Messaggio di richiesta per DevicesPlatformService.DeleteDeviceModel.

Campi
name

string

Nome della risorsa del progetto in cui eliminare il modello di dispositivo, nel formato projects/{project_id}/deviceModels/{device_model_id}

DeleteDeviceRequest

Messaggio di richiesta per DevicesPlatformService.DeleteDevice.

Campi
name

string

Nome della risorsa del progetto in cui eliminare il dispositivo, nel formato projects/{project_id}/devices/{device_id}.

Dispositivo

Campi
name

string

Nome della risorsa del dispositivo nel formato projects/{project_id}/devices/{device_id}. Questo nome viene ignorato durante la creazione di un dispositivo.

id

string

Obbligatorio. ID dispositivo univoco nell'ambito del progetto; il formato è definito dallo sviluppatore, ad esempio "06ba29e5-5f1c-1a89-303c-22de2580f2e2". Deve corrispondere a DeviceConfig.device_id quando si invia una RPC Converse. Questo ID è reimpostabile per il ripristino dei dati di fabbrica.

nickname

string

Nickname per il dispositivo specificato da, che verrà utilizzato per il riconoscimento vocale e il targeting per dispositivo quando l'utente parla a un dispositivo. Ad esempio, l'utente può dire "sposta il mio robot intelligente a sinistra" quando ha un dispositivo denominato "il mio robot smart".

model_id

string

Obbligatorio. Identifica in modo univoco la "classe" (model) del dispositivo tra tutti i dispositivi per l'ID agente, ad esempio "manufacturer-2017-v2". Tieni presente che un progetto potrebbe avere più modelli di dispositivi diversi.

client_type

ClientType

Obbligatorio. L'SDK dell'assistente offre due opzioni per integrare l'assistente nel tuo dispositivo. Questo campo consente di identificare se il client si basa sulla libreria dell'SDK dell'assistente o sulla chiamata all'API del servizio SDK.

ClientType

Identifica il tipo di client.

Enum
CLIENT_TYPE_UNSPECIFIED Il tipo di client non è noto, valore predefinito.
SDK_SERVICE Per l'API del servizio gRPC SDK, che espone un'API di basso livello che manipola direttamente i byte audio di una richiesta e di una risposta dell'assistente. Service
SDK_LIBRARY Per la libreria client dell'Assistente Google, una soluzione pronta all'uso con un'API di alto livello basata su eventi.

DeviceModel

Definisce i metadati per una famiglia di dispositivi. Un modello di dispositivo definisce anche le funzionalità comuni per una famiglia di dispositivi.

Campi
name

string

Nome risorsa del modello di dispositivo nel formato projects/project-id/deviceModels/device-model-id

device_model_id

string

Obbligatorio. ID univoco globale specificato dallo sviluppatore, ad esempio "comcast-voice-assistant-2017-v1". Se esiste già un ID modello del dispositivo, verrà restituito un errore.

project_id

string

Obbligatorio. ID progetto cloud associato al modello di dispositivo. Ogni progetto può creare più modelli di dispositivi.

device_type

string

Obbligatorio. Alcuni tipi di dispositivo validi: "action.devices.types.Light" "action.devices.types.OUTLET" "action.devices.types.SWITCH" "action.devices.types.AC_HEATING"

traits[]

string

Elenco facoltativo di trait integrati che il dispositivo può supportare. Ad esempio: "action.devices.traits.OnOff"

manifest

Manifest

Obbligatorio. I metadati che descrivono il modello e il produttore del dispositivo. Questa informazione verrà mostrata nella console SDK, nelle dashboard delle metriche e in altre interfacce visive correlate.

execution_modes[]

ExecutionMode

Modalità di esecuzione facoltativa per le azioni sul dispositivo. Se è impostata l'opzione DIRECT_ANSWER, i dispositivi sono abilitati per il controllo dei dispositivi.

ExecutionMode

Modalità di esecuzione per Azioni dispositivo; attualmente supporta solo la risposta diretta.

Enum
MODE_UNSPECIFIED Non specificato.
DIRECT_RESPONSE Il dispositivo supporta l'esecuzione diretta. Per le query provenienti dal dispositivo, l'assistente restituirà DeviceControlRequest con il comando e i parametri.

GetDeviceModelRequest

Messaggio di richiesta per DevicesPlatformService.GetDeviceModel.

Campi
name

string

Nome della risorsa del progetto in cui ottenere un modello di dispositivo, nel formato projects/{project_id}/deviceModels/{device_model_id}

GetDeviceRequest

Messaggio di richiesta per DevicesPlatformService.GetDevice.

Campi
name

string

Nome della risorsa per ottenere un dispositivo, nel formato projects/{project_id}/devices/{device_id}.

ListDeviceModelsRequest

Messaggio di richiesta per DevicesPlatformService.ListDeviceModel.

Campi
parent

string

È in corso la richiesta del nome della risorsa dei modelli di dispositivi nel formato projects/{project_id}

ListDeviceModelsResponse

Messaggio di risposta per DevicesPlatformService.CreateDeviceModel.

Campi
device_models[]

DeviceModel

ListDevicesRequest

Messaggio di richiesta per DevicesPlatformService.ListDevices.

Campi
parent

string

Il nome del progetto di cui vogliamo elencare i dispositivi nel formato "projects/{project_id}".

ListDevicesResponse

Messaggio di risposta per DevicesPlatformService.ListDevices.

Campi
devices[]

Device

tutti i dispositivi di proprietà dell'utente in un determinato progetto.

Manifest

I metadati che descrivono il modello e il produttore del dispositivo. Questa informazione verrà mostrata nella console SDK, nelle dashboard delle metriche e in altre interfacce visive correlate.

Campi
manufacturer

string

Obbligatorio. Produttore di questo dispositivo, ad esempio "Google".

product_name

string

Obbligatorio. Nome del prodotto rivolto ai consumatori per questo modello di dispositivo, ad esempio "prototipo dispositivo con l'Assistente Google".

device_description

string

Descrizione facoltativa di questo modello di dispositivo, ad esempio "Smart speaker di Google con l'Assistente Google integrato".

UpdateDeviceModelRequest

Messaggio di richiesta per DevicesPlatformService.UpdateDeviceModel.

Campi
name

string

Nome della risorsa del progetto in cui aggiornare il modello di dispositivo, nel formato projects/{project_id}/deviceModels/{device_model_id}

device_model

DeviceModel

Il nuovo modello di dispositivo a cui lo sviluppatore vuole eseguire l'aggiornamento.