- คำขอ HTTP
- พารามิเตอร์เส้นทาง
- เนื้อความของคำขอ
- เนื้อหาการตอบกลับ
- ขอบเขตการให้สิทธิ์
- คำสั่ง
- CommandType
- CommandErrorCode
- ResetPasswordFlag
- ClearAppsDataParams
- StartLostModeParams
- StopLostModeParams
- ClearAppsDataStatus
- PerAppResult
- ClearingResult
- StartLostModeStatus
- สถานะ
- StopLostModeStatus
- สถานะ
- ลองใช้งาน
ออกคำสั่งไปยังอุปกรณ์ ทรัพยากร Operation
ที่แสดงผลมี Command
ในช่อง metadata
ใช้เมธอดการดำเนินการ get เพื่อดูสถานะของคำสั่ง
คำขอ HTTP
POST https://androidmanagement.googleapis.com/v1/{name=enterprises/*/devices/*}:issueCommand
URL ใช้ไวยากรณ์การแปลง gRPC
พารามิเตอร์เส้นทาง
พารามิเตอร์ | |
---|---|
name |
ชื่ออุปกรณ์ในรูปแบบ |
เนื้อหาของคำขอ
เนื้อความของคำขอมีอินสแตนซ์ของ Command
เนื้อหาการตอบกลับ
หากทำสำเร็จ เนื้อหาการตอบกลับจะมีอินสแตนซ์ Operation
ขอบเขตการให้สิทธิ์
ต้องใช้ขอบเขต OAuth ต่อไปนี้
https://www.googleapis.com/auth/androidmanagement
โปรดดูข้อมูลเพิ่มเติมที่ภาพรวมของ OAuth 2.0
คำสั่ง
คำสั่ง
การแสดง JSON |
---|
{ "type": enum ( |
ช่อง | |
---|---|
type |
ประเภทของคำสั่ง |
createTime |
การประทับเวลาที่สร้างคำสั่ง เซิร์ฟเวอร์จะสร้างการประทับเวลาโดยอัตโนมัติ การประทับเวลาจะอยู่ในรูปแบบ RFC3339 UTC "Zulu" ที่มีความละเอียดระดับนาโนวินาทีและมีตัวเลขที่เป็นเศษส่วนได้สูงสุด 9 หลัก ตัวอย่าง: |
duration |
ระยะเวลาที่คําสั่งใช้งานได้ คําสั่งนี้จะหมดอายุหากอุปกรณ์ไม่ได้เรียกใช้ในช่วงเวลานี้ ระยะเวลาเริ่มต้นหากไม่ได้ระบุคือ 10 นาที ไม่มีระยะเวลาสูงสุด ระยะเวลาเป็นวินาทีที่มีเลขเศษส่วนไม่เกิน 9 หลัก ลงท้ายด้วย " |
userName |
ชื่อทรัพยากรของผู้ใช้ที่เป็นเจ้าของอุปกรณ์ในรูปแบบ |
errorCode |
หากคำสั่งล้มเหลว จะมีรหัสข้อผิดพลาดที่อธิบายการทำงานดังกล่าว การตั้งค่านี้ไม่ได้ตั้งค่าไว้เมื่อผู้โทรยกเลิกคำสั่ง |
newPassword |
สำหรับคำสั่งประเภท |
resetPasswordFlags[] |
สำหรับคำสั่งประเภท |
ฟิลด์สหภาพ หากตั้งค่านี้ ก็ไม่ต้องตั้งค่าช่อง |
|
clearAppsDataParams |
พารามิเตอร์สำหรับคำสั่ง |
startLostModeParams |
พารามิเตอร์สําหรับคําสั่ง |
stopLostModeParams |
พารามิเตอร์สำหรับคำสั่ง |
ฟิลด์สหภาพ status สถานะเฉพาะของคำสั่ง โปรดทราบว่าบางคำสั่งจะไม่ใช้ตัวเลือกนี้ โดยเฉพาะ , , และ ในอนาคต คำสั่งเหล่านี้อาจใช้ได้เช่นกัน status ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น |
|
clearAppsDataStatus |
เอาต์พุตเท่านั้น สถานะของคำสั่ง |
startLostModeStatus |
เอาต์พุตเท่านั้น สถานะของคำสั่ง |
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 ขึ้นไป โปรดทราบว่าแอปพลิเคชันสามารถจัดเก็บข้อมูลไว้นอกข้อมูลแอปพลิเคชันได้ เช่น ในที่จัดเก็บข้อมูลภายนอกหรือในพจนานุกรมผู้ใช้ ดู เพิ่มเติม |
START_LOST_MODE |
ทำให้อุปกรณ์เข้าสู่โหมดสูญหาย รองรับเฉพาะในอุปกรณ์ที่มีการจัดการครบวงจรหรืออุปกรณ์ขององค์กรที่มีโปรไฟล์ที่มีการจัดการเท่านั้น ดู เพิ่มเติม |
STOP_LOST_MODE |
นำอุปกรณ์ออกจากโหมดสูญหาย รองรับเฉพาะในอุปกรณ์ที่มีการจัดการครบวงจรหรืออุปกรณ์ขององค์กรที่มีโปรไฟล์ที่มีการจัดการเท่านั้น ดู เพิ่มเติม |
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[] |
ชื่อแพ็กเกจของแอปที่จะล้างข้อมูลเมื่อเรียกใช้คำสั่ง |
StartLostModeParams
พารามิเตอร์ที่เชื่อมโยงกับคำสั่ง
เพื่อให้อุปกรณ์เข้าสู่โหมดสูญหาย ต้องระบุพารามิเตอร์อย่างน้อย 1 รายการ (ไม่รวมชื่อองค์กร) เพื่อให้อุปกรณ์เข้าสู่โหมดสูญหายSTART_LOST_MODE
การแสดง JSON |
---|
{ "lostMessage": { object ( |
ช่อง | |
---|---|
lostMessage |
ข้อความที่แสดงต่อผู้ใช้เมื่ออุปกรณ์อยู่ในโหมดสูญหาย |
lostPhoneNumber |
หมายเลขโทรศัพท์ที่จะใช้โทรเมื่ออุปกรณ์อยู่ในโหมดสูญหายและแตะปุ่มโทรหาเจ้าของ |
lostEmailAddress |
อีเมลที่แสดงต่อผู้ใช้เมื่ออุปกรณ์อยู่ในโหมดสูญหาย |
lostStreetAddress |
ที่อยู่ที่แสดงต่อผู้ใช้เมื่ออุปกรณ์อยู่ในโหมดสูญหาย |
lostOrganization |
ชื่อองค์กรที่แสดงต่อผู้ใช้เมื่ออุปกรณ์อยู่ในโหมดสูญหาย |
StopLostModeParams
ประเภทนี้ไม่มีช่อง
พารามิเตอร์ที่เชื่อมโยงกับคำสั่ง
เพื่อนำอุปกรณ์ออกจากโหมดสูญหายSTOP_LOST_MODE
ClearAppsDataStatus
สถานะของคำสั่ง
สำหรับล้างข้อมูลของแอปที่ระบุออกจากอุปกรณ์CLEAR_APP_DATA
การแสดง JSON |
---|
{
"results": {
string: {
object ( |
ช่อง | |
---|---|
results |
ผลลัพธ์ต่อแอป ซึ่งเป็นการแมปจากชื่อแพ็กเกจไปยังผลลัพธ์การล้างที่เกี่ยวข้อง ออบเจ็กต์ที่มีรายการคู่ |
PerAppResult
ผลลัพธ์จากการพยายามล้างข้อมูลของแอปเดียว
การแสดง JSON |
---|
{
"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 |
สถานะ ดู |
สถานะ
สถานะ ดู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 |
สถานะ ดู |
สถานะ
สถานะ ดูStopLostModeStatus
Enum | |
---|---|
STATUS_UNSPECIFIED |
ไม่ระบุ โดยไม่ได้ใช้ค่านี้ |
SUCCESS |
นำอุปกรณ์ออกจากโหมดสูญหายแล้ว |
NOT_IN_LOST_MODE |
อุปกรณ์ไม่ได้อยู่ในโหมดสูญหาย |