Method: customer.devices.chromeos.issueCommand

הפעלת פקודה למכשיר.

בקשת HTTP

POST https://admin.googleapis.com/admin/directory/v1/customer/{customerId}/devices/chromeos/{deviceId}:issueCommand

כתובת ה-URL משתמשת בתחביר של Transcoding של gRPC.

פרמטרים של נתיב

פרמטרים
customerId

string

לא ניתן לשינוי. המזהה של חשבון Google Workspace.
deviceId

string

לא ניתן לשינוי. המזהה של מכשיר Chrome OS.

גוף הבקשה

גוף הבקשה מכיל נתונים במבנה הבא:

ייצוג ב-JSON 
{
  "commandType": enum (CommandType),
  "payload": string
}
שדות
commandType

enum (CommandType)

סוג הפקודה.
payload

string

נתוני העומס של הפקודה. יש לציין אותם רק אם הפקודה תומכת בכך. הפקודות הבאות תומכות בהוספת עומס שימושי:

  • SET_VOLUME: המטען הייעודי הוא אובייקט JSON שעבר עיבוד למחרוזת, בפורמט: { "volume": 50 }. הנפח צריך להיות מספר שלם בטווח [0,100].
  • DEVICE_START_CRD_SESSION: המטען הייעודי (payload) יכול להיות אובייקט JSON שמומר למחרוזת בפורמט: { "ackedUserPresence": true, "crdSessionType": string }. הערך של ackedUserPresence הוא בוליאני. כברירת מחדל, ackedUserPresence מוגדר כ-false. כדי להתחיל סשן של Chrome Remote Desktop במכשיר פעיל, מגדירים את ackedUserPresence כ-true. אפשר לבחור ב-crdSessionType רק מבין הערכים private (מקנה לאדמין המרוחק שליטה בלעדית במכשיר ChromeOS) או shared (מאפשר לאדמין ולמשתמש המקומי לשתף את השליטה במכשיר ChromeOS). אם לא מגדירים את הפרמטר crdSessionType, ערך ברירת המחדל שלו הוא shared.
  • REBOOT: המטען הייעודי (payload) הוא אובייקט JSON שמומר למחרוזת בפורמט: { "user_session_delay_seconds": 300 }. הערך user_session_delay_seconds הוא מספר השניות שצריך להמתין לפני הפעלה מחדש של המכשיר אם משתמש מחובר. הערך חייב להיות מספר שלם בטווח [0,300]. אם לא צוין מטען נתונים להפעלה מחדש, ברירת המחדל היא עיכוב של 0. הערה: האפשרות הזו רלוונטית רק אם משתמש בפועל מחובר, כולל אורח. אם המכשיר נמצא במסך ההתחברות או במצב קיוסק, הערך לא יתקבל והמכשיר יופעל מחדש באופן מיידי.
  • FETCH_SUPPORT_PACKET: המטען הייעודי (payload) יכול להיות אובייקט JSON שמומר למחרוזת בפורמט: {"supportPacketDetails":{ "issueCaseId": optional_support_case_id_string, "issueDescription": optional_issue_description_string, "requestedDataCollectors": [<comma-separated list of data_collector_enums integer values>]}}
    רשימת הערכים הזמינים של data_collector_enums היא: פרטי מערכת Chrome‏ (1), מזהי קריסה (2), פרטי זיכרון (3), היררכיית ממשק משתמש (4), יומני פלטפורמה נוספים של ChromeOS‏ (5), אירוע מכשיר (6), תוצאת ניפוי באגים של Intel WiFi NICs‏ (7), אירועי מגע (8), Lacros‏ (9), פרטי מערכת Lacros‏ (10), יומני Flex של ChromeOS‏ (11), פרטי DBus‏ (12), מסלולי רשת של ChromeOS‏ (13), יומני Shill (מנהל חיבורים) של ChromeOS‏ (14), כללי מדיניות (15), סטטוס המערכת והיומנים של ChromeOS‏ (16), יומני המערכת של ChromeOS‏ (17), יומני משתמש ב-ChromeOS‏ (18), Bluetooth ב-ChromeOS‏ (19), מכשירי קלט מחוברים ב-ChromeOS‏ (20), ספקי נתונים ב-ChromeOS‏ (21), מקלדת וירטואלית ב-ChromeOS‏ (22), בריאות הרשת ב-ChromeOS‏ (23).
    פרטים נוספים זמינים במאמר העזרה.

גוף התשובה

תשובה להפעלת פקודה.

אם הפעולה מצליחה, גוף התגובה מכיל נתונים במבנה הבא:

ייצוג ב-JSON 
{
  "commandId": string
}
שדות
commandId

string (int64 format)

המזהה הייחודי של הפקודה שהונפקה, המשמש לאחזור סטטוס הפקודה.

היקפי הרשאה

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

  • https://www.googleapis.com/auth/admin.directory.device.chromeos

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