REST Resource: customers.profiles.commands

מקור מידע: ChromeBrowserProfileCommand

ייצוג של פקודה מרוחקת לפרופיל בדפדפן Chrome.

ייצוג JSON 
{
  "name": string,
  "commandType": string,
  "payload": {
    object
  },
  "commandState": enum (CommandState),
  "commandResult": {
    object (CommandResult)
  },
  "issueTime": string,
  "validDuration": string
}
שדות
name

string

מזהה. פורמט: customers/{customerId}/profiles/{profilePermanentId}/commands/{command_id}
commandType

string

חובה. סוג הפקודה מרחוק. הפקודות הנתמכות: clearBrowsingData ו-extensionUpdateCheck.
payload

object (Struct format)

חובה. המטען הייעודי (payload) של הפקודה מרחוק.

המטען הייעודי (payload) של הפקודה clearBrowsingData תומך ב: - השדות clearCache ו-clearCookies - ערכים מסוג בוליאני.

המטען הייעודי (payload) של extensionUpdateCheck צריך להיות ריק.
commandState

enum (CommandState)

פלט בלבד. המצב של הפקודה מרחוק.
commandResult

object (CommandResult)

פלט בלבד. התוצאה של הפקודה מרחוק.
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".
validDuration

string (Duration format)

פלט בלבד. משך הזמן שתוקף הפקודה מרחוק.

משך זמן בשניות עם עד תשע ספרות אחרי הנקודה העשרונית, שמסתיים ב-'s'. דוגמה: "3.5s".

CommandState

המצבים האפשריים של פקודה.

טיפוסים בני מנייה (enum)
COMMAND_STATE_UNSPECIFIED מייצג מצב לא מוגדר של פקודה.
PENDING מייצג פקודה במצב המתנה.
EXPIRED מייצג פקודה שתוקפה פג.
EXECUTED_BY_CLIENT מייצג פקודה שהופעלה על ידי הלקוח.

CommandResult

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

ייצוג JSON 
{
  "resultType": enum (CommandResultType),
  "clientExecutionTime": string,
  "resultCode": string
}
שדות
resultType

enum (CommandResultType)

פלט בלבד. סוג התוצאה של הפקודה מרחוק.
clientExecutionTime

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".
resultCode

string

פלט בלבד. קוד התוצאה שמציין את סוג השגיאה או את הצלחת הפקודה.

CommandResultType

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

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

Methods

create

 יוצר פקודה מרחוק לפרופיל בדפדפן Chrome.

get

 מקבל פקודה מרחוק לפרופיל בדפדפן Chrome.

list

 מציג רשימה של פקודות מרחוק של פרופיל בדפדפן Chrome.