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/{customer_id}/profiles/{profilePermanentId}/commands/{command_id}
commandType

string

חובה. הסוג של הפקודה מרחוק. הערך היחיד של commandType שנתמך הוא 'clearBrowsingData'.
payload

object (Struct format)

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

enum (CommandState)

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

object (CommandResult)

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

string (Timestamp format)

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

הפורמט הזה משתמש ב-RFC 3339, שבו הפלט שנוצר תמיד יהיה מנורמלי לפי Z וישמש בספרות עשרוניות של 0, 3, 6 או 9. אפשר להשתמש גם בשינויים (offsets) אחרים מלבד '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. אפשר להשתמש גם בשינויים (offsets) אחרים מלבד '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.