Package google.assistant.devices.v1alpha2

אינדקס

DevicesPlatformService

השירות הזה מנהל מכשירים שאינם של Google. בשלב זה השירות מספק למפתחים: * ממשק API אחד לרישום דגמי מכשירים; * ממשק API אחד לרישום מופע של מכשיר.

רישום דגמי מכשירים יוצר ומנהל את דגם המכשיר, שמכיל את היכולות וההגדרות המשותפות לכל המכשירים בדגם הזה.

רישום מופע של מכשיר יוצר מופע של מופע מכשיר על סמך היכולות וההגדרות של המכשיר שהוגדרו, והוא גם מאפשר למפתח להגדיר התאמות ששונות בין מכשירים. במהלך זמן הביצוע אחרי ההרשמה, בכל בקשת gRPC יש צורך גם ב-device_model_id וגם ב-device_id. בנוסף, בכל בקשת gRPC נדרש ששני המזהים יירשמו ב-Google Assistant API, אחרת תוחזר שגיאה.

CreateDevice

rpc CreateDevice(CreateDeviceRequest) returns (Device)

יש לרשום מכשיר אחד, להחזיר אותו אם הוא מצליח או עם שגיאה אם המכשיר כבר קיים או נכשל.

היקפי הרשאות

נדרש היקף OAuth הבא:

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

למידע נוסף, עיין במדריך האימות.
CreateDeviceModel

rpc CreateDeviceModel(CreateDeviceModelRequest) returns (DeviceModel)

יצירת דגם מכשיר של צד שלישי.

היקפי הרשאות

נדרש היקף OAuth הבא:

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

למידע נוסף, עיין במדריך האימות.
DeleteDevice

rpc DeleteDevice(DeleteDeviceRequest) returns (Empty)

מחיקת מכשיר ספציפי שבבעלות משתמש. החזרה ריקה אם הפעולה תצליח. אחרת, תופיע שגיאה שהמכשיר לא נמצא או שהמכשיר לא נמחק.

היקפי הרשאות

נדרש היקף OAuth הבא:

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

למידע נוסף, עיין במדריך האימות.
DeleteDeviceModel

rpc DeleteDeviceModel(DeleteDeviceModelRequest) returns (Empty)

מחיקת דגם מכשיר של צד שלישי.

היקפי הרשאות

נדרש היקף OAuth הבא:

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

למידע נוסף, עיין במדריך האימות.
GetDevice

rpc GetDevice(GetDeviceRequest) returns (Device)

ניתן לקבל את פרטי ההגדרות של משתמש ספציפי במכשיר, להחזיר את המכשיר אם הפעולה הצליחה או שגיאה אם הפעולה נכשלה.

היקפי הרשאות

נדרש היקף OAuth הבא:

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

למידע נוסף, עיין במדריך האימות.
GetDeviceModel

rpc GetDeviceModel(GetDeviceModelRequest) returns (DeviceModel)

בהינתן מזהה דגם המכשיר, יש להחזיר דגם מכשיר.

היקפי הרשאות

נדרש היקף OAuth הבא:

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

למידע נוסף, עיין במדריך האימות.
ListDeviceModels

rpc ListDeviceModels(ListDeviceModelsRequest) returns (ListDeviceModelsResponse)

רשימה של דגמי מכשירים למזהה הפרויקט שמשויך לקריאה הזו ל-API ל-REST.

היקפי הרשאות

נדרש היקף OAuth הבא:

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

למידע נוסף, עיין במדריך האימות.
ListDevices

rpc ListDevices(ListDevicesRequest) returns (ListDevicesResponse)

הצגת רשימה של המכשירים שבבעלות המשתמשים, השייכים ל-project_id הנתון באסימון oauth. צריך לבדוק שבכתובת ה-URL ובאסימון יש אותו project_id.

היקפי הרשאות

נדרש היקף OAuth הבא:

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

למידע נוסף, עיין במדריך האימות.
UpdateDeviceModel

rpc UpdateDeviceModel(UpdateDeviceModelRequest) returns (DeviceModel)

עדכון דגם המכשיר, החזרת הגרסה החדשה של הדגם. הערה: זהו עדכון מלא, כלומר, עליך לשלוח את דגם המכשיר כולו לעדכון.

היקפי הרשאות

נדרש היקף OAuth הבא:

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

למידע נוסף, עיין במדריך האימות.

CreateDeviceModelRequest

הודעת בקשה עבור DevicesPlatformService.CreateDeviceModel.

שדות
parent

string

שם המשאב של הפרויקט שבו יש ליצור את דגם המכשיר, בצורת projects/{project_id}

device_model

DeviceModel

דגם המכשיר שצריך ליצור.

CreateDeviceRequest

הודעת בקשה עבור DevicesPlatformService.CreateDevice.

שדות
device

Device

המידע הגולמי על המכשיר סופק על ידי המשתמש. device_id צריך להיות ייחודי בפרויקט, שהוקצה על ידי בעל הפרויקט.

parent

string

שם הפרויקט שאליו שייך המכשיר, בפורמט projects/{project_id}

DeleteDeviceModelRequest

הודעת בקשה עבור DevicesPlatformService.DeleteDeviceModel.

שדות
name

string

שם המשאב של הפרויקט שבו יש למחוק את דגם המכשיר, בצורת projects/{project_id}/deviceModels/{device_model_id}

DeleteDeviceRequest

הודעת בקשה עבור DevicesPlatformService.DeleteDevice.

שדות
name

string

שם המשאב של הפרויקט שבו יש למחוק את המכשיר, בצורה projects/{project_id}/devices/{device_id}.

מכשיר

שדות
name

string

שם המשאב של המכשיר, בצורה projects/{project_id}/devices/{device_id}. כשיוצרים מכשיר, המערכת מתעלמת מהשם.

id

string

חובה. מזהה המכשיר הייחודי בהיקף הפרויקט. הפורמט מוגדר על ידי המפתח, למשל, "06ba29e5-5f1c-1a89-303c-22de2580f2e2". חייב להתאים ל-DeviceConfig.device_id בעת שליחת RPC של Converse. המזהה הזה ניתן לאיפוס ל-FDR.

nickname

string

הכינוי של המכשיר הזה צוין על ידי, שישמש לזיהוי דיבור ולמיקוד למכשיר כשהמשתמש ידבר אל מכשיר. למשל, המשתמש יכול לומר "move my smart robot left" (העברת הרובוט החכם שלי שמאלה) כשיש לו מכשיר בשם "הרובוט החכם שלי".

model_id

string

חובה. מזהה באופן ייחודי את 'סיווג' (הדגם) של המכשיר מבין כל המכשירים שמציינים את מזהה הנציג. למשל, "manufacturer-2017-v2". לתשומת ליבכם: לפרויקט יכולים להיות כמה דגמים שונים של מכשירים.

client_type

ClientType

חובה. Assistant SDK מספקת שתי אפשרויות לשילוב Assistant במכשיר. השדה הזה משמש לזיהוי הלקוח אם הוא מבוסס על ספריית ה-SDK של Assistant או על ה-SDK של שירות ה-SDK לקריאה.

ClientType

מזהה את סוג הלקוח.

טיפוסים בני מנייה (enums)
CLIENT_TYPE_UNSPECIFIED סוג הלקוח לא ידוע, ערך ברירת המחדל.
SDK_SERVICE ל-SDK gRPC Service API, שחושף API ברמה נמוכה שמשפיע באופן ישיר על הבייטים של האודיו בבקשה ובתגובה של Assistant. Service
SDK_LIBRARY לספריית הלקוח של Google Assistant, פתרון מוכן לשימוש עם API מתקדם שמבוסס על אירועים.

DeviceModel

הגדרת מטא-נתונים למשפחת מכשירים. דגם מכשיר מגדיר גם יכולות נפוצות למשפחת מכשירים.

שדות
name

string

שם המשאב של דגם המכשיר. בצורת projects/project-id/deviceModels/device-model-id

device_model_id

string

חובה. מזהה ייחודי גלובלי שצוין על ידי המפתח, למשל “comcast-voice-assistant-2017-v1”. אם מזהה דגם המכשיר כבר קיים, תוחזר שגיאה.

project_id

string

חובה. מזהה הפרויקט בענן שמשויך לדגם המכשיר. בכל פרויקט יש הרשאה ליצור מספר דגמים של מכשירים.

device_type

string

חובה. חלק מסוגי המכשירים החוקיים: "action.devices.types.light" "action.devices.types.OUTLET" "action.devices.types.SWITCH" "action.devices.types.AC_HEATING"

traits[]

string

רשימה אופציונלית של התכונות המובנות שהמכשיר יכול לתמוך בהן. לדוגמה: "action.devices.traits.OnOff"

manifest

Manifest

חובה. מטא-נתונים שמתארים את הדגם והיצרן של המכשיר. ההערה תוצג במסוף ה-SDK, במרכזי הבקרה למדדים ובממשקים חזותיים קשורים אחרים.

execution_modes[]

ExecutionMode

מצב ביצוע אופציונלי לפעולות במכשיר. אם הוגדר DIRECT_SCREEN, המכשירים מופעלים לבקרת מכשירים.

ExecutionMode

מצב ביצוע עבור פעולות במכשיר. הנוכחי תומך רק בתגובה ישירה.

טיפוסים בני מנייה (enums)
MODE_UNSPECIFIED לא צוין.
DIRECT_RESPONSE המכשיר תומך בהפעלה ישירה. בתגובה לשאילתות שמגיעות מהמכשיר, Assistant תחזיר את DeviceControlRequest, כולל הפקודה והפרמטרים.

GetDeviceModelRequest

הודעת בקשה עבור DevicesPlatformService.GetDeviceModel.

שדות
name

string

שם המשאב של הפרויקט שבו יש לקבל דגם מכשיר, בפורמט projects/{project_id}/deviceModels/{device_model_id}

GetDeviceRequest

הודעת בקשה עבור DevicesPlatformService.GetDevice.

שדות
name

string

שם המשאב לקבלת מכשיר, בפורמט projects/{project_id}/devices/{device_id}.

ListDeviceModelsRequest

הודעת בקשה עבור DevicesPlatformService.ListDeviceModel.

שדות
parent

string

יש בקשה להצגת שם המשאב של דגמי המכשירים, בפורמט projects/{project_id}

ListDeviceModelsResponse

הודעת תגובה ל-DevicePlatformService.CreateDeviceModel.

שדות
device_models[]

DeviceModel

ListDevicesRequest

הודעת בקשה עבור DevicesPlatformService.ListDevices.

שדות
parent

string

שם הפרויקט שאת המכשירים שלו רוצים לציין, בצורה'projects/{project_id}'.

ListDevicesResponse

הודעת תגובה עבור DevicesPlatformService.ListDevices.

שדות
devices[]

Device

כל המכשירים שבבעלות המשתמש הזה בפרויקט נתון.

מניפסט

מטא-נתונים שמתארים את הדגם והיצרן של המכשיר. ההערה תוצג במסוף ה-SDK, במרכזי הבקרה למדדים ובממשקים חזותיים קשורים אחרים.

שדות
manufacturer

string

חובה. יצרן המכשיר הזה, למשל "Google".

product_name

string

חובה. שם המוצר שמיועד לצרכנים מהדגם הזה, למשל 'מכשיר אב-טיפוס של Google Assistant'.

device_description

string

אופציונלי תיאור של דגם המכשיר הזה, למשל 'רמקול חכם של Google, עם Google Assistant מובנית'.

UpdateDeviceModelRequest

הודעת בקשה עבור DevicesPlatformService.UpdateDeviceModel.

שדות
name

string

שם המשאב של הפרויקט שבו יש לעדכן את דגם המכשיר, בפורמט projects/{project_id}/deviceModels/{device_model_id}

device_model

DeviceModel

המפתח של דגם המכשיר החדש רוצה לבצע עדכון.