API Reference

Referensi API ini diatur berdasarkan jenis resource. Setiap jenis resource memiliki satu atau beberapa representasi data dan satu atau beberapa metode.

Jenis resource

  1. Perangkat
  2. Perusahaan
  3. Hak
  4. Grouplicenses
  5. Grouplicenseusers
  6. Menginstal
  7. Managedconfigurationsfordevice
  8. Managedconfigurationsforuser
  9. Managedconfigurationssettings
  10. Izin
  11. Produk
  12. Serviceaccountkeys
  13. Storelayoutclusters
  14. Storelayoutpages
  15. Pengguna
  16. Webapp

Perangkat

Untuk detail Resource Perangkat, lihat halaman representasi resource.

Metode Permintaan HTTP Deskripsi
URI yang terkait dengan https://www.googleapis.com/androidenterprise/v1, kecuali jika dinyatakan lain
forceReportUpload POST  /enterprises/enterpriseId/users/userId/devices/deviceId/forceReportUpload Mengupload laporan yang berisi perubahan status aplikasi di perangkat sejak laporan terakhir dibuat. Anda dapat memanggil metode ini hingga 3 kali setiap 24 jam untuk perangkat tertentu.
get GET  /enterprises/enterpriseId/users/userId/devices/deviceId Mengambil detail perangkat.
getState GET  /enterprises/enterpriseId/users/userId/devices/deviceId/state Mengambil apakah akses perangkat ke layanan Google diaktifkan atau dinonaktifkan. Status perangkat hanya berlaku jika penerapan kebijakan EMM di perangkat Android diaktifkan di Konsol Google Admin. Jika tidak, status perangkat akan diabaikan dan semua perangkat diizinkan mengakses layanan Google. Fitur ini hanya didukung untuk pengguna yang dikelola Google.
list GET  /enterprises/enterpriseId/users/userId/devices Mengambil ID semua perangkat pengguna.
setState PUT  /enterprises/enterpriseId/users/userId/devices/deviceId/state Menetapkan apakah akses perangkat ke layanan Google diaktifkan atau dinonaktifkan. Status perangkat hanya berlaku jika penerapan kebijakan EMM di perangkat Android diaktifkan di Konsol Google Admin. Jika tidak, status perangkat akan diabaikan dan semua perangkat diizinkan mengakses layanan Google. Fitur ini hanya didukung untuk pengguna yang dikelola Google.
update PUT  /enterprises/enterpriseId/users/userId/devices/deviceId Memperbarui kebijakan perangkat.

Untuk memastikan kebijakan diterapkan dengan benar, Anda harus mencegah akun yang tidak dikelola mengakses Google Play dengan menetapkan allowed_accounts dalam konfigurasi terkelola untuk paket Google Play. Lihat membatasi akun di Google Play.

Perusahaan

Untuk mengetahui detail Resource Perusahaan, lihat halaman representasi resource.

Metode Permintaan HTTP Deskripsi
URI yang terkait dengan https://www.googleapis.com/androidenterprise/v1, kecuali jika dinyatakan lain
acknowledgeNotificationSet POST  /enterprises/acknowledgeNotificationSet Mengonfirmasi notifikasi yang diterima dari Enterprises.PullNotificationSet untuk mencegah panggilan berikutnya menampilkan notifikasi yang sama.
completeSignup POST  /enterprises/completeSignup Menyelesaikan alur pendaftaran, dengan menentukan Token penyelesaian dan Token perusahaan. Permintaan ini tidak boleh dipanggil beberapa kali untuk Token Enterprise tertentu.
createWebToken POST  /enterprises/enterpriseId/createWebToken Menampilkan token unik untuk mengakses UI yang dapat disematkan. Untuk membuat UI web, teruskan token yang dihasilkan ke API JavaScript Google Play terkelola. Setiap token hanya dapat digunakan untuk memulai satu sesi UI. Lihat dokumentasi JavaScript API untuk informasi lebih lanjut.
daftar POST  /enterprises/enroll Mendaftarkan perusahaan dengan EMM panggilan.

Parameter kueri yang diperlukan: token

generateEnterpriseUpgradeUrl POST  /enterprises/enterpriseId/generateEnterpriseUpgradeUrl Menghasilkan URL upgrade perusahaan untuk mengupgrade Akun Google Play perusahaan terkelola yang ada ke Managed Google Domains.

generateSignupUrl POST  /enterprises/signupUrl Membuat URL pendaftaran.
get GET  /enterprises/enterpriseId Mengambil nama dan domain perusahaan.
getServiceAccount GET  /enterprises/enterpriseId/serviceAccount Menampilkan akun layanan dan kredensial. Akun layanan dapat terikat ke perusahaan dengan memanggil setAccount. Akun layanan unik untuk perusahaan dan EMM ini, dan akan dihapus jika perusahaan tidak terikat. Kredensial berisi data kunci pribadi dan tidak disimpan sisi server.

Metode ini hanya dapat dipanggil setelah memanggil Enterprises.Enroll atau Enterprises.CompleteSignup, dan sebelum Enterprises.SetAccount; pada waktu lain, metode ini akan menampilkan error.

Panggilan berikutnya setelah panggilan pertama akan menghasilkan kumpulan kredensial baru yang unik, dan membatalkan kredensial yang dibuat sebelumnya.

Setelah terikat ke perusahaan, akun layanan dapat dikelola menggunakan resource serviceAccountKeys.

.
getStoreLayout GET  /enterprises/enterpriseId/storeLayout Menampilkan tata letak toko untuk perusahaan. Jika tata letak toko belum ditetapkan, menampilkan "dasar" sebagai jenis tata letak toko dan tidak ada halaman beranda.
list GET  /enterprises Mencari perusahaan berdasarkan nama domain. Hal ini hanya didukung untuk perusahaan yang dibuat melalui alur pembuatan yang dimulai Google. Pencarian ID tidak diperlukan untuk perusahaan yang dibuat melalui alur yang dimulai EMM karena EMM mempelajari ID perusahaan dalam callback yang ditentukan dalam panggilan Enterprises.generateSignupUrl.

Parameter kueri yang diperlukan: domain

pullNotificationSet POST  /enterprises/pullNotificationSet Menarik dan menampilkan kumpulan notifikasi untuk perusahaan yang terkait dengan akun layanan yang diautentikasi untuk permintaan. Set notifikasi mungkin kosong jika tidak ada notifikasi yang tertunda.
Set notifikasi yang ditampilkan harus dikonfirmasi dalam waktu 20 detik dengan memanggil Enterprises.AcknowledgeNotificationSet, kecuali jika set notifikasi kosong.
Notifikasi yang tidak dikonfirmasi dalam waktu 20 detik pada akhirnya akan disertakan lagi dalam respons terhadap permintaan PullNotificationSet lain, dan notifikasi yang tidak pernah dikonfirmasi pada akhirnya akan dihapus sesuai dengan kebijakan sistem Pub/Sub Google Cloud Platform.
Beberapa permintaan dapat dilakukan secara serentak untuk mengambil notifikasi. Dalam hal ini, notifikasi yang tertunda (jika ada) akan dibagi di antara setiap pemanggil, jika ada yang tertunda.
Jika tidak ada notifikasi, daftar notifikasi kosong akan ditampilkan. Permintaan berikutnya dapat menampilkan lebih banyak notifikasi setelah tersedia.
sendTestPushNotification POST  /enterprises/enterpriseId/sendTestPushNotification Mengirim notifikasi pengujian untuk memvalidasi integrasi EMM dengan layanan Google Cloud Pub/Sub untuk perusahaan ini.
setAccount PUT  /enterprises/enterpriseId/account Menetapkan akun yang akan digunakan untuk mengautentikasi ke API sebagai perusahaan.
setStoreLayout PUT  /enterprises/enterpriseId/storeLayout Menetapkan tata letak toko untuk perusahaan. Secara default, storeLayoutType ditetapkan ke "basic" dan tata letak toko dasar diaktifkan. Tata letak dasar hanya berisi aplikasi yang disetujui oleh admin, dan yang telah ditambahkan ke kumpulan produk yang tersedia untuk pengguna (menggunakan panggilan setAvailableProductSet). Aplikasi di halaman diurutkan berdasarkan nilai ID produknya. Jika Anda membuat tata letak toko kustom (dengan menetapkan storeLayoutType = "custom" dan menetapkan halaman beranda), tata letak toko dasar akan dinonaktifkan.
unenroll POST  /enterprises/enterpriseId/unenroll Membatalkan pendaftaran perusahaan dari EMM yang melakukan panggilan.

Hak

Untuk mengetahui detail Resource Hak, lihat halaman representasi resource.

Metode Permintaan HTTP Deskripsi
URI yang terkait dengan https://www.googleapis.com/androidenterprise/v1, kecuali jika dinyatakan lain
hapus DELETE  /enterprises/enterpriseId/users/userId/entitlements/entitlementId Menghapus hak ke aplikasi untuk pengguna.
get GET  /enterprises/enterpriseId/users/userId/entitlements/entitlementId Mengambil detail hak.
list GET  /enterprises/enterpriseId/users/userId/entitlements Mencantumkan semua hak untuk pengguna yang ditentukan. Hanya ID yang ditetapkan.
update PUT  /enterprises/enterpriseId/users/userId/entitlements/entitlementId Menambahkan atau memperbarui hak ke aplikasi untuk pengguna.

Grouplicenses

Untuk detail Resource Grouplicenses, lihat halaman representasi resource.

Metode Permintaan HTTP Deskripsi
URI yang terkait dengan https://www.googleapis.com/androidenterprise/v1, kecuali jika dinyatakan lain
get GET  /enterprises/enterpriseId/groupLicenses/groupLicenseId Mengambil detail lisensi grup perusahaan untuk produk.
list GET  /enterprises/enterpriseId/groupLicenses Mengambil ID semua produk yang lisensi grupnya dimiliki oleh perusahaan.

Grouplicenseusers

Untuk detail Resource Grouplicenseusers, lihat halaman representasi resource.

Metode Permintaan HTTP Deskripsi
URI yang terkait dengan https://www.googleapis.com/androidenterprise/v1, kecuali jika dinyatakan lain
list GET  /enterprises/enterpriseId/groupLicenses/groupLicenseId/users Mengambil ID pengguna yang telah diberi hak berdasarkan lisensi.

Instal

Untuk mengetahui detail Resource Penginstalan, lihat halaman representasi resource.

Metode Permintaan HTTP Deskripsi
URI yang terkait dengan https://www.googleapis.com/androidenterprise/v1, kecuali jika dinyatakan lain
hapus DELETE  /enterprises/enterpriseId/users/userId/devices/deviceId/installs/installId Permintaan untuk menghapus aplikasi dari perangkat. Panggilan ke get atau list akan tetap menampilkan aplikasi sebagai terinstal di perangkat hingga aplikasi benar-benar dihapus.
get GET  /enterprises/enterpriseId/users/userId/devices/deviceId/installs/installId Mengambil detail penginstalan aplikasi di perangkat.
list GET  /enterprises/enterpriseId/users/userId/devices/deviceId/installs Mengambil detail semua aplikasi yang diinstal di perangkat yang ditentukan.
update PUT  /enterprises/enterpriseId/users/userId/devices/deviceId/installs/installId Meminta untuk menginstal aplikasi versi terbaru ke perangkat. Jika aplikasi sudah diinstal, aplikasi akan diupdate ke versi terbaru jika diperlukan.

Managedconfigurationsfordevice

Untuk detail Resource Managedconfigurationsfordevice, lihat halaman representasi resource.

Metode Permintaan HTTP Deskripsi
URI yang terkait dengan https://www.googleapis.com/androidenterprise/v1, kecuali jika dinyatakan lain
hapus DELETE  /enterprises/enterpriseId/users/userId/devices/deviceId/managedConfigurationsForDevice/managedConfigurationForDeviceId Menghapus konfigurasi terkelola per perangkat untuk aplikasi untuk perangkat yang ditentukan.
get GET  /enterprises/enterpriseId/users/userId/devices/deviceId/managedConfigurationsForDevice/managedConfigurationForDeviceId Mengambil detail konfigurasi terkelola per perangkat.
list GET  /enterprises/enterpriseId/users/userId/devices/deviceId/managedConfigurationsForDevice Mencantumkan semua konfigurasi terkelola per perangkat untuk perangkat yang ditentukan. Hanya ID yang ditetapkan.
update PUT  /enterprises/enterpriseId/users/userId/devices/deviceId/managedConfigurationsForDevice/managedConfigurationForDeviceId Menambahkan atau memperbarui konfigurasi terkelola per perangkat untuk aplikasi untuk perangkat yang ditentukan.

Managedconfigurationsforuser

Untuk detail Resource Managedconfigurationsforuser, lihat halaman representasi resource.

Metode Permintaan HTTP Deskripsi
URI yang terkait dengan https://www.googleapis.com/androidenterprise/v1, kecuali jika dinyatakan lain
hapus DELETE  /enterprises/enterpriseId/users/userId/managedConfigurationsForUser/managedConfigurationForUserId Menghapus konfigurasi terkelola per pengguna untuk aplikasi bagi pengguna yang ditentukan.
get GET  /enterprises/enterpriseId/users/userId/managedConfigurationsForUser/managedConfigurationForUserId Mengambil detail konfigurasi terkelola per pengguna untuk aplikasi bagi pengguna yang ditentukan.
list GET  /enterprises/enterpriseId/users/userId/managedConfigurationsForUser Mencantumkan semua konfigurasi yang dikelola per pengguna untuk pengguna yang ditentukan. Hanya ID yang ditetapkan.
update PUT  /enterprises/enterpriseId/users/userId/managedConfigurationsForUser/managedConfigurationForUserId Menambahkan atau memperbarui setelan konfigurasi terkelola untuk aplikasi bagi pengguna yang ditentukan. Jika mendukung Iframe konfigurasi terkelola, Anda dapat menerapkan konfigurasi terkelola ke pengguna dengan menentukan mcmId dan variabel konfigurasi terkait (jika ada) dalam permintaan. Atau, semua EMM dapat menerapkan konfigurasi terkelola dengan meneruskan daftar properti terkelola.

Managedconfigurationssettings

Untuk detail Resource Managedconfigurationssettings, lihat halaman representasi resource.

Metode Permintaan HTTP Deskripsi
URI yang terkait dengan https://www.googleapis.com/androidenterprise/v1, kecuali jika dinyatakan lain
list GET  /enterprises/enterpriseId/products/productId/managedConfigurationsSettings Mencantumkan semua setelan konfigurasi terkelola untuk aplikasi yang ditentukan.

Izin

Untuk mengetahui detail Resource Izin, lihat halaman representasi resource.

Metode Permintaan HTTP Deskripsi
URI yang terkait dengan https://www.googleapis.com/androidenterprise/v1, kecuali jika dinyatakan lain
get GET  /permissions/permissionId Mengambil detail izin aplikasi Android untuk ditampilkan kepada admin perusahaan.

Produk

Untuk detail Resource Produk, lihat halaman representasi resource.

Metode Permintaan HTTP Deskripsi
URI yang terkait dengan https://www.googleapis.com/androidenterprise/v1, kecuali jika dinyatakan lain
approve POST  /enterprises/enterpriseId/products/productId/approve

Menyetujui produk yang ditentukan dan izin aplikasi yang relevan, jika ada. Jumlah maksimum produk yang dapat Anda setujui per pelanggan perusahaan adalah 1.000.

Untuk mempelajari cara menggunakan Google Play terkelola untuk mendesain dan membuat tata letak Play Store guna menampilkan produk yang disetujui kepada pengguna, lihat Desain Tata Letak Play Store.

generateApprovalUrl POST  /enterprises/enterpriseId/products/productId/generateApprovalUrl Menghasilkan URL yang dapat dirender dalam iframe untuk menampilkan izin (jika ada) produk. Admin perusahaan harus melihat izin ini dan menerimanya atas nama organisasi mereka agar dapat menyetujui produk tersebut.

Admin harus menyetujui izin yang ditampilkan dengan berinteraksi dengan elemen UI terpisah di konsol EMM, yang pada akhirnya akan memicu penggunaan URL ini sebagai properti approvalUrlInfo.approvalUrl dalam panggilan Products.approve untuk menyetujui produk. URL ini hanya dapat digunakan untuk menampilkan izin hingga 1 hari.
get GET  /enterprises/enterpriseId/products/productId Mengambil detail produk untuk ditampilkan kepada admin perusahaan.
getAppRestrictionsSchema GET  /enterprises/enterpriseId/products/productId/appRestrictionsSchema Mengambil skema yang menentukan properti yang dapat dikonfigurasi untuk produk ini. Semua produk memiliki skema, tetapi skema ini mungkin kosong jika tidak ada konfigurasi terkelola yang telah ditentukan. Skema ini dapat digunakan untuk mengisi UI yang memungkinkan admin mengonfigurasi produk. Untuk menerapkan konfigurasi terkelola berdasarkan skema yang diperoleh menggunakan API ini, lihat Konfigurasi Terkelola melalui Play.
getPermissions GET  /enterprises/enterpriseId/products/productId/permissions Mengambil izin aplikasi Android yang diperlukan oleh aplikasi ini.
list GET  /enterprises/enterpriseId/products Menemukan produk yang disetujui yang cocok dengan kueri, atau semua produk yang disetujui jika tidak ada kueri.
tidak menyetujui POST  /enterprises/enterpriseId/products/productId/unapprove Membatalkan persetujuan produk yang ditentukan (dan izin aplikasi yang relevan, jika ada)

Serviceaccountkeys

Untuk detail Resource Serviceaccountkeys, lihat halaman representasi resource.

Metode Permintaan HTTP Deskripsi
URI yang terkait dengan https://www.googleapis.com/androidenterprise/v1, kecuali jika dinyatakan lain
hapus DELETE  /enterprises/enterpriseId/serviceAccountKeys/keyId Menghapus dan membatalkan validitas kredensial yang ditentukan untuk akun layanan yang terkait dengan perusahaan ini. Akun layanan panggilan harus telah diambil dengan memanggil Enterprises.GetServiceAccount dan harus telah ditetapkan sebagai akun layanan perusahaan dengan memanggil Enterprises.SetAccount.
insert POST  /enterprises/enterpriseId/serviceAccountKeys Membuat kredensial baru untuk akun layanan yang terkait dengan perusahaan ini. Akun layanan panggilan harus telah diambil dengan memanggil Enterprises.GetServiceAccount dan harus telah ditetapkan sebagai akun layanan perusahaan dengan memanggil Enterprises.SetAccount.

Hanya jenis kunci yang harus diisi dalam resource yang akan disisipkan.
list GET  /enterprises/enterpriseId/serviceAccountKeys Mencantumkan semua kredensial aktif untuk akun layanan yang terkait dengan perusahaan ini. Hanya ID dan jenis kunci yang ditampilkan. Akun layanan panggilan harus telah diambil dengan memanggil Enterprises.GetServiceAccount dan harus telah ditetapkan sebagai akun layanan perusahaan dengan memanggil Enterprises.SetAccount.

Storelayoutclusters

Untuk detail Resource Storelayoutclusters, lihat halaman representasi resource.

Metode Permintaan HTTP Deskripsi
URI yang terkait dengan https://www.googleapis.com/androidenterprise/v1, kecuali jika dinyatakan lain
hapus DELETE  /enterprises/enterpriseId/storeLayout/pages/pageId/clusters/clusterId Menghapus cluster.
get GET  /enterprises/enterpriseId/storeLayout/pages/pageId/clusters/clusterId Mengambil detail cluster.
insert POST  /enterprises/enterpriseId/storeLayout/pages/pageId/clusters Menyisipkan cluster baru di halaman.
list GET  /enterprises/enterpriseId/storeLayout/pages/pageId/clusters Mengambil detail semua cluster di halaman yang ditentukan.
update PUT  /enterprises/enterpriseId/storeLayout/pages/pageId/clusters/clusterId Memperbarui cluster.

Storelayoutpages

Untuk detail Resource Storelayoutpages, lihat halaman representasi resource.

Metode Permintaan HTTP Deskripsi
URI yang terkait dengan https://www.googleapis.com/androidenterprise/v1, kecuali jika dinyatakan lain
hapus DELETE  /enterprises/enterpriseId/storeLayout/pages/pageId Menghapus halaman Play Store.
get GET  /enterprises/enterpriseId/storeLayout/pages/pageId Mengambil detail halaman Play Store.
insert POST  /enterprises/enterpriseId/storeLayout/pages Menyisipkan halaman toko baru.
list GET  /enterprises/enterpriseId/storeLayout/pages Mengambil detail semua halaman di Play Store.
update PUT  /enterprises/enterpriseId/storeLayout/pages/pageId Memperbarui konten halaman Play Store.

Pengguna

Untuk detail Resource Pengguna, lihat halaman representasi resource.

Metode Permintaan HTTP Deskripsi
URI yang terkait dengan https://www.googleapis.com/androidenterprise/v1, kecuali jika dinyatakan lain
hapus DELETE  /enterprises/enterpriseId/users/userId Menghapus pengguna yang dikelola EMM.
generateAuthenticationToken POST  /enterprises/enterpriseId/users/userId/authenticationToken Menghasilkan token autentikasi yang dapat digunakan klien kebijakan perangkat untuk menyediakan akun pengguna terkelola EMM tertentu di perangkat. Token yang dihasilkan hanya dapat digunakan sekali dan akan berakhir masa berlakunya setelah beberapa menit.

Anda dapat menyediakan maksimal 10 perangkat per pengguna.

Panggilan ini hanya berfungsi dengan akun yang dikelola EMM.
get GET  /enterprises/enterpriseId/users/userId Mengambil detail pengguna.
getAvailableProductSet GET  /enterprises/enterpriseId/users/userId/availableProductSet Mengambil kumpulan produk yang berhak diakses pengguna.
insert POST  /enterprises/enterpriseId/users Membuat pengguna baru yang dikelola EMM.

Resource Users yang diteruskan dalam isi permintaan harus menyertakan accountIdentifier dan accountType.

Jika pengguna yang sesuai sudah ada dengan ID akun yang sama, pengguna akan diperbarui dengan resource. Dalam hal ini, hanya kolom displayName yang dapat diubah.

list GET  /enterprises/enterpriseId/users Mencari pengguna berdasarkan alamat email utama. Fitur ini hanya didukung untuk pengguna yang dikelola Google. Pencarian ID tidak diperlukan untuk pengguna yang dikelola EMM karena ID sudah ditampilkan dalam hasil panggilan Users.insert.

Parameter kueri yang diperlukan: email

revokeDeviceAccess DELETE  /enterprises/enterpriseId/users/userId/deviceAccess Membatalkan akses ke semua perangkat yang saat ini disediakan untuk pengguna. Pengguna tidak akan dapat lagi menggunakan Play Store terkelola di perangkat terkelolanya.

Panggilan ini hanya berfungsi dengan akun yang dikelola EMM.
setAvailableProductSet PUT  /enterprises/enterpriseId/users/userId/availableProductSet Mengubah kumpulan produk yang berhak diakses pengguna (disebut sebagai produk yang diizinkan). Hanya produk yang disetujui atau produk yang sebelumnya disetujui (produk dengan persetujuan yang dicabut) yang dapat diizinkan.
update PUT  /enterprises/enterpriseId/users/userId Memperbarui detail pengguna yang dikelola EMM.

Hanya dapat digunakan dengan pengguna yang dikelola EMM (bukan pengguna yang dikelola Google). Teruskan detail baru dalam resource Users dalam isi permintaan. Hanya kolom displayName yang dapat diubah. Kolom lain harus tidak ditetapkan atau memiliki nilai yang saat ini aktif.

Webapp

Untuk detail Resource Webapp, lihat halaman representasi resource.

Metode Permintaan HTTP Deskripsi
URI yang terkait dengan https://www.googleapis.com/androidenterprise/v1, kecuali jika dinyatakan lain
hapus DELETE  /enterprises/enterpriseId/webApps/webAppId Menghapus aplikasi web yang ada.
get GET  /enterprises/enterpriseId/webApps/webAppId Mendapatkan aplikasi web yang ada.
insert POST  /enterprises/enterpriseId/webApps Membuat aplikasi web baru untuk perusahaan.
list GET  /enterprises/enterpriseId/webApps Mengambil detail semua aplikasi web untuk perusahaan tertentu.
update PUT  /enterprises/enterpriseId/webApps/webAppId Memperbarui aplikasi web yang ada.