Package google.assistant.devices.v1alpha2

Indeks

DevicesPlatformService

Layanan ini mengelola perangkat non-Google. Saat ini menyediakan developer: * satu API untuk pendaftaran model perangkat; * satu API untuk pendaftaran instance perangkat.

Pendaftaran model perangkat membuat dan mengelola model perangkat, yang berisi kemampuan dan konfigurasi yang digunakan bersama di semua perangkat dalam model tersebut.

Pendaftaran instance perangkat membuat instance perangkat berdasarkan kemampuan dan konfigurasi yang ditentukan dalam modelnya dan juga memungkinkan developer menentukan beberapa atribut yang bervariasi antar-perangkat. Selama waktu eksekusi setelah pendaftaran, device_model_id dan device_id diperlukan dalam setiap permintaan gRPC, dan Google Assistant API memerlukan kedua ID sudah terdaftar. Jika tidak, error akan ditampilkan.

CreateDevice

rpc CreateDevice(CreateDeviceRequest) returns (Device)

Daftarkan satu perangkat, tampilkan perangkat jika berhasil atau error jika perangkat sudah ada atau gagal.

Cakupan Otorisasi

Memerlukan cakupan OAuth berikut ini:

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

Untuk mengetahui informasi selengkapnya, lihat Panduan Autentikasi.
CreateDeviceModel

rpc CreateDeviceModel(CreateDeviceModelRequest) returns (DeviceModel)

Buat model perangkat pihak ketiga.

Cakupan Otorisasi

Memerlukan cakupan OAuth berikut ini:

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

Untuk mengetahui informasi selengkapnya, lihat Panduan Autentikasi.
DeleteDevice

rpc DeleteDevice(DeleteDeviceRequest) returns (Empty)

Menghapus perangkat milik pengguna tertentu. Ditampilkan kosong jika berhasil. Jika tidak, akan muncul error yang menyatakan bahwa perangkat tidak ditemukan atau gagal dihapus.

Cakupan Otorisasi

Memerlukan cakupan OAuth berikut ini:

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

Untuk mengetahui informasi selengkapnya, lihat Panduan Autentikasi.
DeleteDeviceModel

rpc DeleteDeviceModel(DeleteDeviceModelRequest) returns (Empty)

Menghapus model perangkat 3p.

Cakupan Otorisasi

Memerlukan cakupan OAuth berikut ini:

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

Untuk mengetahui informasi selengkapnya, lihat Panduan Autentikasi.
GetDevice

rpc GetDevice(GetDeviceRequest) returns (Device)

Mendapatkan info setelan perangkat tertentu milik pengguna, menampilkan perangkat jika berhasil, atau error jika gagal.

Cakupan Otorisasi

Memerlukan cakupan OAuth berikut ini:

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

Untuk mengetahui informasi selengkapnya, lihat Panduan Autentikasi.
GetDeviceModel

rpc GetDeviceModel(GetDeviceModelRequest) returns (DeviceModel)

Dengan mempertimbangkan ID model perangkat, tampilkan model perangkat.

Cakupan Otorisasi

Memerlukan cakupan OAuth berikut ini:

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

Untuk mengetahui informasi selengkapnya, lihat Panduan Autentikasi.
ListDeviceModels

rpc ListDeviceModels(ListDeviceModelsRequest) returns (ListDeviceModelsResponse)

Mencantumkan model perangkat untuk project ID yang terkait dengan panggilan REST API ini.

Cakupan Otorisasi

Memerlukan cakupan OAuth berikut ini:

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

Untuk mengetahui informasi selengkapnya, lihat Panduan Autentikasi.
ListDevices

rpc ListDevices(ListDevicesRequest) returns (ListDevicesResponse)

Mendapatkan daftar perangkat milik pengguna yang termasuk dalam project_id yang ditentukan dalam token oauth. Perlu memeriksa URL dan token memiliki project_id yang sama.

Cakupan Otorisasi

Memerlukan cakupan OAuth berikut ini:

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

Untuk mengetahui informasi selengkapnya, lihat Panduan Autentikasi.
UpdateDeviceModel

rpc UpdateDeviceModel(UpdateDeviceModelRequest) returns (DeviceModel)

Mengupdate model perangkat, menampilkan model versi baru. Catatan: ini adalah update lengkap, artinya Anda perlu mengirim seluruh model perangkat untuk diupdate.

Cakupan Otorisasi

Memerlukan cakupan OAuth berikut ini:

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

Untuk mengetahui informasi selengkapnya, lihat Panduan Autentikasi.

CreateDeviceModelRequest

Pesan permintaan untuk DevicesPlatformService.CreateDeviceModel.

Kolom
parent

string

Nama resource project tempat untuk membuat model perangkat, dengan bentuk projects/{project_id}

device_model

DeviceModel

device_model yang akan dibuat.

CreateDeviceRequest

Pesan permintaan untuk DevicesPlatformService.CreateDevice.

Kolom
device

Device

Info perangkat mentah yang diberikan oleh pengguna. device_id harus unik dalam project dan ditetapkan oleh pemilik project.

parent

string

Nama project tempat perangkat berada, dalam bentuk projects/{project_id}

DeleteDeviceModelRequest

Pesan permintaan untuk DevicesPlatformService.DeleteDeviceModel.

Kolom
name

string

Nama resource project tempat untuk menghapus model perangkat, dengan bentuk projects/{project_id}/deviceModels/{device_model_id}

DeleteDeviceRequest

Pesan permintaan untuk DevicesPlatformService.DeleteDevice.

Kolom
name

string

Nama resource project untuk menghapus perangkat, dengan bentuk projects/{project_id}/devices/{device_id}.

Perangkat

Kolom
name

string

Nama resource perangkat, dalam bentuk projects/{project_id}/devices/{device_id}. Nama akan diabaikan saat membuat perangkat.

id

string

Wajib. ID perangkat unik dalam cakupan project, formatnya ditentukan oleh developer, mis., "06ba29e5-5f1c-1a89-303c-22de2580f2e2". Harus cocok dengan DeviceConfig.device_id saat mengirim RPC Converse. ID ini dapat direset untuk FDR.

nickname

string

Nama panggilan untuk perangkat ini yang ditentukan oleh, yang akan digunakan untuk pengenalan ucapan dan penargetan perangkat saat pengguna berbicara dengan perangkat, misalnya, pengguna dapat mengucapkan "pindahkan robot pintar saya ke kiri" saat dia memiliki perangkat bernama "robot pintar saya".

model_id

string

Wajib. Mengidentifikasi secara unik "class" (model) perangkat di antara semua perangkat untuk ID agen, mis., "manufacturer-2017-v2". Perlu diperhatikan bahwa sebuah project dapat memiliki beberapa model perangkat yang berbeda.

client_type

ClientType

Wajib. SDK Asisten menyediakan dua opsi untuk mengintegrasikan Asisten ke perangkat Anda. Kolom ini digunakan untuk mengidentifikasi apakah klien didasarkan pada library SDK Asisten atau memanggil API layanan SDK.

ClientType

Mengidentifikasi jenis klien.

Enum
CLIENT_TYPE_UNSPECIFIED Jenis klien tidak diketahui, nilai default.
SDK_SERVICE Untuk API layanan gRPC SDK, yang mengekspos API level rendah yang langsung memanipulasi byte audio permintaan dan respons Asisten. Service
SDK_LIBRARY Untuk library klien Asisten Google, solusi siap pakai dengan API berbasis peristiwa tingkat tinggi.

DeviceModel

Menentukan metadata untuk kelompok perangkat Model perangkat juga menentukan kemampuan umum untuk kelompok perangkat tersebut.

Kolom
name

string

Nama resource model perangkat, dalam bentuk projects/project-id/deviceModels/device-model-id

device_model_id

string

Wajib. ID unik global yang ditentukan oleh developer, seperti “comcast-voice-assistant-2017-v1”. Jika ID model perangkat sudah ada, error akan ditampilkan.

project_id

string

Wajib. ID project Cloud yang terkait dengan Model Perangkat. Setiap project diizinkan untuk membuat beberapa model perangkat.

device_type

string

Wajib. Beberapa Jenis Perangkat yang Valid: "action.devices.types.Light" "action.devices.types.OUTLET" "action.devices.types.SWITCH" "action.devices.types.AC_HEATING"

traits[]

string

Daftar Opsional karakteristik bawaan yang dapat didukung perangkat. Misalnya: "action.devices.traits.OnOff"

manifest

Manifest

Wajib. Metadata yang mendeskripsikan model dan produsen perangkat. Ini akan ditampilkan di SDK console, dasbor metrik, dan antarmuka visual terkait lainnya.

execution_modes[]

ExecutionMode

Mode Eksekusi opsional untuk Tindakan Perangkat. Jika DIRECT_RESPONSE ditetapkan, perangkat akan diaktifkan untuk kontrol perangkat.

ExecutionMode

Mode eksekusi untuk Tindakan Perangkat, saat ini hanya mendukung respons langsung.

Enum
MODE_UNSPECIFIED Tidak ditentukan.
DIRECT_RESPONSE Perangkat mendukung eksekusi langsung. Untuk kueri yang berasal dari perangkat, asisten akan menampilkan DeviceControlRequest termasuk perintah dan parameter.

GetDeviceModelRequest

Pesan permintaan untuk DevicesPlatformService.GetDeviceModel.

Kolom
name

string

Nama resource project untuk mendapatkan model perangkat, dengan bentuk projects/{project_id}/deviceModels/{device_model_id}

GetDeviceRequest

Pesan permintaan untuk DevicesPlatformService.GetDevice.

Kolom
name

string

Nama resource untuk mendapatkan perangkat, dalam bentuk projects/{project_id}/devices/{device_id}.

ListDeviceModelsRequest

Pesan permintaan untuk DevicesPlatformService.ListDeviceModel.

Kolom
parent

string

Nama resource model perangkat diminta, dengan format projects/{project_id}

ListDeviceModelsResponse

Pesan respons untuk DevicesPlatformService.CreateDeviceModel.

Kolom
device_models[]

DeviceModel

ListDevicesRequest

Pesan permintaan untuk DevicesPlatformService.ListDevices.

Kolom
parent

string

Nama project yang perangkatnya ingin kami cantumkan, dalam bentuk `projects/{project_id}'.

ListDevicesResponse

Pesan respons untuk DevicesPlatformService.ListDevices.

Kolom
devices[]

Device

semua perangkat yang dimiliki pengguna ini di project tertentu.

Manifes

Metadata yang mendeskripsikan model dan produsen perangkat. Ini akan ditampilkan di SDK console, dasbor metrik, dan antarmuka visual terkait lainnya.

Kolom
manufacturer

string

Wajib. Produsen perangkat ini, seperti “Google”.

product_name

string

Wajib. Nama produk yang dilihat konsumen untuk model perangkat ini, seperti “Perangkat prototipe Asisten Google”.

device_description

string

Deskripsi Opsional model perangkat ini, seperti “Smart speaker dari Google, yang dilengkapi Asisten Google”.

UpdateDeviceModelRequest

Pesan permintaan untuk DevicesPlatformService.UpdateDeviceModel.

Kolom
name

string

Nama resource project untuk mengupdate model perangkat, dengan bentuk projects/{project_id}/deviceModels/{device_model_id}

device_model

DeviceModel

Developer model perangkat baru ingin diupdate.