REST Resource: customer.devices.chromeos.commands

משאב: DirectoryChromeosdevicesCommand

מידע לגבי פקודה שהונפקה למכשיר.

ייצוג ב-JSON 
{
  "commandId": string,
  "type": enum (CommandType),
  "issueTime": string,
  "state": enum (State),
  "commandExpireTime": string,
  "commandResult": {
    object (DirectoryChromeosdevicesCommandResult)
  },
  "payload": string
}
שדות
commandId

string (int64 format)

מזהה ייחודי של פקודה למכשיר.
type

enum (CommandType)

סוג הפקודה.
issueTime

string (Timestamp format)

חותמת הזמן שבה האדמין הוציא את הפקודה.

הפונקציה משתמשת ב-RFC 3339, והפלט שנוצר תמיד יהיה מנורמל ל-Z וישתמש ב-0, 3, 6 או 9 ספרות חלקיות. אפשר להשתמש גם בהיסטים אחרים חוץ מ-Z. דוגמאות: "2014-10-02T15:01:23Z", ‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".
state

enum (State)

מציין את מצב הפקודה.
commandExpireTime

string (Timestamp format)

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

הפונקציה משתמשת ב-RFC 3339, והפלט שנוצר תמיד יהיה מנורמל ל-Z וישתמש ב-0, 3, 6 או 9 ספרות חלקיות. אפשר להשתמש גם בהיסטים אחרים חוץ מ-Z. דוגמאות: "2014-10-02T15:01:23Z", ‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".
commandResult

object (DirectoryChromeosdevicesCommandResult)

התוצאה של הרצת הפקודה.
payload

string

המטען הייעודי (payload) שצוין בפקודה, אם יש כזה.

CommandType

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

טיפוסים בני מנייה (enum)
COMMAND_TYPE_UNSPECIFIED לא צוין סוג הפקודה.
REBOOT מפעילים מחדש את המכשיר. אפשר להנפיק אותם למכשירים במצב קיוסק, למכשירים במצב גלישה מנוהלת כאורח ולמכשירים רגילים עם ChromeOS בגרסה 113 ואילך.
TAKE_A_SCREENSHOT מצלמים את המסך של המכשיר. האפשרות הזו זמינה רק אם המכשיר נמצא במצב קיוסק.
SET_VOLUME הגדרת עוצמת הקול של המכשיר. אפשר להנפיק אותם רק למכשירי קיוסק ולמכשירים שהופעלה בהם גלישה מנוהלת כאורחים.
WIPE_USERS איפוס של נתוני כל המשתמשים במכשיר. הפעלת הפקודה הזו במכשיר תסיר את כל נתוני פרופיל המשתמש, אבל תשמור את מדיניות המכשיר ואת הרישום שלו.
REMOTE_POWERWASH מבצע איפוס של המכשיר באמצעות הפעלה של Powerwash. הפעלת הפקודה הזו במכשיר תסיר את כל הנתונים, כולל מדיניות המשתמש, מדיניות המכשיר ומדיניות הרישום. אזהרה: פעולה זו תחזיר את המכשיר להגדרות היצרן שלו ללא רישום, אלא אם המכשיר כפוף לחובת רישום מחדש או לרישום אוטומטי מחדש. חשוב להיזהר, כי אי אפשר לבטל את הפעולה הזו.
DEVICE_START_CRD_SESSION התחלת סשן של Chrome Remote Desktop.
CAPTURE_LOGS תיעוד יומני המערכת של מכשיר קיוסק. אפשר להוריד את היומנים מהקישור downloadUrl שמופיע בשדה deviceFiles של chromeosdevices
FETCH_CRD_AVAILABILITY_INFO מאחזר את סוגי הסשנים הזמינים של Chrome Remote Desktop (פרטי או משותף) שאפשר להשתמש בהם כדי להתחבר למכשיר מרחוק.
FETCH_SUPPORT_PACKET שליפת חבילת תמיכה ממכשיר מרחוק. חבילת התמיכה היא ארכיון ZIP שמכיל יומנים שונים של המערכת ונתוני ניפוי באגים ממכשיר ChromeOS. אפשר להוריד את חבילת התמיכה מהקישור downloadURL שמופיע בשדה deviceFiles של chromeosdevices

מדינה

מייצג את המצב של הפקודה שהונפקה.

טיפוסים בני מנייה (enum)
STATE_UNSPECIFIED לא צוין סטטוס הפקודה.
PENDING פקודה שלא פג תוקפה ועדיין לא נשלחה ללקוח.
EXPIRED הפקודה לא בוצעה על ידי הלקוח בתוך פרק הזמן הצפוי.
CANCELLED הפקודה בוטלה על ידי האדמין בזמן שהיא הייתה במצב 'בהמתנה'.
SENT_TO_CLIENT הפקודה נשלחה ללקוח.
ACKED_BY_CLIENT הלקוח הגיב שהוא קיבל את הפקודה.
EXECUTED_BY_CLIENT הלקוח ביצע את הפקודה בהצלחה או לא.

DirectoryChromeosdevicesCommandResult

התוצאה של הפעלת פקודה.

ייצוג ב-JSON 
{
  "result": enum (CommandResultType),
  "executeTime": string,
  "errorMessage": string,
  "commandResultPayload": string
}
שדות
result

enum (CommandResultType)

התוצאה של הפקודה.
executeTime

string (Timestamp format)

השעה שבה הפקודה בוצעה או שהביצוע שלה נכשל.

הפונקציה משתמשת ב-RFC 3339, והפלט שנוצר תמיד יהיה מנורמל ל-Z וישתמש ב-0, 3, 6 או 9 ספרות חלקיות. אפשר להשתמש גם בהיסטים אחרים חוץ מ-Z. דוגמאות: "2014-10-02T15:01:23Z", ‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".
errorMessage

string

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

string

מטען הייעודי (payload) של תוצאת הפקודה. הפקודות הבאות מחזירות מטען ייעודי (payload):

  • ‫DEVICE_START_CRD_SESSION: המטען הייעודי (payload) הוא אובייקט JSON שהומר למחרוזת בפורמט: { "url": url }. כתובת ה-URL שצוינה מקשרת להפעלה של Chrome Remote Desktop ונדרש אימות באמצעות email שמשויך רק להנפקת הפקודה.
  • ‫FETCH_CRD_AVAILABILITY_INFO: המטען הייעודי (payload) הוא אובייקט JSON שהומר למחרוזת, בפורמט: { "deviceIdleTimeInSeconds": number, "userSessionType": string, "remoteSupportAvailability": string, "remoteAccessAvailability": string }. השדה remoteSupportAvailability מוגדר כ-AVAILABLE אם סשן shared CRD למכשיר זמין. השדה remoteAccessAvailability מוגדר כ-AVAILABLE אם סשן CRD של private זמין למכשיר.

CommandResultType

סוג התוצאה של הפקודה.

טיפוסים בני מנייה (enum)
COMMAND_RESULT_TYPE_UNSPECIFIED תוצאת הפקודה לא צוינה.
IGNORED המערכת התעלמה מהפקודה כי היא מיושנת.
FAILURE הפקודה לא בוצעה בהצלחה.
SUCCESS הפקודה בוצעה בהצלחה.

Methods

get

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