Package google.assistant.devices.v1alpha2

Index

DevicesPlatformService

Dieser Dienst verwaltet Geräte von Drittanbietern. Derzeit bietet sie Entwicklern: * eine API für die Registrierung von Gerätemodellen; * eine API für die Registrierung von Geräteinstanzen.

Bei der Gerätemodellregistrierung wird ein Gerätemodell erstellt und verwaltet, das die Funktionen und Konfigurationen enthält, die von allen Geräten in diesem Modell gemeinsam genutzt werden.

Die Geräteinstanzregistrierung instanziiert eine Geräteinstanz basierend auf den Funktionen und Konfigurationen, die in ihrem Modell definiert sind. Außerdem können Entwickler einige Anforderungen definieren, die je nach Gerät variieren. Während der Ausführungszeit nach der Registrierung sind sowohl „device_model_id“ als auch „device_id“ in jeder gRPC-Anfrage erforderlich. Für die Google Assistant API ist es erforderlich, dass beide IDs bereits registriert sind. Andernfalls wird ein Fehler zurückgegeben.

CreateDevice

rpc CreateDevice(CreateDeviceRequest) returns (Device)

Registrieren Sie ein Gerät und geben Sie das Gerät zurück, wenn der Vorgang erfolgreich war, oder einen Fehler, wenn das Gerät bereits existiert oder fehlgeschlagen ist.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

Weitere Informationen finden Sie im Autorisierungsleitfaden.
CreateDeviceModel

rpc CreateDeviceModel(CreateDeviceModelRequest) returns (DeviceModel)

Erstellen Sie ein Drittanbieter-Gerätemodell.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

Weitere Informationen finden Sie im Autorisierungsleitfaden.
DeleteDevice

rpc DeleteDevice(DeleteDeviceRequest) returns (Empty)

Löscht ein bestimmtes Gerät, das dem Nutzer gehört. Ist der Vorgang erfolgreich, wird „leer“ zurückgegeben. Andernfalls wird ein Fehler ausgegeben, der besagt, dass das Gerät nicht gefunden wurde oder nicht gelöscht werden kann.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

Weitere Informationen finden Sie im Autorisierungsleitfaden.
DeleteDeviceModel

rpc DeleteDeviceModel(DeleteDeviceModelRequest) returns (Empty)

Löschen Sie ein Drittanbieter-Gerätemodell.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

Weitere Informationen finden Sie im Autorisierungsleitfaden.
GetDevice

rpc GetDevice(GetDeviceRequest) returns (Device)

Einstellungsinformationen zu einem bestimmten Gerät abrufen, das dem Nutzer gehört. Bei Erfolg können Sie das Gerät zurückgeben, bei einem Fehler ein Fehler.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

Weitere Informationen finden Sie im Autorisierungsleitfaden.
GetDeviceModel

rpc GetDeviceModel(GetDeviceModelRequest) returns (DeviceModel)

Gibt für die angegebene Gerätemodell-ID ein Gerätemodell zurück.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

Weitere Informationen finden Sie im Autorisierungsleitfaden.
ListDeviceModels

rpc ListDeviceModels(ListDeviceModelsRequest) returns (ListDeviceModelsResponse)

Listet Gerätemodelle für die Projekt-ID auf, die mit diesem REST API-Aufruf verknüpft ist.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

Weitere Informationen finden Sie im Autorisierungsleitfaden.
ListDevices

rpc ListDevices(ListDevicesRequest) returns (ListDevicesResponse)

Liste der Geräte abrufen, die dem Nutzer gehören und zur angegebenen project_id im OAuth-Token gehören. URL und Token müssen geprüft werden, die dieselbe Projekt-ID haben.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

Weitere Informationen finden Sie im Autorisierungsleitfaden.
UpdateDeviceModel

rpc UpdateDeviceModel(UpdateDeviceModelRequest) returns (DeviceModel)

Aktualisiert ein Gerätemodell und gibt die neue Version des Modells zurück Hinweis: Es handelt sich um ein vollständiges Update, d. h. du musst das gesamte Gerätemodell zur Aktualisierung einsenden.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

Weitere Informationen finden Sie im Autorisierungsleitfaden.

CreateDeviceModelRequest

Anfragenachricht für DevicesPlatformService.CreateDeviceModel.

Felder
parent

string

Ressourcenname des Projekts, in dem das Gerätemodell erstellt werden soll, im Format projects/{project_id}

device_model

DeviceModel

Das zu erstellende device_model.

CreateDeviceRequest

Anfragenachricht für DevicesPlatformService.CreateDevice.

Felder
device

Device

Vom Nutzer bereitgestellte, unverarbeitete Geräteinformationen. device_id muss im Projekt eindeutig sein und vom Projektinhaber zugewiesen werden.

parent

string

Der Name des Projekts, zu dem das Gerät gehört, im Format projects/{project_id}

DeleteDeviceModelRequest

Anfragenachricht für DevicesPlatformService.DeleteDeviceModel.

Felder
name

string

Ressourcenname des Projekts, aus dem das Gerätemodell gelöscht werden soll, im Format projects/{project_id}/deviceModels/{device_model_id}

DeleteDeviceRequest

Anfragenachricht für DevicesPlatformService.DeleteDevice.

Felder
name

string

Ressourcenname des Projekts, aus dem das Gerät gelöscht werden soll, im Format projects/{project_id}/devices/{device_id}.

Gerät

Felder
name

string

Ressourcenname des Geräts im Format projects/{project_id}/devices/{device_id}. Der Name wird beim Erstellen eines Geräts ignoriert.

id

string

Erforderlich. Eindeutige Geräte-ID im Projektumfang; das Format wird vom Entwickler definiert, z.B. "06ba29e5-5f1c-1a89-303c-22de2580f2e2". Muss beim Senden eines Converse-RPC mit „DeviceConfig.device_id“ übereinstimmen. Diese ID kann auf die Werkseinstellungen zurückgesetzt werden.

nickname

string

Alias für dieses Gerät, das für die Spracherkennung und Ausrichtung auf Geräte verwendet wird, wenn der Nutzer mit einem Gerät spricht. Beispiel: Der Nutzer kann „Bewege meinen intelligenten Roboter nach links“ sagen, wenn er ein Gerät mit dem Namen „Mein intelligenter Roboter“ hat.

model_id

string

Erforderlich. Identifiziert die Geräteklasse (Modell) unter allen Geräten für die Agent-ID eindeutig, z.B. "manufacturer-2017-v2". Beachten Sie, dass ein Projekt mehrere verschiedene Gerätemodelle haben kann.

client_type

ClientType

Erforderlich. Das Assistant SDK bietet zwei Möglichkeiten, Assistant in Ihr Gerät zu integrieren. Mit diesem Feld wird angegeben, ob der Client auf der Assistant SDK-Bibliothek oder dem Aufruf der SDK Service API basiert.

ClientType

Identifiziert den Clienttyp.

Enums
CLIENT_TYPE_UNSPECIFIED Der Typ des Clients ist nicht bekannt. Standardwert.
SDK_SERVICE Für die SDK gRPC Service API, die eine Low-Level-API zur Verfügung stellt, die die Audiobyte einer Assistant-Anfrage und -Antwort direkt verändert. Service
SDK_LIBRARY Für die Google Assistant-Clientbibliothek, eine sofort einsetzbare Lösung mit einer allgemeinen, ereignisbasierten API.

DeviceModel

Definiert Metadaten für eine Gerätefamilie. Ein Gerätemodell definiert auch allgemeine Funktionen für eine Gerätefamilie.

Felder
name

string

Ressourcenname des Gerätemodells im Format projects/project-id/deviceModels/device-model-id

device_model_id

string

Erforderlich. Eine globale eindeutige ID, die vom Entwickler angegeben wird, z. B. „comcast-voice-assistant-2017-v1“. Wenn bereits eine Gerätemodell-ID vorhanden ist, wird ein Fehler zurückgegeben.

project_id

string

Erforderlich. Cloud-Projekt-ID, die mit dem Gerätemodell verknüpft ist. Für jedes Projekt können mehrere Gerätemodelle erstellt werden.

device_type

string

Erforderlich. Einige gültige Gerätetypen: "action.devices.types.LIGHT" "action.devices.types.OUTLET" "action.devices.types.SWITCH" "action.devices.types.AC_HEATING"

traits[]

string

Optionale Liste der integrierten Merkmale, die das Gerät unterstützen kann. Beispiel: „action.devices.traits.OnOff“

manifest

Manifest

Erforderlich. Metadaten, die das Gerätemodell und den Hersteller beschreiben. Dieser wird in der SDK Console, in Messwert-Dashboards und auf anderen zugehörigen visuellen Oberflächen angezeigt.

execution_modes[]

ExecutionMode

Optionaler Ausführungsmodus für Geräteaktionen. Wenn DIRECT_ANSWER festgelegt ist, sind Geräte für die Gerätesteuerung aktiviert.

ExecutionMode

Ausführungsmodus für Geräteaktionen; derzeit unterstützt nur Direct-Response

Enums
MODE_UNSPECIFIED Nicht angegeben.
DIRECT_RESPONSE Das Gerät unterstützt die direkte Ausführung. Bei Anfragen vom Gerät gibt Assistant DeviceControlRequest zurück, einschließlich des Befehls und der Parameter.

GetDeviceModelRequest

Anfragenachricht für DevicesPlatformService.GetDeviceModel.

Felder
name

string

Ressourcenname des Projekts, in das ein Gerätemodell im Format projects/{project_id}/deviceModels/{device_model_id} abgerufen werden soll

GetDeviceRequest

Anfragenachricht für DevicesPlatformService.GetDevice.

Felder
name

string

Ressourcenname zum Abrufen eines Geräts im Format projects/{project_id}/devices/{device_id}.

ListDeviceModelsRequest

Anfragenachricht für DevicesPlatformService.ListDeviceModel.

Felder
parent

string

Der Ressourcenname der angeforderten Gerätemodelle im Format projects/{project_id}

ListDeviceModelsResponse

Antwortnachricht für DevicesPlatformService.CreateDeviceModel.

Felder
device_models[]

DeviceModel

ListDevicesRequest

Anfragenachricht für DevicesPlatformService.ListDevices

Felder
parent

string

Der Name des Projekts, dessen Geräte wir auflisten möchten, im Format „projects/{project_id}“.

ListDevicesResponse

Antwortnachricht für DevicesPlatformService.ListDevices

Felder
devices[]

Device

Alle Geräte, die diesem Nutzer im jeweiligen Projekt gehören

Manifest

Metadaten, die das Gerätemodell und den Hersteller beschreiben. Dieser wird in der SDK Console, in Messwert-Dashboards und auf anderen zugehörigen visuellen Oberflächen angezeigt.

Felder
manufacturer

string

Erforderlich. Hersteller dieses Geräts, z. B. „Google“

product_name

string

Erforderlich. Für Kunden sichtbarer Produktname für dieses Gerätemodell, z. B. „Google Assistant-Prototypgerät“.

device_description

string

Optionale Beschreibung dieses Gerätemodells, z. B. „Intelligenter Lautsprecher von Google mit integriertem Google Assistant“.

UpdateDeviceModelRequest

Anfragenachricht für DevicesPlatformService.UpdateDeviceModel.

Felder
name

string

Ressourcenname des Projekts, in dem das Gerätemodell aktualisiert werden soll, im Format projects/{project_id}/deviceModels/{device_model_id}

device_model

DeviceModel

Entwickler eines neuen Gerätemodells möchte aktualisieren.