Method: enterprises.devices.issueCommand

ออกคำสั่งให้กับอุปกรณ์ ทรัพยากร Operation ที่แสดงผลมี Command ในช่อง metadata ใช้ get Operations Method เพื่อรับสถานะของคำสั่ง

คำขอ 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

คำสั่ง

คำสั่ง

การแสดง 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)
  }
  // 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)
  }
  // End of list of possible types for union field status.
}
ช่อง
type

enum (CommandType)

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

string (Timestamp format)

การประทับเวลาที่สร้างคำสั่ง เซิร์ฟเวอร์จะสร้างการประทับเวลาโดยอัตโนมัติ

การประทับเวลาเป็น RFC3339 UTC "Zulu" โดยมีความละเอียดระดับนาโนวินาทีและมีเลขเศษส่วนสูงสุด 9 หลัก ตัวอย่าง: "2014-10-02T15:01:23Z" และ "2014-10-02T15:01:23.045123456Z"
duration

string (Duration format)

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

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

string

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

enum (CommandErrorCode)

หากคำสั่งไม่สำเร็จ จะมีรหัสข้อผิดพลาดที่อธิบายการทำงานล้มเหลว ระบบจะไม่ตั้งค่านี้เมื่อผู้โทรยกเลิกคำสั่ง
newPassword

string

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

enum (ResetPasswordFlag)

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

ช่องการรวม 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 อย่างชัดแจ้งได้ด้วย
ช่องการรวม 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

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 เพิ่มเติม

CommandErrorCode

รหัสข้อผิดพลาดเกี่ยวกับคำสั่ง นี่คือฟิลด์แบบอ่านอย่างเดียวที่เซิร์ฟเวอร์ป้อนข้อมูล

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

ResetPasswordFlag

แฟล็กที่ใช้กับประเภทคำสั่ง 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 เพื่อนำอุปกรณ์ออกจากโหมดสูญหาย

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 อุปกรณ์ไม่ได้อยู่ในโหมดสูญหาย