ดัชนี
DevicesPlatformService
(อินเทอร์เฟซ)CreateDeviceModelRequest
(ข้อความ)CreateDeviceRequest
(ข้อความ)DeleteDeviceModelRequest
(ข้อความ)DeleteDeviceRequest
(ข้อความ)Device
(ข้อความ)Device.ClientType
(enum)DeviceModel
(ข้อความ)DeviceModel.ExecutionMode
(enum)GetDeviceModelRequest
(ข้อความ)GetDeviceRequest
(ข้อความ)ListDeviceModelsRequest
(ข้อความ)ListDeviceModelsResponse
(ข้อความ)ListDevicesRequest
(ข้อความ)ListDevicesResponse
(ข้อความ)Manifest
(ข้อความ)UpdateDeviceModelRequest
(ข้อความ)
DevicesPlatformService
บริการนี้จัดการอุปกรณ์ที่ไม่ใช่ของ Google ปัจจุบันนักพัฒนาใช้: * API 1 รายการสำหรับการลงทะเบียนรุ่นอุปกรณ์ * 1 API สำหรับการลงทะเบียนอินสแตนซ์ของอุปกรณ์
การลงทะเบียนรุ่นอุปกรณ์จะสร้างและจัดการรุ่นอุปกรณ์ ซึ่งมีความสามารถและการกำหนดค่าที่แชร์กันระหว่างอุปกรณ์ทั้งหมดในรุ่นนั้น
การลงทะเบียนอินสแตนซ์ของอุปกรณ์จะสร้างอินสแตนซ์ของอุปกรณ์ตามความสามารถและการกำหนดค่าที่กำหนดไว้ในโมเดล และยังช่วยให้นักพัฒนาแอปกำหนดแอตทริบิวต์บางอย่างที่แตกต่างกันไปในอุปกรณ์แต่ละรุ่นได้ ระหว่างการดำเนินการหลังการลงทะเบียน คำขอ gRPC แต่ละรายการต้องมีทั้ง device_model_id และ device_id และ Google Assistant API กำหนดให้ลงทะเบียนทั้งสองรหัสไว้แล้ว มิเช่นนั้นระบบจะแสดงข้อผิดพลาด
CreateDevice | |
---|---|
ลงทะเบียนอุปกรณ์ 1 เครื่อง แล้วส่งคืนอุปกรณ์หากสำเร็จ หรือเกิดข้อผิดพลาดหากมีอุปกรณ์อยู่แล้วหรือล้มเหลว
|
CreateDeviceModel | |
---|---|
สร้างรุ่นอุปกรณ์ 3p
|
DeleteDevice | |
---|---|
ลบอุปกรณ์ที่ผู้ใช้เป็นเจ้าของ แสดงผลเป็นเซลล์ว่างหากดำเนินการสำเร็จ ไม่เช่นนั้นจะเกิดข้อผิดพลาดที่ระบุว่าไม่พบอุปกรณ์หรือลบไม่สำเร็จ
|
DeleteDeviceModel | |
---|---|
ลบรุ่นอุปกรณ์ 3p
|
GetDevice | |
---|---|
ดูข้อมูลการตั้งค่าของอุปกรณ์ที่ผู้ใช้เป็นเจ้าของ แล้วส่งอุปกรณ์คืนหากดำเนินการสำเร็จหรือเกิดข้อผิดพลาด
|
GetDeviceModel | |
---|---|
ส่งคืนรุ่นอุปกรณ์เมื่อได้รับรหัสรุ่นอุปกรณ์
|
ListDeviceModels | |
---|---|
แสดงรายการรุ่นอุปกรณ์สำหรับรหัสโปรเจ็กต์ที่เชื่อมโยงกับการเรียก API ของ REST นี้
|
ListDevices | |
---|---|
เรียกดูรายการอุปกรณ์ที่ผู้ใช้เป็นเจ้าของซึ่งเป็นของ project_id ที่ระบุในโทเค็น OAuth จำเป็นต้องตรวจสอบ URL และโทเค็นมี project_id เดียวกัน
|
UpdateDeviceModel | |
---|---|
อัปเดตรุ่นอุปกรณ์ แล้วคืนค่ารุ่นใหม่ หมายเหตุ: นี่คือการอัปเดตเต็มรูปแบบ ซึ่งหมายความว่าคุณต้องส่งรุ่นของอุปกรณ์ทั้งหมดเพื่อรับการอัปเดต
|
CreateDeviceModelRequest
ข้อความคำขอสำหรับ DevicesPlatformService.CreateDeviceModel
ช่อง | |
---|---|
parent |
ชื่อทรัพยากรของโปรเจ็กต์ที่ใช้สร้างรุ่นอุปกรณ์ในรูปแบบ |
device_model |
device_model ที่กำลังสร้าง |
CreateDeviceRequest
ข้อความคำขอสำหรับ DevicesPlatformService.CreateDevice
ช่อง | |
---|---|
device |
ข้อมูลอุปกรณ์ดิบที่ผู้ใช้ให้ device_id ต้องไม่ซ้ำกันในโปรเจ็กต์ กำหนดโดยเจ้าของโปรเจ็กต์ |
parent |
ชื่อโปรเจ็กต์ที่มีอุปกรณ์ในรูปแบบ |
DeleteDeviceModelRequest
ข้อความคำขอสำหรับ DevicesPlatformService.DeleteDeviceModel
ช่อง | |
---|---|
name |
ชื่อทรัพยากรของโปรเจ็กต์ที่จะลบรุ่นอุปกรณ์ ซึ่งอยู่ในรูปแบบ |
DeleteDeviceRequest
ข้อความคำขอสำหรับ DevicesPlatformService.DeleteDevice
ช่อง | |
---|---|
name |
ชื่อทรัพยากรของโปรเจ็กต์ที่จะลบอุปกรณ์ในรูปแบบ |
อุปกรณ์
ช่อง | |
---|---|
name |
ชื่อทรัพยากรของอุปกรณ์ ในรูปแบบ |
id |
ต้องระบุ รหัสอุปกรณ์ที่ไม่ซ้ำกันในขอบเขตโปรเจ็กต์ นักพัฒนาซอฟต์แวร์เป็นผู้กำหนดรูปแบบ เช่น "06ba29e5-5f1c-1a89-303c-22de2580f2e2". ต้องตรงกับ DeviceConfig.device_id เมื่อส่ง Converse RPC รหัสนี้รีเซ็ตได้สำหรับ FDR |
nickname |
ชื่อเล่นสำหรับอุปกรณ์นี้ที่ระบุ ซึ่งจะนำไปใช้ในการจดจำคำพูดและการกำหนดอุปกรณ์เป้าหมายเมื่อผู้ใช้พูดกับอุปกรณ์ เช่น ผู้ใช้สามารถพูดว่า "ย้ายหุ่นยนต์อัจฉริยะของฉันไปทางซ้าย" เมื่อมีอุปกรณ์ชื่อ "หุ่นยนต์อัจฉริยะของฉัน" |
model_id |
ต้องระบุ ระบุ "คลาส" (รุ่น) ของอุปกรณ์โดยไม่ซ้ำกันในอุปกรณ์ทั้งหมดสำหรับรหัส Agent เช่น "manufacturer-2017-v2". โปรดทราบว่าโปรเจ็กต์อาจมีอุปกรณ์ที่แตกต่างกันหลายรุ่น |
client_type |
ต้องระบุ Assistant SDK มี 2 ตัวเลือกในการผสานรวม Assistant เข้ากับอุปกรณ์ของคุณ ช่องนี้มีไว้เพื่อระบุว่าไคลเอ็นต์อิงตามไลบรารี Assistant SDK หรือเรียกใช้ API บริการ SDK |
ClientType
ระบุประเภทไคลเอ็นต์
Enum | |
---|---|
CLIENT_TYPE_UNSPECIFIED |
ไม่ทราบประเภทของไคลเอ็นต์นี้ ค่าเริ่มต้นคือ |
SDK_SERVICE |
สำหรับ API บริการ gRPC ของ SDK ซึ่งจะแสดง API ระดับต่ำที่ควบคุมไบต์เสียงของคำขอและการตอบสนอง Assistant โดยตรง Service |
SDK_LIBRARY |
สำหรับไลบรารีของไคลเอ็นต์ Google Assistant ซึ่งเป็นโซลูชันแบบครบวงจรที่มี API แบบอิงตามเหตุการณ์ในระดับสูง |
DeviceModel
กำหนดข้อมูลเมตาสำหรับกลุ่มอุปกรณ์ รุ่นอุปกรณ์จะระบุความสามารถทั่วไปของกลุ่มอุปกรณ์ด้วย
ช่อง | |
---|---|
name |
ชื่อทรัพยากรของรุ่นอุปกรณ์ในรูปแบบ |
device_model_id |
ต้องระบุ รหัสที่ไม่ซ้ำกันทั่วโลกที่นักพัฒนาแอประบุไว้ เช่น “comcast-voice-assistant-2017-v1” ระบบจะแสดงข้อผิดพลาดหากมีรหัสรุ่นอุปกรณ์อยู่แล้ว |
project_id |
ต้องระบุ รหัสโปรเจ็กต์ Cloud ที่เชื่อมโยงกับรุ่นอุปกรณ์ โปรเจ็กต์แต่ละโปรเจ็กต์ได้รับอนุญาตให้สร้างรุ่นอุปกรณ์ได้หลายรุ่น |
device_type |
ต้องระบุ ประเภทอุปกรณ์ที่ถูกต้องบางประเภท: "action.devices.types.LIGHT" "action.devices.types.OUTLET" "action.devices.types.SWITCH" "action.devices.types.AC_HEATING" |
traits[] |
รายการลักษณะในตัวที่อุปกรณ์รองรับซึ่งไม่บังคับ เช่น "action.devices.traits.OnOff" |
manifest |
ต้องระบุ ข้อมูลเมตาที่อธิบายรุ่นและผู้ผลิตอุปกรณ์ ข้อมูลนี้จะแสดงในคอนโซล SDK, แดชบอร์ดเมตริก และอินเทอร์เฟซภาพอื่นๆ ที่เกี่ยวข้อง |
execution_modes[] |
โหมดดำเนินการที่ไม่บังคับสำหรับการดำเนินการของอุปกรณ์ หากตั้งค่า DIRECT_RESPONSE ไว้ อุปกรณ์จะเปิดใช้สำหรับการควบคุมอุปกรณ์ |
ExecutionMode
โหมดการดำเนินการสำหรับการดำเนินการของอุปกรณ์ ปัจจุบันรองรับเฉพาะการตอบสนองโดยตรงเท่านั้น
Enum | |
---|---|
MODE_UNSPECIFIED |
ไม่ได้ระบุ |
DIRECT_RESPONSE |
อุปกรณ์รองรับการดำเนินการโดยตรง สำหรับการค้นหาที่มาจากอุปกรณ์ Assistant จะส่งคืน DeviceControlRequest รวมถึงคำสั่งและพารามิเตอร์ |
GetDeviceModelRequest
ข้อความคำขอสำหรับ DevicesPlatformService.GetDeviceModel
ช่อง | |
---|---|
name |
ชื่อทรัพยากรของโปรเจ็กต์ที่ต้องการรับรุ่นอุปกรณ์ ซึ่งมีรูปแบบ |
GetDeviceRequest
ข้อความคำขอสำหรับ DevicesPlatformService.GetDevice
ช่อง | |
---|---|
name |
ชื่อทรัพยากรสำหรับรับอุปกรณ์ ในรูปแบบ |
ListDeviceModelsRequest
ข้อความคำขอสำหรับ DevicesPlatformService.ListDeviceModel
ช่อง | |
---|---|
parent |
กำลังขอชื่อทรัพยากรของรุ่นอุปกรณ์ ในรูปแบบ |
ListDeviceModelsResponse
ข้อความตอบกลับสำหรับ DevicesPlatformService.CreateDeviceModel
ช่อง | |
---|---|
device_models[] |
|
ListDevicesRequest
ข้อความคำขอสำหรับ DevicesPlatformService.Listdevices
ช่อง | |
---|---|
parent |
ชื่อโปรเจ็กต์ที่มีอุปกรณ์ที่เราต้องการแสดงรายการในรูปแบบ "projects/{project_id}" |
ListDevicesResponse
ข้อความตอบกลับสำหรับ DevicesPlatformService.ListDevices
ช่อง | |
---|---|
devices[] |
อุปกรณ์ทั้งหมดที่ผู้ใช้นี้เป็นเจ้าของในโปรเจ็กต์ที่กำหนด |
ไฟล์ Manifest
ข้อมูลเมตาที่อธิบายรุ่นและผู้ผลิตอุปกรณ์ ข้อมูลนี้จะแสดงในคอนโซล SDK, แดชบอร์ดเมตริก และอินเทอร์เฟซภาพอื่นๆ ที่เกี่ยวข้อง
ช่อง | |
---|---|
manufacturer |
ต้องระบุ ผู้ผลิตอุปกรณ์นี้ เช่น "Google" |
product_name |
ต้องระบุ ชื่อผลิตภัณฑ์ที่แสดงต่อผู้บริโภคสำหรับรุ่นอุปกรณ์นี้ เช่น "อุปกรณ์ต้นแบบของ Google Assistant" |
device_description |
คำอธิบายเสริมสำหรับอุปกรณ์รุ่นนี้ เช่น "ลำโพงอัจฉริยะจาก Google ที่มี Google Assistant Built-In" |
UpdateDeviceModelRequest
ข้อความคำขอสำหรับ DevicesPlatformService.UpdateDeviceModel
ช่อง | |
---|---|
name |
ชื่อทรัพยากรของโปรเจ็กต์ที่จะอัปเดตรุ่นอุปกรณ์ในรูปแบบ |
device_model |
นักพัฒนารุ่นอุปกรณ์รายใหม่ต้องการอัปเดต |