Method: customer.devices.chromeos.issueCommand

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

בקשת HTTP

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

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

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

פרמטרים
customerId

string

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

string

אי אפשר לשנות אותו. המזהה של מכשיר ChromeOS.

גוף הבקשה

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

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

enum (CommandType)

סוג הפקודה.
payload

string

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

  • ‫SET_VOLUME: המטען הייעודי (payload) הוא אובייקט JSON במחרוזת, מהצורה: { "volume": 50 }. עוצמת הקול צריכה להיות מספר שלם בטווח [0,100].
  • ‫DEVICE_START_CRD_SESSION: המטען הייעודי (payload) הוא אובייקט JSON מומר למחרוזת (stringified) מהצורה: { "ackedUserPresence": true, "crdSessionType": string }. ‏ackedUserPresence הוא ערך בוליאני. כברירת מחדל, ackedUserPresence מוגדר כ-false. כדי להתחיל סשן של Chrome Remote Desktop במכשיר פעיל, צריך להגדיר את ackedUserPresence ל-true. crdSessionType יכול לבחור רק מבין הערכים private (שמעניק לאדמין המרוחק שליטה בלעדית במכשיר ChromeOS) או shared (שמאפשר לאדמין ולמשתמש המקומי לחלוק את השליטה במכשיר ChromeOS). אם לא מגדירים את הפרמטר הזה, ערך ברירת המחדל של crdSessionType הוא shared. אפשר להשתמש בפקודה FETCH_CRD_AVAILABILITY_INFO כדי לקבוע אילו סוגי סשנים זמינים במכשיר.
  • ‫REBOOT: המטען הייעודי (payload) הוא אובייקט JSON בפורמט מחרוזת: { "user_session_delay_seconds": 300 }. הערך user_session_delay_seconds הוא מספר השניות להמתנה לפני הפעלה מחדש של המכשיר אם משתמש מחובר. הערך צריך להיות מספר שלם בטווח [0,300]. אם המטען הייעודי לא קיים להפעלה מחדש, ברירת המחדל היא 0 עיכוב. הערה: המדיניות הזו חלה רק אם משתמש אמיתי מחובר לחשבון, כולל אורח. אם המכשיר נמצא במסך הכניסה או במצב קיוסק, המערכת לא תתחשב בערך והמכשיר יופעל מחדש באופן מיידי.
  • ‫FETCH_SUPPORT_PACKET: המטען הייעודי (payload) הוא אובייקט JSON מומר לפורמט מחרוזת (stringified) בצורה הבאה: {"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), קובץ dump לניפוי באגים של כרטיסי רשת אלחוטיים של Intel‏ (7), אירועי מגע (8), ‏ Lacros‏ (9), פרטי מערכת Lacros‏ (10), יומנים של ChromeOS Flex‏ (11), פרטי DBus‏ (12), נתיבי רשת של ChromeOS‏ (13), יומנים של ChromeOS Shill (מנהל חיבורים) (14), מדיניות (15), מצב המערכת ויומנים של ChromeOS‏ (16), יומני מערכת של ChromeOS‏ (17), יומני משתמש של ChromeOS Chrome‏ (18), ‏ ChromeOS Bluetooth‏ (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

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