Package google.assistant.devices.v1alpha2

Chỉ mục

DevicesPlatformService

Dịch vụ này quản lý các thiết bị không phải của Google. Hiện tại, công cụ này cung cấp cho nhà phát triển: * một API để đăng ký mẫu thiết bị; * một API để đăng ký phiên bản của thiết bị.

Quy trình đăng ký mẫu thiết bị sẽ tạo và quản lý mẫu thiết bị, trong đó có các tính năng và cấu hình dùng chung trên tất cả thiết bị trong mẫu đó.

Việc đăng ký phiên bản thiết bị sẽ tạo thực thể cho phiên bản thiết bị dựa trên các khả năng và cấu hình được xác định trong mô hình, đồng thời cho phép nhà phát triển xác định một số thuộc tính khác nhau giữa các thiết bị.Trong thời gian thực thi sau khi đăng ký, mỗi yêu cầu gRPC phải có cả device_model_id và device_id, và API Trợ lý Google yêu cầu phải đăng ký cả hai mã nhận dạng, nếu không thì hệ thống sẽ trả về lỗi.

CreateDevice

rpc CreateDevice(CreateDeviceRequest) returns (Device)

Đăng ký một thiết bị, trả lại thiết bị nếu thành công hoặc gặp lỗi nếu thiết bị đã tồn tại hoặc không thành công.

Phạm vi uỷ quyền

Yêu cầu phạm vi OAuth sau:

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

Để biết thêm thông tin, hãy xem Hướng dẫn xác thực.
CreateDeviceModel

rpc CreateDeviceModel(CreateDeviceModelRequest) returns (DeviceModel)

Tạo một mẫu thiết bị bên thứ ba.

Phạm vi uỷ quyền

Yêu cầu phạm vi OAuth sau:

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

Để biết thêm thông tin, hãy xem Hướng dẫn xác thực.
DeleteDevice

rpc DeleteDevice(DeleteDeviceRequest) returns (Empty)

Xoá một người dùng thiết bị cụ thể sở hữu. Trả về kết quả trống nếu thành công, nếu không sẽ trả về lỗi cho biết không tìm thấy thiết bị hoặc không xoá được thiết bị.

Phạm vi uỷ quyền

Yêu cầu phạm vi OAuth sau:

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

Để biết thêm thông tin, hãy xem Hướng dẫn xác thực.
DeleteDeviceModel

rpc DeleteDeviceModel(DeleteDeviceModelRequest) returns (Empty)

Xoá mẫu thiết bị của bên thứ ba.

Phạm vi uỷ quyền

Yêu cầu phạm vi OAuth sau:

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

Để biết thêm thông tin, hãy xem Hướng dẫn xác thực.
GetDevice

rpc GetDevice(GetDeviceRequest) returns (Device)

Nhận thông tin về chế độ cài đặt của một người dùng thiết bị cụ thể, trả lại thiết bị nếu thành công hoặc trả về lỗi nếu không thành công.

Phạm vi uỷ quyền

Yêu cầu phạm vi OAuth sau:

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

Để biết thêm thông tin, hãy xem Hướng dẫn xác thực.
GetDeviceModel

rpc GetDeviceModel(GetDeviceModelRequest) returns (DeviceModel)

Trả về một mẫu thiết bị dựa trên mã mẫu thiết bị.

Phạm vi uỷ quyền

Yêu cầu phạm vi OAuth sau:

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

Để biết thêm thông tin, hãy xem Hướng dẫn xác thực.
ListDeviceModels

rpc ListDeviceModels(ListDeviceModelsRequest) returns (ListDeviceModelsResponse)

Liệt kê các mẫu thiết bị cho mã dự án được liên kết với lệnh gọi API REST này.

Phạm vi uỷ quyền

Yêu cầu phạm vi OAuth sau:

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

Để biết thêm thông tin, hãy xem Hướng dẫn xác thực.
ListDevices

rpc ListDevices(ListDevicesRequest) returns (ListDevicesResponse)

Nhận danh sách thiết bị mà người dùng sở hữu thuộc project_id cho trước trong mã thông báo OAuth. Cần kiểm tra URL và mã thông báo có cùng project_id.

Phạm vi uỷ quyền

Yêu cầu phạm vi OAuth sau:

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

Để biết thêm thông tin, hãy xem Hướng dẫn xác thực.
UpdateDeviceModel

rpc UpdateDeviceModel(UpdateDeviceModelRequest) returns (DeviceModel)

Cập nhật mẫu thiết bị, trả về phiên bản mới của mẫu thiết bị. Lưu ý: đây là bản cập nhật đầy đủ, nghĩa là bạn cần gửi toàn bộ mẫu thiết bị để được cập nhật.

Phạm vi uỷ quyền

Yêu cầu phạm vi OAuth sau:

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

Để biết thêm thông tin, hãy xem Hướng dẫn xác thực.

CreateDeviceModelRequest

Thông báo yêu cầu cho DevicesPlatformService.CreateDeviceModel.

Các trường
parent

string

Tên tài nguyên của dự án mà bạn tạo mẫu thiết bị, có dạng projects/{project_id}

device_model

DeviceModel

device_model cần được tạo.

CreateDeviceRequest

Thông báo yêu cầu đối với DevicesPlatformService.CreateDevice.

Các trường
device

Device

Thông tin thiết bị thô do người dùng cung cấp. device_id phải là duy nhất trong dự án, do chủ sở hữu dự án chỉ định.

parent

string

Tên của dự án chứa thiết bị, có dạng projects/{project_id}

DeleteDeviceModelRequest

Thông báo yêu cầu đối với DevicesPlatformService.DeleteDeviceModel.

Các trường
name

string

Tên tài nguyên của dự án mà bạn cần xoá mẫu thiết bị, có dạng projects/{project_id}/deviceModels/{device_model_id}

DeleteDeviceRequest

Thông báo yêu cầu đối với DevicesPlatformService.DeleteDevice.

Các trường
name

string

Tên tài nguyên của dự án cần xoá thiết bị, có dạng projects/{project_id}/devices/{device_id}.

Thiết bị

Các trường
name

string

Tên tài nguyên của thiết bị, có dạng projects/{project_id}/devices/{device_id}. Tên sẽ bị bỏ qua khi tạo thiết bị.

id

string

Bắt buộc. Mã thiết bị duy nhất trong phạm vi dự án, định dạng do nhà phát triển xác định, ví dụ: "06ba29e5-5f1c-1a89-303c-22de2580f2e2". Phải khớp với DeviceConfig.device_id khi gửi RPC Converse. Mã này có thể đặt lại cho FDR.

nickname

string

Biệt hiệu cho thiết bị này được chỉ định bởi.Biệt hiệu này sẽ được dùng để nhận dạng giọng nói và nhắm mục tiêu theo thiết bị khi người dùng nói với một thiết bị. Ví dụ: người dùng có thể nói "di chuyển rô-bốt thông minh của tôi sang trái" khi họ có thiết bị có tên là "robot thông minh của tôi".

model_id

string

Bắt buộc. Xác định riêng biệt "lớp" (kiểu máy) của thiết bị trong số tất cả các thiết bị có mã nhận dạng nhân viên hỗ trợ. Ví dụ: "manufacturer-2017-v2". Xin lưu ý rằng một dự án có thể có nhiều mẫu thiết bị.

client_type

ClientType

Bắt buộc. SDK Trợ lý cung cấp hai lựa chọn để tích hợp Trợ lý vào thiết bị của bạn. Trường này dùng để xác định xem ứng dụng dựa trên thư viện SDK của Trợ lý hay gọi API dịch vụ SDK.

ClientType

Xác định loại ứng dụng.

Enum
CLIENT_TYPE_UNSPECIFIED Không xác định được loại ứng dụng, là giá trị mặc định.
SDK_SERVICE Đối với API dịch vụ gRPC của SDK, API này sẽ hiển thị một API cấp thấp trực tiếp điều khiển các byte âm thanh của một yêu cầu và phản hồi của Trợ lý. Service
SDK_LIBRARY Đối với thư viện ứng dụng Trợ lý Google, một giải pháp chìa khoá trao tay có API cấp cao dựa trên sự kiện.

DeviceModel

Xác định siêu dữ liệu cho một nhóm thiết bị Mẫu thiết bị cũng xác định các tính năng phổ biến cho một nhóm thiết bị.

Các trường
name

string

Tên tài nguyên của mẫu thiết bị, có dạng projects/project-id/deviceModels/device-model-id

device_model_id

string

Bắt buộc. Mã nhận dạng chung duy nhất do nhà phát triển chỉ định, chẳng hạn như “comcast-voice-assistant-2017-v1”. Nếu đã có mã mẫu thiết bị, hệ thống sẽ trả về lỗi.

project_id

string

Bắt buộc. Mã dự án trên đám mây được liên kết với Mẫu thiết bị. Mỗi dự án được phép tạo nhiều mẫu thiết bị.

device_type

string

Bắt buộc. Một số Loại thiết bị hợp lệ: "action.devices.types.Light" "action.devices.types.OUTLET" "action.devices.types.". "action.devices.types.AC_HEATING"

traits[]

string

Danh sách các trait tích hợp không bắt buộc mà thiết bị có thể hỗ trợ. Ví dụ: "action.devices.traits.OnOff"

manifest

Manifest

Bắt buộc. Siêu dữ liệu mô tả mẫu thiết bị và nhà sản xuất. Thông tin này sẽ xuất hiện trong bảng điều khiển SDK, trang tổng quan về chỉ số và các giao diện trực quan khác có liên quan.

execution_modes[]

ExecutionMode

Chế độ thực thi không bắt buộc dành cho Hành động trên thiết bị. Nếu bạn đặt lệnh DIRECT_REVIEW, các thiết bị sẽ được bật để điều khiển thiết bị.

ExecutionMode

Chế độ thực thi cho Thao tác trên thiết bị, hiện tại chỉ hỗ trợ phản hồi trực tiếp.

Enum
MODE_UNSPECIFIED Chưa xác định.
DIRECT_RESPONSE Thiết bị hỗ trợ thực thi trực tiếp. Đối với các truy vấn đến từ thiết bị, trợ lý sẽ trả về DeviceControlRequest, bao gồm cả lệnh và các tham số.

GetDeviceModelRequest

Thông báo yêu cầu cho DevicesPlatformService.GetDeviceModel.

Các trường
name

string

Tên tài nguyên của dự án mà bạn tải mẫu thiết bị, có dạng projects/{project_id}/deviceModels/{device_model_id}

GetDeviceRequest

Thông báo yêu cầu đối với DevicesPlatformService.GetDevice.

Các trường
name

string

Tên tài nguyên để tải thiết bị, có dạng projects/{project_id}/devices/{device_id}.

ListDeviceModelsRequest

Thông báo yêu cầu đối với DevicesPlatformService.ListDeviceModel.

Các trường
parent

string

Đang yêu cầu tên tài nguyên của các mẫu thiết bị ở dạng projects/{project_id}

ListDeviceModelsResponse

Thông báo phản hồi cho DevicesPlatformService.CreateDeviceModel.

Các trường
device_models[]

DeviceModel

ListDevicesRequest

Thông báo yêu cầu cho DevicesPlatformService.ListDevices.

Các trường
parent

string

Tên của dự án có các thiết bị mà chúng ta muốn liệt kê, có dạng "projects/{project_id}".

ListDevicesResponse

Thông báo phản hồi cho DevicesPlatformService.ListDevices.

Các trường
devices[]

Device

tất cả thiết bị mà người dùng này sở hữu trong dự án cụ thể.

Tệp kê khai

Siêu dữ liệu mô tả mẫu thiết bị và nhà sản xuất. Thông tin này sẽ xuất hiện trong bảng điều khiển SDK, trang tổng quan về chỉ số và các giao diện trực quan khác có liên quan.

Các trường
manufacturer

string

Bắt buộc. Nhà sản xuất thiết bị này, chẳng hạn như "Google".

product_name

string

Bắt buộc. Tên sản phẩm dành cho người tiêu dùng cho mẫu thiết bị này, chẳng hạn như "thiết bị nguyên mẫu có Trợ lý Google".

device_description

string

Nội dung mô tả không bắt buộc về mẫu thiết bị này, chẳng hạn như "Loa thông minh của Google, có tích hợp Trợ lý Google".

UpdateDeviceModelRequest

Thông báo yêu cầu cho DevicesPlatformService.UpdateDeviceModel.

Các trường
name

string

Tên tài nguyên của dự án cần cập nhật mẫu thiết bị, có dạng projects/{project_id}/deviceModels/{device_model_id}

device_model

DeviceModel

Nhà phát triển mẫu thiết bị mới muốn cập nhật.