Index
DevicesPlatformService
(Benutzeroberfläche)CreateDeviceModelRequest
(Meldung)CreateDeviceRequest
(Meldung)DeleteDeviceModelRequest
(Meldung)DeleteDeviceRequest
(Meldung)Device
(Meldung)Device.ClientType
(Aufzählung)DeviceModel
(Meldung)DeviceModel.ExecutionMode
(Aufzählung)GetDeviceModelRequest
(Meldung)GetDeviceRequest
(Meldung)ListDeviceModelsRequest
(Meldung)ListDeviceModelsResponse
(Meldung)ListDevicesRequest
(Meldung)ListDevicesResponse
(Meldung)Manifest
(Meldung)UpdateDeviceModelRequest
(Meldung)
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 | |
---|---|
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.
|
CreateDeviceModel | |
---|---|
Erstellen Sie ein Drittanbieter-Gerätemodell.
|
DeleteDevice | |
---|---|
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.
|
DeleteDeviceModel | |
---|---|
Löschen Sie ein Drittanbieter-Gerätemodell.
|
GetDevice | |
---|---|
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.
|
GetDeviceModel | |
---|---|
Gibt für die angegebene Gerätemodell-ID ein Gerätemodell zurück.
|
ListDeviceModels | |
---|---|
Listet Gerätemodelle für die Projekt-ID auf, die mit diesem REST API-Aufruf verknüpft ist.
|
ListDevices | |
---|---|
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.
|
UpdateDeviceModel | |
---|---|
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.
|
CreateDeviceModelRequest
Anfragenachricht für DevicesPlatformService.CreateDeviceModel.
Felder | |
---|---|
parent |
Ressourcenname des Projekts, in dem das Gerätemodell erstellt werden soll, im Format |
device_model |
Das zu erstellende device_model. |
CreateDeviceRequest
Anfragenachricht für DevicesPlatformService.CreateDevice.
Felder | |
---|---|
device |
Vom Nutzer bereitgestellte, unverarbeitete Geräteinformationen. device_id muss im Projekt eindeutig sein und vom Projektinhaber zugewiesen werden. |
parent |
Der Name des Projekts, zu dem das Gerät gehört, im Format |
DeleteDeviceModelRequest
Anfragenachricht für DevicesPlatformService.DeleteDeviceModel.
Felder | |
---|---|
name |
Ressourcenname des Projekts, aus dem das Gerätemodell gelöscht werden soll, im Format |
DeleteDeviceRequest
Anfragenachricht für DevicesPlatformService.DeleteDevice.
Felder | |
---|---|
name |
Ressourcenname des Projekts, aus dem das Gerät gelöscht werden soll, im Format |
Gerät
Felder | |
---|---|
name |
Ressourcenname des Geräts im Format |
id |
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 |
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 |
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 |
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 |
Ressourcenname des Gerätemodells im Format |
device_model_id |
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 |
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 |
Erforderlich. Einige gültige Gerätetypen: "action.devices.types.LIGHT" "action.devices.types.OUTLET" "action.devices.types.SWITCH" "action.devices.types.AC_HEATING" |
traits[] |
Optionale Liste der integrierten Merkmale, die das Gerät unterstützen kann. Beispiel: „action.devices.traits.OnOff“ |
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[] |
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 |
Ressourcenname des Projekts, in das ein Gerätemodell im Format |
GetDeviceRequest
Anfragenachricht für DevicesPlatformService.GetDevice.
Felder | |
---|---|
name |
Ressourcenname zum Abrufen eines Geräts im Format |
ListDeviceModelsRequest
Anfragenachricht für DevicesPlatformService.ListDeviceModel.
Felder | |
---|---|
parent |
Der Ressourcenname der angeforderten Gerätemodelle im Format |
ListDeviceModelsResponse
Antwortnachricht für DevicesPlatformService.CreateDeviceModel.
Felder | |
---|---|
device_models[] |
|
ListDevicesRequest
Anfragenachricht für DevicesPlatformService.ListDevices
Felder | |
---|---|
parent |
Der Name des Projekts, dessen Geräte wir auflisten möchten, im Format „projects/{project_id}“. |
ListDevicesResponse
Antwortnachricht für DevicesPlatformService.ListDevices
Felder | |
---|---|
devices[] |
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 |
Erforderlich. Hersteller dieses Geräts, z. B. „Google“ |
product_name |
Erforderlich. Für Kunden sichtbarer Produktname für dieses Gerätemodell, z. B. „Google Assistant-Prototypgerät“. |
device_description |
Optionale Beschreibung dieses Gerätemodells, z. B. „Intelligenter Lautsprecher von Google mit integriertem Google Assistant“. |
UpdateDeviceModelRequest
Anfragenachricht für DevicesPlatformService.UpdateDeviceModel.
Felder | |
---|---|
name |
Ressourcenname des Projekts, in dem das Gerätemodell aktualisiert werden soll, im Format |
device_model |
Entwickler eines neuen Gerätemodells möchte aktualisieren. |