REST Resource: customers.profiles.commands

Tài nguyên: ChromeBrowserProfileCommand

Biểu thị lệnh từ xa cho một hồ sơ trình duyệt Chrome.

Biểu diễn dưới dạng JSON
{
  "name": string,
  "commandType": string,
  "payload": {
    object
  },
  "commandState": enum (CommandState),
  "commandResult": {
    object (CommandResult)
  },
  "issueTime": string,
  "validDuration": string
}
Trường
name

string

Giá trị nhận dạng. Định dạng: customers/{customer_id}/profiles/{profilePermanentId}/commands/{command_id}

commandType

string

Bắt buộc. Loại lệnh từ xa. Loại lệnh duy nhất được hỗ trợ là "clearBrowsingData".

payload

object (Struct format)

Bắt buộc. Tải trọng của lệnh từ xa. Trọng tải cho lệnh "clearBrowsingData" hỗ trợ: – các trường "clearCache" và "clearCookies" – các giá trị thuộc loại boolean.

commandState

enum (CommandState)

Chỉ có đầu ra. Trạng thái của lệnh từ xa.

commandResult

object (CommandResult)

Chỉ có đầu ra. Kết quả của lệnh từ xa.

issueTime

string (Timestamp format)

Chỉ có đầu ra. Dấu thời gian của lệnh từ xa được phát hành.

Sử dụng RFC 3339, trong đó đầu ra được tạo sẽ luôn được chuẩn hoá theo Z và sử dụng 0, 3, 6 hoặc 9 chữ số thập phân. Các độ dời khác ngoài "Z" cũng được chấp nhận. Ví dụ: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" hoặc "2014-10-02T15:01:23+05:30".

validDuration

string (Duration format)

Chỉ có đầu ra. Thời lượng hợp lệ của lệnh từ xa.

Thời lượng tính bằng giây, có tối đa 9 chữ số thập phân, kết thúc bằng "s". Ví dụ: "3.5s".

CommandState

Các trạng thái có thể có của một lệnh.

Enum
COMMAND_STATE_UNSPECIFIED Biểu thị trạng thái lệnh chưa xác định.
PENDING Đại diện cho một lệnh ở trạng thái chờ xử lý.
EXPIRED Đại diện cho một lệnh đã hết hạn.
EXECUTED_BY_CLIENT Biểu thị một lệnh đã được ứng dụng thực thi.

CommandResult

Kết quả của việc thực thi một lệnh.

Biểu diễn dưới dạng JSON
{
  "resultType": enum (CommandResultType),
  "clientExecutionTime": string,
  "resultCode": string
}
Trường
resultType

enum (CommandResultType)

Chỉ có đầu ra. Loại kết quả của lệnh từ xa.

clientExecutionTime

string (Timestamp format)

Chỉ có đầu ra. Dấu thời gian của quá trình thực thi lệnh từ xa của ứng dụng.

Sử dụng RFC 3339, trong đó đầu ra được tạo sẽ luôn được chuẩn hoá theo Z và sử dụng 0, 3, 6 hoặc 9 chữ số thập phân. Các độ dời khác ngoài "Z" cũng được chấp nhận. Ví dụ: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" hoặc "2014-10-02T15:01:23+05:30".

resultCode

string

Chỉ có đầu ra. Mã kết quả cho biết loại lỗi hoặc trạng thái thành công của lệnh.

CommandResultType

Các loại kết quả có thể có của một lệnh.

Enum
COMMAND_RESULT_TYPE_UNSPECIFIED Biểu thị kết quả lệnh không xác định.
IGNORED Biểu thị một lệnh có kết quả bị bỏ qua.
FAILURE Biểu thị một lệnh không thành công.
SUCCESS Biểu thị một lệnh đã thành công.

Phương thức

create

Tạo lệnh từ xa cho hồ sơ trình duyệt Chrome.

get

Nhận lệnh từ xa về hồ sơ trình duyệt Chrome.

list

Liệt kê các lệnh từ xa của một hồ sơ trình duyệt Chrome.