REST Resource: customers.profiles.commands

منبع: ChromeBrowserProfileCommand

نمایشی از یک فرمان از راه دور برای نمایه مرورگر کروم.

نمایش 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) مربوط به فرمان از راه دور.

بار مفید دستور "clearBrowsingData" از موارد زیر پشتیبانی می‌کند: - فیلدهای "clearCache" و "clearCookies" - مقادیر از نوع بولی.

مقدار داده‌ی مربوط به "extensionUpdateCheck" باید خالی باشد.

commandState

enum ( CommandState )

فقط خروجی. وضعیت فرمان از راه دور.

commandResult

object ( CommandResult )

فقط خروجی. نتیجه دستور از راه دور.

issueTime

string ( Timestamp format)

فقط خروجی. مهر زمانی صدور فرمان از راه دور.

از RFC 3339 استفاده می‌کند، که در آن خروجی تولید شده همیشه به صورت Z-normalized خواهد بود و از ارقام کسری ۰، ۳، ۶ یا ۹ استفاده می‌کند. آفست‌های غیر از "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" .

حالت فرماندهی

حالت‌های ممکن یک دستور

انوم‌ها
COMMAND_STATE_UNSPECIFIED نشان دهنده یک حالت دستور نامشخص است.
PENDING نشان دهنده یک دستور در حالت انتظار است.
EXPIRED نشان دهنده دستوری است که منقضی شده است.
EXECUTED_BY_CLIENT نشان دهنده دستوری است که توسط کلاینت اجرا شده است.

نتیجه فرمان

نتیجه اجرای یک دستور.

نمایش JSON 
{
  "resultType": enum (CommandResultType),
  "clientExecutionTime": string,
  "resultCode": string
}
فیلدها
resultType

enum ( CommandResultType )

فقط خروجی. نوع نتیجه فرمان از راه دور.

clientExecutionTime

string ( Timestamp format)

فقط خروجی. مهر زمانی اجرای دستور از راه دور توسط کلاینت.

از RFC 3339 استفاده می‌کند، که در آن خروجی تولید شده همیشه به صورت Z-normalized خواهد بود و از ارقام کسری ۰، ۳، ۶ یا ۹ استفاده می‌کند. آفست‌های غیر از "Z" نیز پذیرفته می‌شوند. مثال‌ها: "2014-10-02T15:01:23Z" ، "2014-10-02T15:01:23.045123456Z" یا "2014-10-02T15:01:23+05:30" .

resultCode

string

فقط خروجی. کد نتیجه که نوع خطا یا موفقیت دستور را نشان می‌دهد.

نوع نتیجه فرمان

انواع ممکن نتیجه یک دستور.

انوم‌ها
COMMAND_RESULT_TYPE_UNSPECIFIED نتیجه یک دستور نامشخص را نشان می‌دهد.
IGNORED نشان دهنده دستوری است که نتیجه آن نادیده گرفته شده است.
FAILURE نشان دهنده یک دستور ناموفق است.
SUCCESS نشان دهنده یک دستور موفق است.

روش‌ها

create

 یک دستور از راه دور برای پروفایل مرورگر کروم ایجاد می‌کند.

get

 یک دستور از راه دور برای پروفایل مرورگر کروم دریافت می‌کند.

list

 دستورات از راه دور یک پروفایل مرورگر کروم را فهرست می‌کند.