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)

ต้องระบุ เพย์โหลดของคำสั่งระยะไกล เพย์โหลดสําหรับคําสั่ง "clearBrowsingData" รองรับฟิลด์ "clearCache" และ "clearCookies" ซึ่งเป็นค่าประเภทบูลีน
commandState

enum (CommandState)

เอาต์พุตเท่านั้น สถานะของคำสั่งระยะไกล
commandResult

object (CommandResult)

เอาต์พุตเท่านั้น ผลลัพธ์ของคำสั่งจากระยะไกล
issueTime

string (Timestamp format)

เอาต์พุตเท่านั้น การประทับเวลาของคำสั่งระยะไกล

ใช้ RFC 3339 ซึ่งเอาต์พุตที่สร้างขึ้นจะเป็นรูปแบบ Z-normalized เสมอ และใช้ตัวเลขทศนิยม 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)

เอาต์พุตเท่านั้น ระยะเวลาที่ถูกต้องของคำสั่งระยะไกล

ระยะเวลาเป็นวินาทีที่มีเศษทศนิยมได้สูงสุด 9 หลัก โดยลงท้ายด้วย 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-normalized เสมอ และใช้ตัวเลขทศนิยม 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 แสดงถึงคำสั่งที่ดำเนินการสำเร็จ

เมธอด

create

 สร้างคําสั่งจากระยะไกลของโปรไฟล์เบราว์เซอร์ Chrome

get

 รับคําสั่งจากระยะไกลของโปรไฟล์เบราว์เซอร์ Chrome

list

 แสดงรายการคำสั่งระยะไกลของโปรไฟล์เบราว์เซอร์ Chrome