Method: enterprises.devices.issueCommand

ออกคำสั่งไปยังอุปกรณ์ ทรัพยากร Operation ที่แสดงมี Command ในช่อง metadata ใช้วิธีการดำเนินการ get เพื่อดูสถานะของคำสั่ง

คำขอ HTTP

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

URL ใช้ไวยากรณ์การแปลงรหัส gRPC

พารามิเตอร์เส้นทาง

พารามิเตอร์
name

string

ชื่อของอุปกรณ์ในรูปแบบ enterprises/{enterpriseId}/devices/{deviceId}

เนื้อความของคำขอ

เนื้อความของคำขอมีอินสแตนซ์ของ Command

เนื้อหาการตอบกลับ

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีอินสแตนซ์ Operation

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

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

ดูข้อมูลเพิ่มเติมได้ที่OAuth 2.0 Overview

คำสั่ง

คำสั่ง

การแสดง 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)
  },
  "addEsimParams": {
    object (AddEsimParams)
  },
  "removeEsimParams": {
    object (RemoveEsimParams)
  },
  "requestDeviceInfoParams": {
    object (RequestDeviceInfoParams)
  },
  "wipeParams": {
    object (WipeParams)
  }
  // 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)
  },
  "esimStatus": {
    object (EsimCommandStatus)
  },
  "requestDeviceInfoStatus": {
    object (RequestDeviceInfoStatus)
  }
  // End of list of possible types for union field status.
}
ช่อง
type

enum (CommandType)

ประเภทของคำสั่ง
createTime

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"
duration

string (Duration format)

ระยะเวลาที่คำสั่งใช้งานได้ คำสั่งจะหมดอายุหากอุปกรณ์ไม่ดำเนินการในช่วงเวลานี้ ระยะเวลาเริ่มต้นหากไม่ได้ระบุคือ 10 นาที ไม่มีการจำกัดระยะเวลาสูงสุด

ระยะเวลาเป็นวินาทีที่มีเศษทศนิยมได้สูงสุด 9 หลัก โดยลงท้ายด้วย 's' เช่น "3.5s"
userName

string

ชื่อทรัพยากรของผู้ใช้ที่เป็นเจ้าของอุปกรณ์ในรูปแบบ enterprises/{enterpriseId}/users/{userId} เซิร์ฟเวอร์จะสร้างข้อมูลนี้โดยอัตโนมัติตามอุปกรณ์ที่ส่งคำสั่งไป
errorCode

enum (CommandErrorCode)

หากคำสั่งไม่สำเร็จ รหัสข้อผิดพลาดจะอธิบายสาเหตุที่คำสั่งไม่สำเร็จ ระบบจะไม่ตั้งค่านี้เมื่อผู้โทรยกเลิกคำสั่ง สำหรับการให้เหตุผลเกี่ยวกับข้อผิดพลาดของคำสั่ง ให้ใช้ฟิลด์ตามลำดับต่อไปนี้ (ลำดับความสำคัญสูงสุดก่อน): 1. ฟิลด์เฉพาะคำสั่ง เช่น clearAppsDataStatus, startLostModeStatus หรือที่คล้ายกัน หากมี 2. ฟิลด์นี้ หากมีการตั้งค่า 3. ฟิลด์ error ทั่วไปใน Operation ที่ครอบคลุมคำสั่ง
newPassword

string

สำหรับคำสั่งประเภท RESET_PASSWORD คุณจะระบุรหัสผ่านใหม่หรือไม่ก็ได้ หมายเหตุ: รหัสผ่านใหม่ต้องมีความยาวอย่างน้อย 6 อักขระหากเป็นตัวเลขในกรณีของอุปกรณ์ Android 14 มิฉะนั้น คำสั่งจะล้มเหลวโดยมี INVALID_VALUE
resetPasswordFlags[]

enum (ResetPasswordFlag)

สำหรับคำสั่งประเภท RESET_PASSWORD ให้ระบุแฟล็ก (ไม่บังคับ)

ฟิลด์ Union params พารามิเตอร์เฉพาะสำหรับคำสั่ง โปรดทราบว่าบางคำสั่งไม่ได้ใช้คำสั่งนี้ โดยเฉพาะ LOCK, RESET_PASSWORD, REBOOT และ RELINQUISH_OWNERSHIP ในอนาคตคำสั่งเหล่านี้อาจใช้การตั้งค่านี้ด้วย

หากตั้งค่านี้ไว้ ก็ต้องไม่ตั้งค่าช่อง new_password และ reset_password_flags params ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
clearAppsDataParams

object (ClearAppsDataParams)

พารามิเตอร์สำหรับคำสั่ง CLEAR_APP_DATA เพื่อล้างข้อมูลของแอปที่ระบุจากอุปกรณ์ ดู ClearAppsDataParams หากตั้งค่านี้ไว้ เราขอแนะนำว่าไม่ควรตั้งค่า type ในกรณีนี้ เซิร์ฟเวอร์จะตั้งค่าเป็น CLEAR_APP_DATA โดยอัตโนมัติ นอกจากนี้ คุณยังตั้งค่า type เป็น CLEAR_APP_DATA อย่างชัดเจนได้ด้วย
startLostModeParams

object (StartLostModeParams)

พารามิเตอร์สำหรับคำสั่ง START_LOST_MODE เพื่อทำให้อุปกรณ์เข้าสู่โหมดสูญหาย ดู StartLostModeParams หากตั้งค่านี้ไว้ เราขอแนะนำว่าไม่ควรตั้งค่า type ในกรณีนี้ เซิร์ฟเวอร์จะตั้งค่าเป็น START_LOST_MODE โดยอัตโนมัติ นอกจากนี้ คุณยังตั้งค่า type เป็น START_LOST_MODE อย่างชัดเจนได้ด้วย
stopLostModeParams

object (StopLostModeParams)

พารามิเตอร์สำหรับคำสั่ง STOP_LOST_MODE เพื่อนำอุปกรณ์ออกจากโหมดสูญหาย ดู StopLostModeParams หากตั้งค่านี้ไว้ เราขอแนะนำว่าไม่ควรตั้งค่า type ในกรณีนี้ เซิร์ฟเวอร์จะตั้งค่าเป็น STOP_LOST_MODE โดยอัตโนมัติ นอกจากนี้ คุณยังตั้งค่า type เป็น STOP_LOST_MODE อย่างชัดเจนได้ด้วย
addEsimParams

object (AddEsimParams)

ไม่บังคับ พารามิเตอร์สำหรับคำสั่ง ADD_ESIM เพื่อเพิ่มโปรไฟล์ eSIM ลงในอุปกรณ์ หากตั้งค่านี้ไว้ เราขอแนะนำว่าไม่ควรตั้งค่า type ในกรณีนี้ เซิร์ฟเวอร์จะตั้งค่าเป็น ADD_ESIM โดยอัตโนมัติ นอกจากนี้ คุณยังตั้งค่า type เป็น ADD_ESIM อย่างชัดเจนได้ด้วย
removeEsimParams

object (RemoveEsimParams)

ไม่บังคับ พารามิเตอร์สำหรับคำสั่ง REMOVE_ESIM เพื่อนำโปรไฟล์ eSIM ออกจากอุปกรณ์ หากตั้งค่านี้ไว้ เราขอแนะนำว่าไม่ควรตั้งค่า type ในกรณีนี้ เซิร์ฟเวอร์จะตั้งค่าเป็น REMOVE_ESIM โดยอัตโนมัติ นอกจากนี้ คุณยังตั้งค่า type เป็น REMOVE_ESIM อย่างชัดเจนได้ด้วย
requestDeviceInfoParams

object (RequestDeviceInfoParams)

ไม่บังคับ พารามิเตอร์สำหรับคำสั่ง REQUEST_DEVICE_INFO เพื่อรับข้อมูลที่เกี่ยวข้องกับอุปกรณ์ หากตั้งค่านี้ไว้ เราขอแนะนำว่าไม่ควรตั้งค่า type ในกรณีนี้ เซิร์ฟเวอร์จะตั้งค่าเป็น REQUEST_DEVICE_INFO โดยอัตโนมัติ นอกจากนี้ คุณยังตั้งค่า type เป็น REQUEST_DEVICE_INFO อย่างชัดเจนได้ด้วย
wipeParams

object (WipeParams)

ไม่บังคับ พารามิเตอร์สำหรับคำสั่ง WIPE เพื่อล้างข้อมูลอุปกรณ์ หากตั้งค่านี้ไว้ เราขอแนะนำว่าไม่ควรตั้งค่า type ในกรณีนี้ เซิร์ฟเวอร์จะตั้งค่าเป็น WIPE โดยอัตโนมัติ นอกจากนี้ คุณยังตั้งค่า type เป็น WIPE อย่างชัดเจนได้ด้วย
ฟิลด์ Union status สถานะเฉพาะของคำสั่ง โปรดทราบว่าบางคำสั่งไม่ได้ใช้คำสั่งนี้ โดยเฉพาะ LOCK, RESET_PASSWORD, REBOOT และ RELINQUISH_OWNERSHIP ในอนาคตคำสั่งเหล่านี้อาจใช้การตั้งค่านี้ด้วย status ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
clearAppsDataStatus

object (ClearAppsDataStatus)

เอาต์พุตเท่านั้น สถานะของคำสั่ง CLEAR_APP_DATA เพื่อล้างข้อมูลของแอปที่ระบุจากอุปกรณ์ ดู ClearAppsDataStatus
startLostModeStatus

object (StartLostModeStatus)

เอาต์พุตเท่านั้น สถานะของคำสั่ง START_LOST_MODE เพื่อทำให้อุปกรณ์เข้าสู่โหมดสูญหาย ดู StartLostModeStatus
stopLostModeStatus

object (StopLostModeStatus)

เอาต์พุตเท่านั้น สถานะของSTOP_LOST_MODEคำสั่งเพื่อนำอุปกรณ์ออกจากโหมดสูญหาย ดู StopLostModeStatus
esimStatus

object (EsimCommandStatus)

เอาต์พุตเท่านั้น สถานะของคำสั่ง ADD_ESIM หรือ REMOVE_ESIM
requestDeviceInfoStatus

object (RequestDeviceInfoStatus)

เอาต์พุตเท่านั้น สถานะของคำสั่ง REQUEST_DEVICE_INFO

CommandType

ประเภทของคำสั่ง

Enum
COMMAND_TYPE_UNSPECIFIED ไม่อนุญาตให้ใช้ค่านี้
LOCK ล็อกอุปกรณ์ราวกับว่าระยะหมดเวลาล็อกหน้าจอหมดอายุแล้ว
RESET_PASSWORD รีเซ็ตรหัสผ่านของผู้ใช้
REBOOT รีบูตอุปกรณ์ ใช้ได้เฉพาะในอุปกรณ์ที่มีการจัดการเต็มรูปแบบซึ่งใช้ Android 7.0 (API ระดับ 24) ขึ้นไป
RELINQUISH_OWNERSHIP นำโปรไฟล์งานและนโยบายทั้งหมดออกจากอุปกรณ์ Android 8.0 ขึ้นไปของบริษัท เพื่อให้ผู้ใช้สามารถใช้อุปกรณ์เป็นการส่วนตัวได้ ระบบจะเก็บรักษาแอปและข้อมูลที่เชื่อมโยงกับโปรไฟล์ส่วนตัว ระบบจะลบอุปกรณ์ออกจากเซิร์ฟเวอร์หลังจากที่อุปกรณ์รับทราบคำสั่ง
CLEAR_APP_DATA ล้างข้อมูลแอปพลิเคชันของแอปที่ระบุ ฟีเจอร์นี้ใช้ได้ใน Android 9 ขึ้นไป โปรดทราบว่าแอปพลิเคชันสามารถจัดเก็บข้อมูลภายนอกข้อมูลแอปพลิเคชันได้ เช่น ในที่จัดเก็บข้อมูลภายนอกหรือในพจนานุกรมของผู้ใช้ ดู clearAppsDataParams เพิ่มเติม
START_LOST_MODE ทำให้อุปกรณ์เข้าสู่โหมดสูญหาย ใช้ได้เฉพาะในอุปกรณ์ที่มีการจัดการเต็มรูปแบบหรืออุปกรณ์ขององค์กรที่มีโปรไฟล์ที่มีการจัดการ ดู startLostModeParams เพิ่มเติม
STOP_LOST_MODE นำอุปกรณ์ออกจากโหมดสูญหาย ใช้ได้เฉพาะในอุปกรณ์ที่มีการจัดการเต็มรูปแบบหรืออุปกรณ์ขององค์กรที่มีโปรไฟล์ที่มีการจัดการ ดู stopLostModeParams เพิ่มเติม
ADD_ESIM เพิ่มโปรไฟล์ eSIM ลงในอุปกรณ์ ฟีเจอร์นี้ใช้ได้ใน Android 15 ขึ้นไป ดู addEsimParams เพิ่มเติม หากต้องการนำโปรไฟล์ eSIM ออก ให้ใช้คำสั่ง REMOVE_ESIM หากต้องการกำหนดว่าจะเกิดอะไรขึ้นกับโปรไฟล์ eSIM เมื่อล้างข้อมูลในอุปกรณ์ ให้ตั้งค่า wipeDataFlags ในนโยบาย หมายเหตุ: หากต้องการจัดสรร eSIM หลายรายการในอุปกรณ์เครื่องเดียว เราขอแนะนำให้เว้นช่วงเวลา 2-3 นาทีระหว่างการเรียกใช้คำสั่งแต่ละครั้ง
REMOVE_ESIM นำโปรไฟล์ eSIM ออกจากอุปกรณ์ ฟีเจอร์นี้ใช้ได้ใน Android 15 ขึ้นไป ดู removeEsimParams เพิ่มเติม
REQUEST_DEVICE_INFO ขอข้อมูลที่เกี่ยวข้องกับอุปกรณ์
WIPE ล้างข้อมูลในอุปกรณ์ผ่านการรีเซ็ตเป็นค่าเริ่มต้นสำหรับอุปกรณ์ของบริษัท หรือโดยการลบโปรไฟล์งานสำหรับอุปกรณ์ส่วนตัวที่มีโปรไฟล์งาน การล้างข้อมูลจะเกิดขึ้นเมื่ออุปกรณ์รับทราบคำสั่งแล้วเท่านั้น คุณยกเลิกคำสั่งได้ก่อนถึงเวลานั้น

CommandErrorCode

รหัสข้อผิดพลาดของคำสั่ง ช่องนี้เป็นแบบอ่านอย่างเดียวซึ่งเซิร์ฟเวอร์จะกรอกข้อมูลให้

Enum
COMMAND_ERROR_CODE_UNSPECIFIED ไม่มีข้อผิดพลาด
UNKNOWN เกิดข้อผิดพลาดที่ไม่รู้จัก
API_LEVEL ระดับ API ของอุปกรณ์ไม่รองรับคำสั่งนี้
MANAGEMENT_MODE โหมดการจัดการ (เจ้าของโปรไฟล์ เจ้าของอุปกรณ์ ฯลฯ) ไม่รองรับคำสั่งนี้
INVALID_VALUE คำสั่งมีค่าพารามิเตอร์ที่ไม่ถูกต้อง
UNSUPPORTED อุปกรณ์ไม่รองรับคำสั่ง การอัปเดตนโยบายอุปกรณ์ Android เป็นเวอร์ชันล่าสุดอาจช่วยแก้ปัญหานี้ได้

ResetPasswordFlag

Flags ที่ใช้กับRESET_PASSWORDประเภทคำสั่ง

Enum
RESET_PASSWORD_FLAG_UNSPECIFIED ระบบจะไม่สนใจค่านี้
REQUIRE_ENTRY อย่าอนุญาตให้ผู้ดูแลระบบคนอื่นๆ เปลี่ยนรหัสผ่านอีกจนกว่าผู้ใช้จะป้อนรหัสผ่าน
DO_NOT_ASK_CREDENTIALS_ON_BOOT อย่าขอข้อมูลเข้าสู่ระบบของผู้ใช้เมื่อเปิดเครื่องอุปกรณ์
LOCK_NOW ล็อกอุปกรณ์หลังจากรีเซ็ตรหัสผ่าน

ClearAppsDataParams

พารามิเตอร์ที่เชื่อมโยงกับคำสั่ง CLEAR_APP_DATA เพื่อล้างข้อมูลของแอปที่ระบุออกจากอุปกรณ์

การแสดง JSON 
{
  "packageNames": [
    string
  ]
}
ช่อง
packageNames[]

string

ชื่อแพ็กเกจของแอปที่จะล้างข้อมูลเมื่อเรียกใช้คำสั่ง

StartLostModeParams

พารามิเตอร์ที่เชื่อมโยงกับคำสั่ง START_LOST_MODE เพื่อทำให้อุปกรณ์เข้าสู่โหมดสูญหาย ต้องระบุพารามิเตอร์อย่างน้อย 1 รายการ (ไม่รวมชื่อองค์กร) เพื่อให้อุปกรณ์เข้าสู่โหมดสูญหาย

การแสดง JSON 
{
  "lostMessage": {
    object (UserFacingMessage)
  },
  "lostPhoneNumber": {
    object (UserFacingMessage)
  },
  "lostEmailAddress": string,
  "lostStreetAddress": {
    object (UserFacingMessage)
  },
  "lostOrganization": {
    object (UserFacingMessage)
  }
}
ช่อง
lostMessage

object (UserFacingMessage)

ข้อความที่แสดงต่อผู้ใช้เมื่ออุปกรณ์อยู่ในโหมดสูญหาย
lostPhoneNumber

object (UserFacingMessage)

หมายเลขโทรศัพท์ที่จะใช้โทรเมื่ออุปกรณ์อยู่ในโหมดสูญหายและมีการแตะปุ่มเจ้าของโทรศัพท์
lostEmailAddress

string

อีเมลที่แสดงต่อผู้ใช้เมื่ออุปกรณ์อยู่ในโหมดสูญหาย
lostStreetAddress

object (UserFacingMessage)

ที่อยู่ซึ่งแสดงต่อผู้ใช้เมื่ออุปกรณ์อยู่ในโหมดสูญหาย
lostOrganization

object (UserFacingMessage)

ชื่อองค์กรที่แสดงต่อผู้ใช้เมื่ออุปกรณ์อยู่ในโหมดสูญหาย

StopLostModeParams

ประเภทนี้ไม่มีฟิลด์

พารามิเตอร์ที่เชื่อมโยงกับคำสั่ง STOP_LOST_MODE เพื่อนำอุปกรณ์ออกจากโหมดสูญหาย

AddEsimParams

พารามิเตอร์ที่เชื่อมโยงกับคำสั่ง ADD_ESIM เพื่อเพิ่มโปรไฟล์ eSIM ลงในอุปกรณ์

การแสดง JSON 
{
  "activationCode": string,
  "activationState": enum (ActivationState)
}
ช่อง
activationCode

string

ต้องระบุ รหัสเปิดใช้งานสำหรับโปรไฟล์ eSIM
activationState

enum (ActivationState)

ต้องระบุ สถานะการเปิดใช้งานของโปรไฟล์ eSIM เมื่อดาวน์โหลดแล้ว

ActivationState

สถานะการเปิดใช้งานของโปรไฟล์ eSIM เมื่อดาวน์โหลดแล้ว

Enum
ACTIVATION_STATE_UNSPECIFIED ไม่ได้ระบุสถานะการเปิดใช้งาน eSIM โดยค่าเริ่มต้น โปรไฟล์ eSIM จะNOT_ACTIVATEDในอุปกรณ์ส่วนตัวและACTIVATEDในอุปกรณ์ของบริษัท
ACTIVATED ระบบจะเปิดใช้งาน eSIM โดยอัตโนมัติหลังจากดาวน์โหลด การตั้งค่านี้เป็นสถานะการเปิดใช้งานสำหรับอุปกรณ์ส่วนตัวจะทำให้ระบบปฏิเสธคำสั่ง
NOT_ACTIVATED ดาวน์โหลดโปรไฟล์ eSIM แล้วแต่ยังไม่ได้เปิดใช้งาน ในกรณีนี้ ผู้ใช้จะต้องเปิดใช้งาน eSIM ในอุปกรณ์ด้วยตนเอง

RemoveEsimParams

พารามิเตอร์ที่เชื่อมโยงกับคำสั่ง REMOVE_ESIM เพื่อนำโปรไฟล์ eSIM ออกจากอุปกรณ์

การแสดง JSON 
{
  "iccId": string
}
ช่อง
iccId

string

ต้องระบุ ICC ID ของโปรไฟล์ eSIM ที่จะลบ

RequestDeviceInfoParams

พารามิเตอร์ที่เชื่อมโยงกับคำสั่ง REQUEST_DEVICE_INFO เพื่อรับข้อมูลที่เกี่ยวข้องกับอุปกรณ์

การแสดง JSON 
{
  "deviceInfo": enum (DeviceInfo)
}
ช่อง
deviceInfo

enum (DeviceInfo)

ต้องระบุ ประเภทข้อมูลอุปกรณ์ที่จะขอ

DeviceInfo

ประเภทข้อมูลอุปกรณ์ที่จะขอ

Enum
DEVICE_INFO_UNSPECIFIED ไม่อนุญาตให้ใช้ค่านี้
EID ขอตัวระบุสำหรับ eSIM ระบบจะขอให้ผู้ใช้รับรองการเปิดเผยข้อมูลก่อนจึงจะแสดงผลลัพธ์ได้ หากผู้ใช้ไม่อนุมัติการเปิดเผยข้อมูล ระบบจะแสดงผล USER_DECLINED ฟีเจอร์นี้ใช้ได้เฉพาะในอุปกรณ์ส่วนตัวที่มีโปรไฟล์งานและ Android เวอร์ชัน 13 ขึ้นไป

WipeParams

พารามิเตอร์ที่เชื่อมโยงกับคำสั่ง WIPE เพื่อล้างข้อมูลอุปกรณ์

การแสดง JSON 
{
  "wipeDataFlags": [
    enum (WipeDataFlag)
  ],
  "wipeReason": {
    object (UserFacingMessage)
  }
}
ช่อง
wipeDataFlags[]

enum (WipeDataFlag)

ไม่บังคับ Flags to determine what data to wipe.
wipeReason

object (UserFacingMessage)

ไม่บังคับ ข้อความแบบสั้นที่แสดงต่อผู้ใช้ก่อนล้างข้อมูลโปรไฟล์งานในอุปกรณ์ส่วนตัว การดำเนินการนี้จะไม่มีผลต่ออุปกรณ์ที่เป็นของบริษัท ความยาวสูงสุดของข้อความคือ 200 อักขระ

ClearAppsDataStatus

สถานะของคำสั่ง CLEAR_APP_DATA เพื่อล้างข้อมูลของแอปที่ระบุจากอุปกรณ์

การแสดง JSON 
{
  "results": {
    string: {
      object (PerAppResult)
    },
    ...
  }
}
ช่อง
results

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

ผลลัพธ์ต่อแอป ซึ่งเป็นการแมปจากชื่อแพ็กเกจไปยังผลลัพธ์การล้างข้อมูลที่เกี่ยวข้อง

ออบเจ็กต์ที่มีรายการคู่ "key": value ตัวอย่าง: { "name": "wrench", "mass": "1.3kg", "count": "3" }

PerAppResult

ผลลัพธ์ของการพยายามล้างข้อมูลของแอปเดียว

การแสดง JSON 
{
  "clearingResult": enum (ClearingResult)
}
ช่อง
clearingResult

enum (ClearingResult)

ผลลัพธ์ของการพยายามล้างข้อมูลของแอปเดียว

ClearingResult

ผลลัพธ์ของการพยายามล้างข้อมูลของแอปเดียว

Enum
CLEARING_RESULT_UNSPECIFIED ผลลัพธ์ที่ไม่ได้ระบุ
SUCCESS ล้างข้อมูลของแอปนี้เรียบร้อยแล้ว
APP_NOT_FOUND ล้างข้อมูลของแอปนี้ไม่ได้เนื่องจากไม่พบแอป
APP_PROTECTED ล้างข้อมูลของแอปนี้ไม่ได้เนื่องจากแอปได้รับการป้องกัน เช่น อาจมีผลกับแอปที่มีความสำคัญต่อการทำงานของอุปกรณ์ เช่น Google Play Store
API_LEVEL ล้างข้อมูลของแอปนี้ไม่ได้เนื่องจากระดับ API ของอุปกรณ์ไม่รองรับคำสั่งนี้

StartLostModeStatus

สถานะของคำสั่ง START_LOST_MODE เพื่อทำให้อุปกรณ์เข้าสู่โหมดสูญหาย

การแสดง JSON 
{
  "status": enum (Status)
}
ช่อง
status

enum (Status)

สถานะ ดูStartLostModeStatus

สถานะ

สถานะ ดูStartLostModeStatus

Enum
STATUS_UNSPECIFIED ไม่ระบุ ระบบจะไม่ใช้ค่านี้
SUCCESS อุปกรณ์เข้าสู่โหมดสูญหาย
RESET_PASSWORD_RECENTLY ตั้งค่าอุปกรณ์เป็นโหมดสูญหายไม่ได้เนื่องจากผู้ดูแลระบบรีเซ็ตรหัสผ่านของอุปกรณ์เมื่อเร็วๆ นี้
USER_EXIT_LOST_MODE_RECENTLY ตั้งค่าอุปกรณ์เป็นโหมดสูญหายไม่ได้เนื่องจากผู้ใช้เพิ่งออกจากโหมดสูญหาย
ALREADY_IN_LOST_MODE อุปกรณ์อยู่ในโหมดสูญหายอยู่แล้ว

StopLostModeStatus

สถานะของSTOP_LOST_MODEคำสั่งเพื่อนำอุปกรณ์ออกจากโหมดสูญหาย

การแสดง JSON 
{
  "status": enum (Status)
}
ช่อง
status

enum (Status)

สถานะ ดูStopLostModeStatus

สถานะ

สถานะ ดูStopLostModeStatus

Enum
STATUS_UNSPECIFIED ไม่ระบุ ระบบจะไม่ใช้ค่านี้
SUCCESS นำอุปกรณ์ออกจากโหมดสูญหายแล้ว
NOT_IN_LOST_MODE อุปกรณ์ไม่ได้อยู่ในโหมดสูญหาย

EsimCommandStatus

สถานะและรายละเอียดข้อผิดพลาด (หากมี) ของคำสั่ง ADD_ESIM หรือ REMOVE_ESIM

การแสดง JSON 
{
  "status": enum (Status),
  "esimInfo": {
    object (EsimInfo)
  },

  // Union field status_details can be only one of the following:
  "internalErrorDetails": {
    object (InternalErrorDetails)
  }
  // End of list of possible types for union field status_details.
}
ช่อง
status

enum (Status)

เอาต์พุตเท่านั้น สถานะของคำสั่ง ADD_ESIM หรือ REMOVE_ESIM
esimInfo

object (EsimInfo)

เอาต์พุตเท่านั้น ข้อมูลเกี่ยวกับ eSIM ที่เพิ่มหรือนำออก จะมีการป้อนข้อมูลเมื่อการดำเนินการ eSIM statusSUCCESS เท่านั้น
ฟิลด์ Union status_details รายละเอียดสถานะของคำสั่ง ADD_ESIM หรือ REMOVE_ESIM status_details ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
internalErrorDetails

object (InternalErrorDetails)

เอาต์พุตเท่านั้น รายละเอียดของข้อผิดพลาดหากตั้งค่า status เป็น INTERNAL_ERROR

สถานะ

สถานะของคำสั่ง ADD_ESIM หรือ REMOVE_ESIM

Enum
STATUS_UNSPECIFIED ไม่ระบุ ระบบจะไม่ใช้ค่านี้
SUCCESS ดำเนินการกับ eSIM ในอุปกรณ์เรียบร้อยแล้ว
IN_PROGRESS การดำเนินการ eSIM อยู่ระหว่างดำเนินการ
PENDING_USER_ACTION ผู้ใช้ต้องดำเนินการเพื่อให้การดำเนินการ eSIM ดำเนินต่อไป
ERROR_SETUP_IN_PROGRESS ดำเนินการกับ eSIM ไม่ได้เมื่ออยู่ระหว่างการตั้งค่า
ERROR_USER_DENIED ผู้ใช้ปฏิเสธการดำเนินการ eSIM
INTERNAL_ERROR เกิดข้อผิดพลาดขณะพยายามเพิ่มหรือนำ eSIM ออกจากอุปกรณ์ โปรดดู internalErrorDetails
ERROR_ICC_ID_NOT_FOUND สำหรับคำสั่ง REMOVE_ESIM ไม่พบ iccId ของ eSIM ที่จะนำออกในอุปกรณ์ ซึ่งอาจหมายความว่า eSIM ไม่ได้เป็นขององค์กร หรือไม่มี eSIM ที่สอดคล้องกับ iccId ในอุปกรณ์
ERROR_MULTIPLE_ACTIVE_ESIMS_NO_AVAILABLE_SLOT คำสั่ง ADD_ESIM ล้มเหลวเมื่อพยายามเพิ่ม eSIM ใหม่โดยตั้งค่าสถานะการเปิดใช้งานเป็น ACTIVATED เนื่องจากช่อง eSIM หลายช่องในอุปกรณ์มีโปรไฟล์ eSIM ที่ใช้งานอยู่และไม่มีช่อง eSIM ที่ว่าง หากต้องการแก้ไขปัญหานี้ คุณสามารถเพิ่ม eSIM ใหม่โดยมีสถานะการเปิดใช้งานเป็น NOT_ACTIVATED เพื่อเปิดใช้งานด้วยตนเองในภายหลัง หรือผู้ใช้ต้องปิดใช้งาน eSIM ที่ใช้งานอยู่ก่อนเพื่อให้ดำเนินการต่อได้

InternalErrorDetails

รายละเอียดข้อผิดพลาดภายในหากมีสำหรับคำสั่ง ADD_ESIM หรือ REMOVE_ESIM

การแสดง JSON 
{
  "operationCode": string,
  "errorCode": string,
  "operationCodeDetail": enum (OperationCodeDetail),
  "errorCodeDetail": enum (ErrorCodeDetail)
}
ช่อง
operationCode

string (int64 format)

เอาต์พุตเท่านั้น การแสดงรหัสการดำเนินการเป็นจำนวนเต็มตามที่ระบุไว้ที่นี่ ดูรายละเอียดเพิ่มเติมได้ที่ operationCodeDetail
errorCode

string (int64 format)

เอาต์พุตเท่านั้น การแสดงรหัสข้อผิดพลาดเป็นจำนวนเต็มตามที่ระบุไว้ที่นี่ ดู OPERATION_SMDX_SUBJECT_REASON_CODE เพิ่มเติม ดูรายละเอียดเพิ่มเติมได้ที่ errorCodeDetail
operationCodeDetail

enum (OperationCodeDetail)

เอาต์พุตเท่านั้น รายละเอียดรหัสการดำเนินการที่สอดคล้องกับ operationCode
errorCodeDetail

enum (ErrorCodeDetail)

เอาต์พุตเท่านั้น รายละเอียดรหัสข้อผิดพลาดที่สอดคล้องกับ errorCode

OperationCodeDetail

รายละเอียดรหัสการดำเนินการที่สอดคล้องกับ operationCode

Enum
OPERATION_CODE_DETAIL_UNSPECIFIED ไม่ได้ระบุรายละเอียดรหัสการดำเนินการ Android Management API ไม่รู้จัก operationCode อย่างไรก็ตาม โปรดดู operationCode
OPERATION_SYSTEM ดูรายละเอียดได้ที่ EuiccManager.OPERATION_SYSTEM
OPERATION_SIM_SLOT ดูรายละเอียดได้ที่ EuiccManager.OPERATION_SIM_SLOT
OPERATION_EUICC_CARD ดูรายละเอียดได้ที่ EuiccManager.OPERATION_EUICC_CARD
OPERATION_SMDX ดูรายละเอียดได้ที่ EuiccManager.OPERATION_SMDX
OPERATION_SWITCH ดูรายละเอียดได้ที่ EuiccManager.OPERATION_SWITCH
OPERATION_DOWNLOAD ดูรายละเอียดได้ที่ EuiccManager.OPERATION_DOWNLOAD
OPERATION_METADATA ดูรายละเอียดได้ที่ EuiccManager.OPERATION_METADATA
OPERATION_EUICC_GSMA ดูรายละเอียดได้ที่ EuiccManager.OPERATION_EUICC_GSMA
OPERATION_APDU ดูรายละเอียดได้ที่ EuiccManager.OPERATION_APDU
OPERATION_SMDX_SUBJECT_REASON_CODE ดูรายละเอียดได้ที่ EuiccManager.OPERATION_SMDX_SUBJECT_REASON_CODE โปรดทราบว่าในกรณีนี้ errorCode คือไบต์ 3 ไบต์ที่มีนัยสำคัญน้อยที่สุดของ EXTRA_EMBEDDED_SUBSCRIPTION_DETAILED_CODE ซึ่งระบุรหัสเรื่องและรหัสเหตุผลตามที่ระบุที่นี่ ระบบจะตั้งค่าไบต์ที่มีนัยสำคัญมากที่สุดของจำนวนเต็มเป็น 0 ตัวอย่างเช่น รหัสเรื่อง 8.11.1 และรหัสเหตุผล 5.1 จะแสดงใน errorCode เป็น 0000 0000 1000 1011 0001 0000 0101 0001 ในฐาน 2 ซึ่งเท่ากับ 9113681 ในฐาน 10
OPERATION_HTTP ดูรายละเอียดได้ที่ EuiccManager.OPERATION_HTTP

ErrorCodeDetail

รายละเอียดรหัสข้อผิดพลาดที่สอดคล้องกับ errorCode

Enum
ERROR_CODE_DETAIL_UNSPECIFIED ไม่ได้ระบุรายละเอียดรหัสข้อผิดพลาด Android Management API ไม่รู้จัก errorCode อย่างไรก็ตาม โปรดดูerrorCode
ERROR_TIME_OUT ดูรายละเอียดได้ที่ EuiccManager.ERROR_TIME_OUT
ERROR_EUICC_MISSING ดูรายละเอียดได้ที่ EuiccManager.ERROR_EUICC_MISSING
ERROR_UNSUPPORTED_VERSION ดูรายละเอียดได้ที่ EuiccManager.ERROR_UNSUPPORTED_VERSION
ERROR_ADDRESS_MISSING ดูรายละเอียดได้ที่ EuiccManager.ERROR_ADDRESS_MISSING
ERROR_INVALID_CONFIRMATION_CODE ดูรายละเอียดได้ที่ EuiccManager.ERROR_INVALID_CONFIRMATION_CODE
ERROR_CERTIFICATE_ERROR ดูรายละเอียดได้ที่ EuiccManager.ERROR_CERTIFICATE_ERROR
ERROR_NO_PROFILES_AVAILABLE ดูรายละเอียดได้ที่ EuiccManager.ERROR_NO_PROFILES_AVAILABLE
ERROR_CONNECTION_ERROR ดูรายละเอียดได้ที่ EuiccManager.ERROR_CONNECTION_ERROR
ERROR_INVALID_RESPONSE ดูรายละเอียดได้ที่ EuiccManager.ERROR_INVALID_RESPONSE
ERROR_CARRIER_LOCKED ดูรายละเอียดได้ที่ EuiccManager.ERROR_CARRIER_LOCKED
ERROR_DISALLOWED_BY_PPR ดูรายละเอียดได้ที่ EuiccManager.ERROR_DISALLOWED_BY_PPR
ERROR_INVALID_ACTIVATION_CODE ดูรายละเอียดได้ที่ EuiccManager.ERROR_INVALID_ACTIVATION_CODE
ERROR_INCOMPATIBLE_CARRIER ดูรายละเอียดได้ที่ EuiccManager.ERROR_INCOMPATIBLE_CARRIER
ERROR_OPERATION_BUSY ดูรายละเอียดได้ที่ EuiccManager.ERROR_OPERATION_BUSY
ERROR_INSTALL_PROFILE ดูรายละเอียดได้ที่ EuiccManager.ERROR_INSTALL_PROFILE
ERROR_EUICC_INSUFFICIENT_MEMORY ดูรายละเอียดได้ที่ EuiccManager.ERROR_EUICC_INSUFFICIENT_MEMORY
ERROR_INVALID_PORT ดูรายละเอียดได้ที่ EuiccManager.ERROR_INVALID_PORT
ERROR_SIM_MISSING ดูรายละเอียดได้ที่ EuiccManager.ERROR_SIM_MISSING

EsimInfo

รายละเอียดของ eSIM ที่เพิ่มหรือนำออก

การแสดง JSON 
{
  "iccId": string
}
ช่อง
iccId

string

เอาต์พุตเท่านั้น ICC ID ของ eSIM

RequestDeviceInfoStatus

สถานะของคำสั่ง REQUEST_DEVICE_INFO

การแสดง 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.
}
ช่อง
status

enum (Status)

เอาต์พุตเท่านั้น สถานะของคำสั่ง REQUEST_DEVICE_INFO
ฟิลด์ Union device_info รายละเอียดข้อมูลอุปกรณ์ที่ผู้ดูแลระบบขอ ระบบจะป้อนข้อมูลนี้เมื่อ status เป็น SUCCEEDED เท่านั้น device_info ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
eidInfo

object (EidInfo)

ข้อมูลที่เกี่ยวข้องกับ EID ของอุปกรณ์

สถานะ

สถานะของคำสั่ง REQUEST_DEVICE_INFO

Enum
STATUS_UNSPECIFIED ไม่ระบุ ระบบจะไม่ใช้ค่านี้
SUCCEEDED ส่งข้อมูลอุปกรณ์เรียบร้อยแล้ว
PENDING_USER_ACTION ผู้ใช้ยังไม่ได้ดำเนินการที่จำเป็นเพื่อแชร์ข้อมูลอุปกรณ์
USER_DECLINED ผู้ใช้ปฏิเสธการแชร์ข้อมูลอุปกรณ์
UNSUPPORTED อุปกรณ์นี้ไม่รองรับข้อมูลอุปกรณ์ที่ขอ เช่น อุปกรณ์ไม่รองรับ eSIM

EidInfo

ข้อมูลที่เกี่ยวข้องกับ EID ของอุปกรณ์

การแสดง JSON 
{
  "eids": [
    {
      object (Eid)
    }
  ]
}
ช่อง
eids[]

object (Eid)

เอาต์พุตเท่านั้น ข้อมูล EID สำหรับชิป eUICC แต่ละชิป

Eid

ข้อมูล EID สำหรับชิป eUICC แต่ละชิป

การแสดง JSON 
{
  "eid": string
}
ช่อง
eid

string

เอาต์พุตเท่านั้น EID