Method: enterprises.devices.issueCommand

Ra lệnh cho một thiết bị. Tài nguyên Operation được trả về chứa Command trong trường metadata. Sử dụng phương thức thao tác lấy để biết trạng thái của lệnh.

Yêu cầu HTTP

POST https://androidmanagement.googleapis.com/v1/{name=enterprises/*/devices/*}:issueCommand

URL sử dụng cú pháp Chuyển mã gRPC.

Tham số đường dẫn

Thông số
name

string

Tên của thiết bị ở dạng enterprises/{enterpriseId}/devices/{deviceId}.

Nội dung yêu cầu

Nội dung yêu cầu chứa một bản sao của Command.

Nội dung phản hồi

Nếu thành công, nội dung phản hồi sẽ chứa một phiên bản của Operation.

Phạm vi uỷ quyền

Yêu cầu phạm vi OAuth sau:

  • https://www.googleapis.com/auth/androidmanagement

Để biết thêm thông tin, hãy xem OAuth 2.0 Overview.

Lệnh

Một lệnh.

Biểu diễn dưới dạng JSON 
{
  "type": enum (CommandType),
  "createTime": string,
  "duration": string,
  "userName": string,
  "errorCode": enum (CommandErrorCode),
  "newPassword": string,
  "resetPasswordFlags": [
    enum (ResetPasswordFlag)
  ],

  // Union field params can be only one of the following:
  "clearAppsDataParams": {
    object (ClearAppsDataParams)
  },
  "startLostModeParams": {
    object (StartLostModeParams)
  },
  "stopLostModeParams": {
    object (StopLostModeParams)
  },
  "requestDeviceInfoParams": {
    object (RequestDeviceInfoParams)
  }
  // End of list of possible types for union field params.

  // Union field status can be only one of the following:
  "clearAppsDataStatus": {
    object (ClearAppsDataStatus)
  },
  "startLostModeStatus": {
    object (StartLostModeStatus)
  },
  "stopLostModeStatus": {
    object (StopLostModeStatus)
  },
  "requestDeviceInfoStatus": {
    object (RequestDeviceInfoStatus)
  }
  // End of list of possible types for union field status.
}
Trường
type

enum (CommandType)

Loại lệnh.
createTime

string (Timestamp format)

Dấu thời gian tạo lệnh. Dấu thời gian được máy chủ tạo tự độ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".
duration

string (Duration format)

Thời lượng hiệu lực của lệnh. Lệnh sẽ hết hạn nếu thiết bị không thực thi trong khoảng thời gian này. Khoảng thời gian mặc định nếu bạn không chỉ định là 10 phút. Không có thời lượng tối đa.

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".
userName

string

Tên tài nguyên của người dùng sở hữu thiết bị ở dạng enterprises/{enterpriseId}/users/{userId}. Mã này được máy chủ tạo tự động dựa trên thiết bị mà lệnh được gửi đến.
errorCode

enum (CommandErrorCode)

Nếu lệnh không thành công, mã lỗi sẽ giải thích lý do không thành công. Giá trị này không được đặt khi lệnh bị phương thức gọi huỷ. Để suy luận về lỗi lệnh, hãy ưu tiên các trường theo thứ tự sau (ưu tiên nhất trước tiên): 1. Các trường dành riêng cho lệnh như clearAppsDataStatus, startLostModeStatus hoặc tương tự, nếu có. 2. Trường này, nếu được đặt. 3. Trường error chung trong Operation gói lệnh.
newPassword

string

Đối với các lệnh thuộc loại RESET_PASSWORD, bạn có thể chỉ định mật khẩu mới. Lưu ý: Mật khẩu mới phải có độ dài tối thiểu là 6 ký tự nếu là mật khẩu số trong trường hợp thiết bị chạy Android 14. Nếu không, lệnh sẽ không thành công với INVALID_VALUE.
resetPasswordFlags[]

enum (ResetPasswordFlag)

Đối với các lệnh thuộc loại RESET_PASSWORD, bạn có thể chỉ định cờ (flag).

Trường hợp hợp nhất params. Các thông số dành riêng cho lệnh. Xin lưu ý rằng một số lệnh không sử dụng tính năng này, cụ thể là LOCK, RESET_PASSWORD, REBOOT và RELINQUISH_OWNERSHIP. Trong tương lai, các lệnh này cũng có thể sử dụng tính năng này.

Nếu bạn đặt giá trị này, thì không được đặt các trường new_password và reset_password_flags. params chỉ có thể là một trong những loại sau:
clearAppsDataParams

object (ClearAppsDataParams)

Các tham số cho lệnh CLEAR_APP_DATA để xoá dữ liệu của các ứng dụng đã chỉ định khỏi thiết bị. Vui lòng xem ClearAppsDataParams. Nếu bạn đặt thuộc tính này, bạn không nên đặt type. Trong trường hợp này, máy chủ sẽ tự động đặt giá trị này thành CLEAR_APP_DATA. Bạn cũng có thể đặt rõ ràng type thành CLEAR_APP_DATA.
startLostModeParams

object (StartLostModeParams)

Các tham số cho lệnh START_LOST_MODE để đưa thiết bị vào chế độ mất. Vui lòng xem StartLostModeParams. Nếu bạn đặt thuộc tính này, bạn không nên đặt type. Trong trường hợp này, máy chủ sẽ tự động đặt giá trị này thành START_LOST_MODE. Bạn cũng có thể đặt rõ ràng type thành START_LOST_MODE.
stopLostModeParams

object (StopLostModeParams)

Các tham số cho lệnh STOP_LOST_MODE để đưa thiết bị ra khỏi chế độ thất lạc. Vui lòng xem StopLostModeParams. Nếu bạn đặt thuộc tính này, bạn không nên đặt type. Trong trường hợp này, máy chủ sẽ tự động đặt giá trị này thành STOP_LOST_MODE. Bạn cũng có thể đặt rõ ràng type thành STOP_LOST_MODE.
requestDeviceInfoParams

object (RequestDeviceInfoParams)

Không bắt buộc. Các tham số cho lệnh REQUEST_DEVICE_INFO để nhận thông tin liên quan đến thiết bị. Nếu bạn đặt thuộc tính này, bạn không nên đặt type. Trong trường hợp này, máy chủ sẽ tự động đặt giá trị này thành REQUEST_DEVICE_INFO . Bạn cũng có thể đặt rõ ràng type thành REQUEST_DEVICE_INFO.
Trường hợp hợp nhất status. Trạng thái dành riêng cho lệnh. Xin lưu ý rằng một số lệnh không sử dụng tính năng này, cụ thể là LOCK, RESET_PASSWORD, REBOOT và RELINQUISH_OWNERSHIP. Trong tương lai, các lệnh này cũng có thể sử dụng tính năng này. status chỉ có thể là một trong những loại sau:
clearAppsDataStatus

object (ClearAppsDataStatus)

Chỉ có đầu ra. Trạng thái của lệnh CLEAR_APP_DATA để xoá dữ liệu của các ứng dụng đã chỉ định khỏi thiết bị. Vui lòng xem ClearAppsDataStatus.
startLostModeStatus

object (StartLostModeStatus)

Chỉ có đầu ra. Trạng thái của lệnh START_LOST_MODE để đặt thiết bị vào chế độ mất. Vui lòng xem StartLostModeStatus.
stopLostModeStatus

object (StopLostModeStatus)

Chỉ có đầu ra. Trạng thái của lệnh STOP_LOST_MODE để đưa thiết bị ra khỏi chế độ thất lạc. Vui lòng xem StopLostModeStatus.
requestDeviceInfoStatus

object (RequestDeviceInfoStatus)

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

CommandType

Các loại lệnh.

Enum
COMMAND_TYPE_UNSPECIFIED Bạn không được phép sử dụng giá trị này.
LOCK Khoá thiết bị, như thể thời gian chờ màn hình khoá đã hết.
RESET_PASSWORD Đặt lại mật khẩu của người dùng.
REBOOT Khởi động lại thiết bị. Chỉ được hỗ trợ trên các thiết bị được quản lý đầy đủ chạy Android 7.0 (API cấp 24) trở lên.
RELINQUISH_OWNERSHIP Xoá hồ sơ công việc và tất cả chính sách khỏi thiết bị Android 8.0 trở lên thuộc sở hữu của công ty, để chuyển thiết bị sang mục đích sử dụng cá nhân. Các ứng dụng và dữ liệu liên kết với(các) hồ sơ cá nhân sẽ được giữ nguyên. Thiết bị sẽ bị xoá khỏi máy chủ sau khi xác nhận lệnh.
CLEAR_APP_DATA Xoá dữ liệu ứng dụng của các ứng dụng được chỉ định. Tính năng này được hỗ trợ trên Android 9 trở lên. Xin lưu ý rằng một ứng dụng có thể lưu trữ dữ liệu bên ngoài dữ liệu ứng dụng, chẳng hạn như trong bộ nhớ ngoài hoặc trong từ điển người dùng. Xem thêm clearAppsDataParams.
START_LOST_MODE Đặt thiết bị ở chế độ mất. Chỉ hỗ trợ trên các thiết bị được quản lý đầy đủ hoặc thiết bị do tổ chức sở hữu có hồ sơ được quản lý. Xem thêm startLostModeParams.
STOP_LOST_MODE Đưa thiết bị ra khỏi chế độ thất lạc. Chỉ hỗ trợ trên các thiết bị được quản lý đầy đủ hoặc thiết bị do tổ chức sở hữu có hồ sơ được quản lý. Xem thêm stopLostModeParams.
REQUEST_DEVICE_INFO Yêu cầu thông tin liên quan đến thiết bị.

CommandErrorCode

Mã lỗi lệnh. Đây là trường chỉ có thể đọc do máy chủ điền.

Enum
COMMAND_ERROR_CODE_UNSPECIFIED Không có lỗi nào.
UNKNOWN Đã xảy ra lỗi không xác định.
API_LEVEL Cấp độ API của thiết bị không hỗ trợ lệnh này.
MANAGEMENT_MODE Chế độ quản lý (chủ sở hữu hồ sơ, chủ sở hữu thiết bị, v.v.) không hỗ trợ lệnh này.
INVALID_VALUE Lệnh có giá trị tham số không hợp lệ.
UNSUPPORTED Thiết bị không hỗ trợ lệnh này. Việc cập nhật Chính sách thiết bị Android lên phiên bản mới nhất có thể giải quyết vấn đề này.

ResetPasswordFlag

Các cờ có thể dùng cho loại lệnh RESET_PASSWORD.

Enum
RESET_PASSWORD_FLAG_UNSPECIFIED Giá trị này sẽ bị bỏ qua.
REQUIRE_ENTRY Không cho phép quản trị viên khác thay đổi mật khẩu một lần nữa cho đến khi người dùng nhập mật khẩu.
DO_NOT_ASK_CREDENTIALS_ON_BOOT Không yêu cầu thông tin xác thực của người dùng khi khởi động thiết bị.
LOCK_NOW Khoá thiết bị sau khi đặt lại mật khẩu.

ClearAppsDataParams

Các tham số liên kết với lệnh CLEAR_APP_DATA để xoá dữ liệu của các ứng dụng được chỉ định khỏi thiết bị.

Biểu diễn dưới dạng JSON 
{
  "packageNames": [
    string
  ]
}
Trường
packageNames[]

string

Tên gói của các ứng dụng có dữ liệu sẽ bị xoá khi lệnh được thực thi.

StartLostModeParams

Các tham số liên kết với lệnh START_LOST_MODE để đưa thiết bị vào chế độ mất. Bạn phải cung cấp ít nhất một trong các tham số (không bao gồm tên tổ chức) để thiết bị chuyển sang chế độ mất.

Biểu diễn dưới dạng JSON 
{
  "lostMessage": {
    object (UserFacingMessage)
  },
  "lostPhoneNumber": {
    object (UserFacingMessage)
  },
  "lostEmailAddress": string,
  "lostStreetAddress": {
    object (UserFacingMessage)
  },
  "lostOrganization": {
    object (UserFacingMessage)
  }
}
Trường
lostMessage

object (UserFacingMessage)

Thông báo hiển thị cho người dùng khi thiết bị ở chế độ thất lạc.
lostPhoneNumber

object (UserFacingMessage)

Số điện thoại sẽ được gọi khi thiết bị ở chế độ mất và người dùng nhấn vào nút chủ sở hữu cuộc gọi.
lostEmailAddress

string

Địa chỉ email hiển thị cho người dùng khi thiết bị ở chế độ thất lạc.
lostStreetAddress

object (UserFacingMessage)

Địa chỉ đường phố hiển thị cho người dùng khi thiết bị ở chế độ thất lạc.
lostOrganization

object (UserFacingMessage)

Tên tổ chức hiển thị cho người dùng khi thiết bị ở chế độ thất lạc.

StopLostModeParams

Loại này không có trường nào.

Các tham số liên kết với lệnh STOP_LOST_MODE để đưa thiết bị ra khỏi chế độ thất lạc.

RequestDeviceInfoParams

Các tham số liên kết với lệnh REQUEST_DEVICE_INFO để lấy thông tin liên quan đến thiết bị.

Biểu diễn dưới dạng JSON 
{
  "deviceInfo": enum (DeviceInfo)
}
Trường
deviceInfo

enum (DeviceInfo)

Bắt buộc. Loại thông tin thiết bị cần yêu cầu.

DeviceInfo

Loại thông tin thiết bị cần yêu cầu.

Enum
DEVICE_INFO_UNSPECIFIED Bạn không được phép sử dụng giá trị này.
EID Yêu cầu giá trị nhận dạng cho eSIM. Người dùng sẽ được yêu cầu phê duyệt việc tiết lộ thông tin trước khi có thể trả về kết quả. Nếu người dùng không phê duyệt thông tin công bố, USER_DECLINED sẽ được trả về. Tính năng này chỉ được hỗ trợ cho các thiết bị thuộc sở hữu cá nhân có hồ sơ công việc và chạy Android phiên bản 13 trở lên.

ClearAppsDataStatus

Trạng thái của lệnh CLEAR_APP_DATA để xoá dữ liệu của các ứng dụng đã chỉ định khỏi thiết bị.

Biểu diễn dưới dạng JSON 
{
  "results": {
    string: {
      object (PerAppResult)
    },
    ...
  }
}
Trường
results

map (key: string, value: object (PerAppResult))

Kết quả trên mỗi ứng dụng, một mối liên kết từ tên gói đến kết quả xoá tương ứng.

Một đối tượng chứa danh sách các cặp "key": value. Ví dụ: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

PerAppResult

Kết quả của một lần thử xoá dữ liệu của một ứng dụng.

Biểu diễn dưới dạng JSON 
{
  "clearingResult": enum (ClearingResult)
}
Trường
clearingResult

enum (ClearingResult)

Kết quả của một lần thử xoá dữ liệu của một ứng dụng.

ClearingResult

Kết quả của một lần thử xoá dữ liệu của một ứng dụng.

Enum
CLEARING_RESULT_UNSPECIFIED Kết quả không xác định.
SUCCESS Đã xoá thành công dữ liệu của ứng dụng này.
APP_NOT_FOUND Không thể xoá dữ liệu của ứng dụng này vì không tìm thấy ứng dụng.
APP_PROTECTED Không thể xoá dữ liệu của ứng dụng này vì ứng dụng được bảo vệ. Ví dụ: điều này có thể áp dụng cho các ứng dụng quan trọng đối với hoạt động của thiết bị, chẳng hạn như Cửa hàng Google Play.
API_LEVEL Không thể xoá dữ liệu của ứng dụng này vì cấp độ API của thiết bị không hỗ trợ lệnh này.

StartLostModeStatus

Trạng thái của lệnh START_LOST_MODE để đặt thiết bị vào chế độ mất.

Biểu diễn dưới dạng JSON 
{
  "status": enum (Status)
}
Trường
status

enum (Status)

Trạng thái. Vui lòng xem StartLostModeStatus.

Trạng thái

Trạng thái. Vui lòng xem StartLostModeStatus.

Enum
STATUS_UNSPECIFIED Không xác định. Giá trị này không được sử dụng.
SUCCESS Thiết bị đã được chuyển sang chế độ thất lạc.
RESET_PASSWORD_RECENTLY Không thể đặt thiết bị vào chế độ thất lạc vì gần đây quản trị viên đã đặt lại mật khẩu của thiết bị.
USER_EXIT_LOST_MODE_RECENTLY Không thể chuyển thiết bị sang chế độ thất lạc vì người dùng đã thoát khỏi chế độ thất lạc gần đây.
ALREADY_IN_LOST_MODE Thiết bị đã ở chế độ thất lạc.

StopLostModeStatus

Trạng thái của lệnh STOP_LOST_MODE để đưa thiết bị ra khỏi chế độ thất lạc.

Biểu diễn dưới dạng JSON 
{
  "status": enum (Status)
}
Trường
status

enum (Status)

Trạng thái. Vui lòng xem StopLostModeStatus.

Trạng thái

Trạng thái. Vui lòng xem StopLostModeStatus.

Enum
STATUS_UNSPECIFIED Không xác định. Giá trị này không được sử dụng.
SUCCESS Thiết bị đã được chuyển sang chế độ bình thường.
NOT_IN_LOST_MODE Thiết bị không ở chế độ thất lạc.

RequestDeviceInfoStatus

Trạng thái của lệnh REQUEST_DEVICE_INFO.

Biểu diễn dưới dạng JSON 
{
  "status": enum (Status),

  // Union field device_info can be only one of the following:
  "eidInfo": {
    object (EidInfo)
  }
  // End of list of possible types for union field device_info.
}
Trường
status

enum (Status)

Chỉ có đầu ra. Trạng thái của lệnh REQUEST_DEVICE_INFO.
Trường hợp hợp nhất device_info. Thông tin chi tiết về thông tin thiết bị mà quản trị viên yêu cầu. Giá trị này chỉ được điền khi status là SUCCEEDED. device_info chỉ có thể là một trong những loại sau:
eidInfo

object (EidInfo)

Thông tin liên quan đến EID của thiết bị.

Trạng thái

Trạng thái của lệnh REQUEST_DEVICE_INFO.

Enum
STATUS_UNSPECIFIED Không xác định. Giá trị này không được sử dụng.
SUCCEEDED Đã gửi thành công thông tin thiết bị.
PENDING_USER_ACTION Người dùng chưa hoàn tất các thao tác cần thiết để chia sẻ thông tin thiết bị.
USER_DECLINED Người dùng đã từ chối chia sẻ thông tin thiết bị.
UNSUPPORTED Thiết bị này không hỗ trợ thông tin thiết bị được yêu cầu, ví dụ: thiết bị không hỗ trợ eSIM.

EidInfo

Thông tin liên quan đến EID của thiết bị.

Biểu diễn dưới dạng JSON 
{
  "eids": [
    {
      object (Eid)
    }
  ]
}
Trường
eids[]

object (Eid)

Chỉ có đầu ra. Thông tin EID cho từng khối eUICC.

Eid

Thông tin EID cho từng khối eUICC.

Biểu diễn dưới dạng JSON 
{
  "eid": string
}
Trường
eid

string

Chỉ có đầu ra. EID