Method: enterprises.devices.issueCommand

Mengeluarkan perintah ke perangkat. Resource Operation yang ditampilkan berisi Command di kolom metadata-nya. Gunakan metode operasi get untuk mendapatkan status perintah.

Permintaan HTTP

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

URL menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
name

string

Nama perangkat dalam bentuk enterprises/{enterpriseId}/devices/{deviceId}.

Isi permintaan

Isi permintaan memuat instance Command.

Isi respons

Jika berhasil, isi respons memuat instance Operation.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

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

Untuk informasi selengkapnya, lihat Ringkasan OAuth 2.0.

Perintah

Perintah.

Representasi 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.
}
Kolom
type

enum (CommandType)

Jenis perintah.
createTime

string (Timestamp format)

Stempel waktu saat perintah dibuat. Stempel waktu dibuat secara otomatis oleh server.

Stempel waktu dalam format RFC3339 UTC "Zulu", dengan resolusi nanodetik dan hingga sembilan digit pecahan. Contoh: "2014-10-02T15:01:23Z" dan "2014-10-02T15:01:23.045123456Z".
duration

string (Duration format)

Durasi validitas perintah. Perintah akan berakhir jika tidak dijalankan oleh perangkat selama waktu ini. Durasi default-nya adalah sepuluh menit jika tidak ditentukan. Tidak ada durasi maksimum.

Durasi dalam detik dengan maksimal sembilan digit pecahan, yang diakhiri dengan 's'. Contoh: "3.5s".
userName

string

Nama resource pengguna yang memiliki perangkat dalam bentuk enterprises/{enterpriseId}/users/{userId}. Ini dibuat secara otomatis oleh server berdasarkan perangkat tempat perintah dikirim.
errorCode

enum (CommandErrorCode)

Jika perintah gagal, kode error yang menjelaskan kegagalan tersebut. Ini tidak ditetapkan saat perintah dibatalkan oleh pemanggil.
newPassword

string

Untuk perintah jenis RESET_PASSWORD, secara opsional menentukan sandi baru. Catatan: Sandi baru harus minimal 6 karakter jika berupa angka untuk perangkat Android 14. Jika tidak, perintah akan gagal dengan INVALID_VALUE.
resetPasswordFlags[]

enum (ResetPasswordFlag)

Untuk perintah jenis RESET_PASSWORD, secara opsional menentukan flag.

Kolom union params. Parameter khusus untuk perintah. Perhatikan bahwa beberapa perintah tidak menggunakannya, terutama LOCK, RESET_PASSWORD, REBOOT, dan RELINQUISH_OWNERSHIP. Di masa mendatang, perintah ini mungkin juga menggunakannya.

Jika ditetapkan, kolom new_password dan reset_password_flags tidak boleh ditetapkan. params hanya dapat berupa salah satu dari hal berikut:
clearAppsDataParams

object (ClearAppsDataParams)

Parameter untuk perintah CLEAR_APP_DATA guna menghapus data aplikasi yang ditentukan dari perangkat. Lihat ClearAppsDataParams. Jika ditetapkan, sebaiknya type tidak ditetapkan. Dalam hal ini, server akan otomatis menetapkannya ke CLEAR_APP_DATA. Anda juga dapat menetapkan type ke CLEAR_APP_DATA secara eksplisit.
startLostModeParams

object (StartLostModeParams)

Parameter untuk perintah START_LOST_MODE guna menyetel perangkat ke mode hilang. Lihat StartLostModeParams. Jika ditetapkan, sebaiknya type tidak ditetapkan. Dalam hal ini, server akan otomatis menetapkannya ke START_LOST_MODE. Anda juga dapat menetapkan type ke START_LOST_MODE secara eksplisit.
stopLostModeParams

object (StopLostModeParams)

Parameter untuk perintah STOP_LOST_MODE guna mengeluarkan perangkat dari mode hilang. Lihat StopLostModeParams. Jika ditetapkan, sebaiknya type tidak ditetapkan. Dalam hal ini, server akan otomatis menetapkannya ke STOP_LOST_MODE. Anda juga dapat menetapkan type ke STOP_LOST_MODE secara eksplisit.
Kolom union status. Status khusus untuk perintah. Perhatikan bahwa beberapa perintah tidak menggunakannya, terutama LOCK, RESET_PASSWORD, REBOOT, dan RELINQUISH_OWNERSHIP. Di masa mendatang, perintah ini mungkin juga menggunakannya. status hanya dapat berupa salah satu dari hal berikut:
clearAppsDataStatus

object (ClearAppsDataStatus)

Hanya output. Status perintah CLEAR_APP_DATA untuk menghapus data aplikasi yang ditentukan dari perangkat. Lihat ClearAppsDataStatus.
startLostModeStatus

object (StartLostModeStatus)

Hanya output. Status perintah START_LOST_MODE untuk menyetel perangkat ke mode hilang. Lihat StartLostModeStatus.
stopLostModeStatus

object (StopLostModeStatus)

Hanya output. Status perintah STOP_LOST_MODE untuk mengeluarkan perangkat dari mode hilang. Lihat StopLostModeStatus.

CommandType

Jenis perintah.

Enum
COMMAND_TYPE_UNSPECIFIED Nilai ini tidak diizinkan.
LOCK Kunci perangkat, seolah-olah waktu tunggu layar kunci telah habis masa berlakunya.
RESET_PASSWORD Reset sandi pengguna.
REBOOT Boot ulang perangkat. Hanya didukung di perangkat yang dikelola sepenuhnya yang menjalankan Android 7.0 (API level 24) atau yang lebih tinggi.
RELINQUISH_OWNERSHIP Menghapus profil kerja dan semua kebijakan dari perangkat Android 8.0+ milik perusahaan, sehingga perangkat dapat digunakan untuk keperluan pribadi. Aplikasi dan data yang terkait dengan profil pribadi akan dipertahankan. Perangkat akan dihapus dari server setelah mengonfirmasi perintah.
CLEAR_APP_DATA Menghapus data aplikasi dari aplikasi yang ditentukan. Fitur ini didukung di Android 9 dan yang lebih baru. Perhatikan bahwa aplikasi dapat menyimpan data di luar data aplikasinya, misalnya di penyimpanan eksternal atau dalam kamus pengguna. Lihat juga clearAppsDataParams.
START_LOST_MODE Memasukkan perangkat ke mode hilang. Hanya didukung di perangkat yang sepenuhnya dikelola atau perangkat milik organisasi dengan profil terkelola. Lihat juga startLostModeParams.
STOP_LOST_MODE Menghapus perangkat dari mode hilang. Hanya didukung di perangkat yang sepenuhnya dikelola atau perangkat milik organisasi dengan profil terkelola. Lihat juga stopLostModeParams.

CommandErrorCode

Kode error perintah. Ini adalah kolom hanya baca yang diisi oleh server.

Enum
COMMAND_ERROR_CODE_UNSPECIFIED Tidak ada error.
UNKNOWN Terjadi error tak dikenal.
API_LEVEL API level perangkat tidak mendukung perintah ini.
MANAGEMENT_MODE Mode pengelolaan (pemilik profil, pemilik perangkat, dll.) tidak mendukung perintah tersebut.
INVALID_VALUE Perintah memiliki nilai parameter yang tidak valid.
UNSUPPORTED Perangkat tidak mendukung perintah. Mengupdate Kebijakan Perangkat Android ke versi terbaru dapat menyelesaikan masalah ini.

ResetPasswordFlag

Flag yang dapat digunakan untuk jenis perintah RESET_PASSWORD.

Enum
RESET_PASSWORD_FLAG_UNSPECIFIED Nilai ini diabaikan.
REQUIRE_ENTRY Jangan izinkan admin lain mengubah sandi lagi hingga pengguna memasukkannya.
DO_NOT_ASK_CREDENTIALS_ON_BOOT Jangan meminta kredensial pengguna saat perangkat melakukan booting.
LOCK_NOW Mengunci perangkat setelah mereset sandi.

ClearAppsDataParams

Parameter yang terkait dengan perintah CLEAR_APP_DATA untuk menghapus data aplikasi yang ditentukan dari perangkat.

Representasi JSON 
{
  "packageNames": [
    string
  ]
}
Kolom
packageNames[]

string

Nama paket aplikasi yang datanya akan dihapus saat perintah dieksekusi.

StartLostModeParams

Parameter yang terkait dengan perintah START_LOST_MODE untuk menyetel perangkat ke mode hilang. Setidaknya salah satu parameter, tidak termasuk nama organisasi, harus diberikan agar perangkat dapat dimasukkan ke mode hilang.

Representasi JSON 
{
  "lostMessage": {
    object (UserFacingMessage)
  },
  "lostPhoneNumber": {
    object (UserFacingMessage)
  },
  "lostEmailAddress": string,
  "lostStreetAddress": {
    object (UserFacingMessage)
  },
  "lostOrganization": {
    object (UserFacingMessage)
  }
}
Kolom
lostMessage

object (UserFacingMessage)

Pesan yang ditampilkan kepada pengguna saat perangkat dalam mode hilang.
lostPhoneNumber

object (UserFacingMessage)

Nomor telepon yang akan ditelepon saat perangkat dalam mode hilang dan tombol panggil pemilik diketuk.
lostEmailAddress

string

Alamat email yang ditampilkan kepada pengguna saat perangkat dalam mode hilang.
lostStreetAddress

object (UserFacingMessage)

Alamat jalan yang ditampilkan kepada pengguna saat perangkat dalam mode hilang.
lostOrganization

object (UserFacingMessage)

Nama organisasi yang ditampilkan kepada pengguna saat perangkat dalam mode hilang.

StopLostModeParams

Jenis ini tidak memiliki kolom.

Parameter yang terkait dengan perintah STOP_LOST_MODE untuk mengeluarkan perangkat dari mode hilang.

ClearAppsDataStatus

Status perintah CLEAR_APP_DATA untuk menghapus data aplikasi yang ditentukan dari perangkat.

Representasi JSON 
{
  "results": {
    string: {
      object (PerAppResult)
    },
    ...
  }
}
Kolom
results

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

Hasil per aplikasi, pemetaan dari nama paket ke hasil penghapusan masing-masing.

Objek yang berisi daftar pasangan "key": value. Contoh: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

PerAppResult

Hasil upaya untuk menghapus data satu aplikasi.

Representasi JSON 
{
  "clearingResult": enum (ClearingResult)
}
Kolom
clearingResult

enum (ClearingResult)

Hasil upaya untuk menghapus data satu aplikasi.

ClearingResult

Hasil upaya untuk menghapus data satu aplikasi.

Enum
CLEARING_RESULT_UNSPECIFIED Hasil tidak ditentukan.
SUCCESS Data aplikasi ini berhasil dihapus.
APP_NOT_FOUND Data aplikasi ini tidak dapat dihapus karena aplikasi tidak ditemukan.
APP_PROTECTED Data aplikasi ini tidak dapat dihapus karena aplikasi dilindungi. Misalnya, hal ini dapat berlaku untuk aplikasi yang penting bagi fungsi perangkat, seperti Google Play Store.
API_LEVEL Data aplikasi ini tidak dapat dihapus karena API level perangkat tidak mendukung perintah ini.

StartLostModeStatus

Status perintah START_LOST_MODE untuk menyetel perangkat ke mode hilang.

Representasi JSON 
{
  "status": enum (Status)
}
Kolom
status

enum (Status)

Status. Lihat StartLostModeStatus.

Status

Status. Lihat StartLostModeStatus.

Enum
STATUS_UNSPECIFIED Tidak ditentukan. Nilai ini tidak digunakan.
SUCCESS Perangkat disetel ke mode hilang.
RESET_PASSWORD_RECENTLY Perangkat tidak dapat dimasukkan ke mode hilang karena admin baru-baru ini mereset sandi perangkat.
USER_EXIT_LOST_MODE_RECENTLY Perangkat tidak dapat dimasukkan ke mode hilang karena pengguna baru saja keluar dari mode hilang.
ALREADY_IN_LOST_MODE Perangkat sudah dalam mode hilang.

StopLostModeStatus

Status perintah STOP_LOST_MODE untuk mengeluarkan perangkat dari mode hilang.

Representasi JSON 
{
  "status": enum (Status)
}
Kolom
status

enum (Status)

Status. Lihat StopLostModeStatus.

Status

Status. Lihat StopLostModeStatus.

Enum
STATUS_UNSPECIFIED Tidak ditentukan. Nilai ini tidak digunakan.
SUCCESS Perangkat dikeluarkan dari mode hilang.
NOT_IN_LOST_MODE Perangkat tidak dalam mode hilang.