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)

ต้องระบุ เพย์โหลดของคำสั่งจากระยะไกล

เพย์โหลดสำหรับคำสั่ง "clearBrowsingData" รองรับ - ฟิลด์ "clearCache" และ "clearCookies" - ค่าประเภทบูลีน

เพย์โหลดสำหรับ "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)

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

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