Package google.assistant.devices.v1alpha2

Indeks

DevicesPlatformService

Ta usługa pozwala zarządzać urządzeniami niepochodzącymi od Google. Obecnie zapewnia on deweloperom: * 1 interfejs API do rejestracji modelu urządzenia; * 1 interfejs API do rejestracji instancji urządzenia.

Rejestracja modelu urządzenia tworzy model urządzenia, który zawiera możliwości i konfiguracje wspólne dla wszystkich urządzeń w danym modelu, oraz nim zarządza.

Rejestracja instancji urządzenia tworzy instancję urządzenia na podstawie możliwości i konfiguracji zdefiniowanych w jej modelu, a także pozwala deweloperowi zdefiniować niektóre atrybuty, które różnią się w zależności od urządzenia. Podczas wykonywania po rejestracji w każdym żądaniu gRPC wymagane są wartości device_model_id i device_id, a interfejs Google Assistant API wymaga wcześniejszego zarejestrowania obu identyfikatorów. W przeciwnym razie zwracany jest błąd.

CreateDevice

rpc CreateDevice(CreateDeviceRequest) returns (Device)

Zarejestruj jedno urządzenie. Jeśli urządzenie już istnieje lub wystąpił błąd, zwróć to urządzenie.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w przewodniku uwierzytelniania.
CreateDeviceModel

rpc CreateDeviceModel(CreateDeviceModelRequest) returns (DeviceModel)

Utwórz model urządzenia innej firmy.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w przewodniku uwierzytelniania.
DeleteDevice

rpc DeleteDevice(DeleteDeviceRequest) returns (Empty)

Usuwa określony użytkownik urządzenia. Jeśli operacja się uda, zwracaj pustą wartość. W przeciwnym razie pojawi się komunikat o błędzie z informacją, że nie znaleziono urządzenia lub nie udało się go usunąć.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w przewodniku uwierzytelniania.
DeleteDeviceModel

rpc DeleteDeviceModel(DeleteDeviceModelRequest) returns (Empty)

Usuwanie modelu urządzenia innej firmy

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w przewodniku uwierzytelniania.
GetDevice

rpc GetDevice(GetDeviceRequest) returns (Device)

Uzyskaj informacje o ustawieniu urządzenia należącego do określonego użytkownika, zwróć urządzenie, jeśli się udało, lub błąd, jeśli się nie uda.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w przewodniku uwierzytelniania.
GetDeviceModel

rpc GetDeviceModel(GetDeviceModelRequest) returns (DeviceModel)

Dla podanego identyfikatora modelu urządzenia ustaw zwracanie modelu urządzenia.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w przewodniku uwierzytelniania.
ListDeviceModels

rpc ListDeviceModels(ListDeviceModelsRequest) returns (ListDeviceModelsResponse)

Wyświetl listę modeli urządzeń dla identyfikatora projektu powiązanego z tym wywołaniem interfejsu API REST.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w przewodniku uwierzytelniania.
ListDevices

rpc ListDevices(ListDevicesRequest) returns (ListDevicesResponse)

Pobierz listę urządzeń należących do użytkowników należących do danego identyfikatora projektu w tokenie OAuth. Musisz sprawdzić, czy adres URL i token mają ten sam identyfikator projektu.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w przewodniku uwierzytelniania.
UpdateDeviceModel

rpc UpdateDeviceModel(UpdateDeviceModelRequest) returns (DeviceModel)

Aktualizuje model urządzenia, zwraca jego nową wersję. Uwaga: jest to pełna aktualizacja, co oznacza, że w celu aktualizacji musisz wysłać cały model urządzenia.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w przewodniku uwierzytelniania.

CreateDeviceModelRequest

Żądanie komunikatu dotyczącego usługi DevicesPlatformService.CreateDeviceModel.

Pola
parent

string

Nazwa zasobu projektu, w którym ma zostać utworzony model urządzenia, w postaci projects/{project_id}

device_model

DeviceModel

Model urządzenia do utworzenia.

CreateDeviceRequest

Żądanie dotyczące usługi DevicesPlatformService.CreateDevice.

Pola
device

Device

Nieprzetworzone informacje o urządzeniu podane przez użytkownika. Identyfikator urządzenia powinien być unikalny w projekcie przypisanym przez właściciela projektu.

parent

string

Nazwa projektu, do którego należy urządzenie, podana w postaci projects/{project_id}

DeleteDeviceModelRequest

Żądanie komunikatu dotyczącego usługi DevicesPlatformService.DeleteDeviceModel.

Pola
name

string

Nazwa zasobu projektu, z którego należy usunąć model urządzenia, w formacie projects/{project_id}/deviceModels/{device_model_id}

DeleteDeviceRequest

Żądanie dotyczące usługi DevicesPlatformService.DeleteDevice.

Pola
name

string

Nazwa zasobu projektu, z którego należy usunąć urządzenie, w formacie projects/{project_id}/devices/{device_id}.

Urządzenie

Pola
name

string

Nazwa zasobu urządzenia w postaci projects/{project_id}/devices/{device_id}. Nazwa jest ignorowana podczas tworzenia urządzenia.

id

string

To pole jest wymagane. Unikalny identyfikator urządzenia w zakresie projektu, format jest zdefiniowany przez dewelopera, np. "06ba29e5-5f1c-1a89-303c-22de2580f2e2". Musi pasować do parametru DeviceConfig.device_id podczas wysyłania RPC rozmowy. Ten identyfikator można zresetować w ramach przywracania ustawień fabrycznych.

nickname

string

Pseudonim urządzenia określony przez użytkownika, który będzie używany do rozpoznawania mowy i kierowania na urządzenia, gdy użytkownik rozmawia z urządzeniem (np. „przesuń mojego inteligentnego robota w lewo”), gdy ma urządzenie o nazwie „mój inteligentny robot”.

model_id

string

To pole jest wymagane. Jednoznacznie identyfikuje „klasę” (model) urządzenia spośród wszystkich urządzeń w polu identyfikatora agenta, np. "manufacturer-2017-v2". Pamiętaj, że projekt może obejmować wiele różnych modeli urządzeń.

client_type

ClientType

To pole jest wymagane. Pakiet SDK Asystenta udostępnia 2 opcje integracji Asystenta z urządzeniem. To pole służy do określenia, czy klient korzysta z biblioteki pakietu SDK Asystenta, czy do wywoływania interfejsu API usługi pakietu SDK.

ClientType

Określa typ klienta.

Wartości w polu enum
CLIENT_TYPE_UNSPECIFIED Nieznany typ klienta. Wartość domyślna.
SDK_SERVICE W przypadku interfejsu API usługi gRPC pakietu SDK, który udostępnia interfejs API niskiego poziomu, który bezpośrednio manipuluje bajtami audio żądania i odpowiedzi Asystenta. Service
SDK_LIBRARY Biblioteka klienta Asystenta Google – gotowe rozwiązanie z wysokim poziomem interfejsu API opartym na zdarzeniach.

DeviceModel

Definiuje metadane dla rodziny urządzeń. Model urządzenia definiuje również wspólne możliwości dla całej rodziny urządzeń.

Pola
name

string

Nazwa zasobu modelu urządzenia w postaci projects/project-id/deviceModels/device-model-id

device_model_id

string

To pole jest wymagane. Globalny unikalny identyfikator określony przez dewelopera, np. „comcast-voice-assistant-2017-v1”. Jeśli identyfikator modelu urządzenia już istnieje, zostanie zwrócony komunikat o błędzie.

project_id

string

To pole jest wymagane. Identyfikator projektu Cloud powiązany z modelem urządzenia. W każdym projekcie można utworzyć wiele modeli urządzeń.

device_type

string

To pole jest wymagane. Prawidłowy typ urządzenia: „action.devices.types.light” "action.devices.types.OUTLET" "action.devices.types.SWITCH" "action.devices.types.AC_HEATING"

traits[]

string

Opcjonalna lista wbudowanych cech, które urządzenie może obsługiwać. Na przykład: „action.devices.traits.OnOff”

manifest

Manifest

To pole jest wymagane. Metadane opisujące model i producenta urządzenia. Informacje te będą wyświetlane w konsoli SDK, panelach danych i innych powiązanych interfejsach wizualnych.

execution_modes[]

ExecutionMode

Opcjonalny tryb wykonywania działań na urządzeniu. Jeśli ustawiona jest wartość DIRECT_RESPONSE, sterowanie urządzeniami jest włączone.

ExecutionMode

Tryb wykonywania dla działań urządzenia. Obecnie obsługujemy tylko reakcję bezpośrednią.

Wartości w polu enum
MODE_UNSPECIFIED Nie określono.
DIRECT_RESPONSE Urządzenie obsługuje wykonywanie kodu bezpośredniego. W przypadku zapytań wysyłanych z urządzenia asystent zwróci DeviceControlRequest, wraz z poleceniem i parametrami.

GetDeviceModelRequest

Prośba o komunikat dotyczący usługi DevicesPlatformService.GetDeviceModel.

Pola
name

string

Nazwa zasobu projektu, z którego można pobrać model urządzenia, w postaci projects/{project_id}/deviceModels/{device_model_id}

GetDeviceRequest

Prośba o komunikat dotyczący usługi DevicesPlatformService.GetDevice.

Pola
name

string

Nazwa zasobu umożliwiającego uzyskanie urządzenia, w postaci projects/{project_id}/devices/{device_id}.

ListDeviceModelsRequest

Żądanie dotyczące interfejsu DevicesPlatformService.ListDeviceModel.

Pola
parent

string

Żądanie nazwy zasobu modeli urządzeń ma postać projects/{project_id}

ListDeviceModelsResponse

Komunikat z odpowiedzią dla interfejsu DevicesPlatformService.CreateDeviceModel.

Pola
device_models[]

DeviceModel

ListDevicesRequest

Żądanie komunikatu dotyczącego usług DevicesPlatformService.ListDevices.

Pola
parent

string

Nazwa projektu, którego urządzenia chcesz wyświetlić, w formacie „projekty/{identyfikator_projektu}”.

ListDevicesResponse

Komunikat z odpowiedzią dla interfejsu DevicesPlatformService.ListDevices.

Pola
devices[]

Device

wszystkich należących do niego urządzeń w danym projekcie.

Plik manifestu

Metadane opisujące model i producenta urządzenia. Informacje te będą wyświetlane w konsoli SDK, panelach danych i innych powiązanych interfejsach wizualnych.

Pola
manufacturer

string

To pole jest wymagane. Producent urządzenia, np. „Google”.

product_name

string

To pole jest wymagane. Nazwa produktu dla klienta dla tego modelu urządzenia, na przykład „Prototyp urządzenia z Asystentem Google”.

device_description

string

Opcjonalny opis tego modelu urządzenia, na przykład „Inteligentny głośnik od Google z wbudowanym Asystentem Google”.

UpdateDeviceModelRequest

Żądanie dotyczące usługi DevicesPlatformService.UpdateDeviceModel.

Pola
name

string

Nazwa zasobu projektu, w którym należy zaktualizować model urządzenia, w postaci projects/{project_id}/deviceModels/{device_model_id}

device_model

DeviceModel

Deweloper nowego modelu urządzenia chce dokonać aktualizacji.