API Reference

Referensi API ini diatur menurut 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. Lisensi grup
  5. Pengguna lisensi grup
  6. Penginstalan
  7. Managedconfigurationsfordevice
  8. Konfigurasi Terkelola untuk pengguna
  9. Managedconfigurationssettings
  10. Izin Akses
  11. Produk
  12. Serviceaccountkeys
  13. Storelayoutcluster
  14. Storelayoutpages
  15. Pengguna
  16. Aplikasi Web

Perangkat

Untuk mengetahui detail Resource Perangkat, lihat halaman representasi resource.

Metode Permintaan HTTP Deskripsi
URI yang terkait dengan https://www.googleapis.com/androidenterprise/v1, kecuali dinyatakan lain
forceReportUpload POST  /enterprises/enterpriseId/users/userId/devices/deviceId/forceReportUpload Mengupload laporan yang berisi perubahan apa pun dalam status aplikasi di perangkat sejak laporan terakhir dibuat. Anda dapat memanggil metode ini hingga 3 kali setiap 24 jam untuk perangkat tertentu.
dapatkan 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 menerapkan kebijakan EMM di Android perangkat diaktifkan di Konsol Google Admin. Jika tidak, status perangkat akan diabaikan dan semua perangkat akan mendapatkan akses yang diizinkan ke 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 menerapkan kebijakan EMM di Android perangkat diaktifkan di Konsol Google Admin. Jika tidak, status perangkat akan diabaikan dan semua perangkat akan mendapatkan akses yang diizinkan ke layanan Google. Fitur ini hanya didukung untuk pengguna yang dikelola Google.
info terbaru PUT  /enterprises/enterpriseId/users/userId/devices/deviceId Memperbarui kebijakan perangkat.

Untuk memastikan kebijakan ditegakkan dengan benar, Anda perlu mencegah akun agar tidak mengakses Google Play dengan menyetel allowed_accounts dalam konfigurasi terkelola untuk 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 dinyatakan lain
acknowledgeNotificationSet POST  /enterprises/acknowledgeNotificationSet Mengonfirmasi notifikasi yang diterima dari Enterprises.PullNotificationSet untuk mencegah panggilan berikutnya ditampilkan 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 Perusahaan tertentu menggunakan Token Google.
createWebToken POST  /enterprises/enterpriseId/createWebToken Menampilkan token unik untuk mengakses UI yang dapat disematkan. Untuk membuat UI web, teruskan token yang dibuat ke JavaScript Google Play terkelola Compute Engine API. Setiap token hanya dapat digunakan untuk memulai satu sesi UI. Lihat Dokumentasi JavaScript API untuk informasi lebih lanjut.
daftarkan POST  /enterprises/enroll Mendaftarkan perusahaan dengan EMM panggilan.

Parameter kueri yang diperlukan: token

generateSignupUrl POST  /enterprises/signupUrl Membuat URL pendaftaran.
dapatkan GET  /enterprises/enterpriseId Mengambil nama dan domain perusahaan.
getServiceAccount GET  /enterprises/enterpriseId/serviceAccount Menampilkan kredensial dan akun layanan. Akun layanan dapat diikat ke perusahaan dengan memanggil setAccount. Akun layanan bersifat 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 sebelumnya Enterprises.SetAccount; pada lain waktu, itu akan menghasilkan {i>error<i}.

Panggilan berikutnya setelah panggilan pertama akan menghasilkan serangkaian kredensial, dan membatalkan kredensial yang dibuat sebelumnya.

Setelah akun layanan terikat dengan perusahaan, akun tersebut dapat dikelola menggunakan resource serviceAccountKeys.
getStoreLayout GET  /enterprises/enterpriseId/storeLayout Menampilkan tata letak toko untuk perusahaan. Jika tata letak toko belum disetel, mengembalikan "dasar" seperti jenis tata letak toko dan {i>homepage<i}.
list GET  /enterprises Mencari perusahaan berdasarkan nama domain. Ini hanya didukung untuk perusahaan yang dibuat melalui alur kreasi. Pencarian ID tidak diperlukan untuk perusahaan yang dibuat melalui alur yang dimulai EMM karena EMM mempelajari ID perusahaan di callback yang ditentukan dalam panggilan Enterprises.generateSignupUrl.

Parameter kueri yang diperlukan: domain

pullNotificationSet POST  /enterprises/pullNotificationSet Menarik dan menampilkan set notifikasi untuk perusahaan yang terkait dengan akun layanan yang diotentikasi untuk permintaan. Kumpulan 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 kumpulan notifikasi kosong.
Notifikasi yang tidak dikonfirmasi dalam 20 detik akan pada akhirnya akan disertakan lagi dalam respons terhadap PullNotificationSet lainnya dan permintaan 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 pemberitahuan 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 menjadi yang 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 disetel ke "dasar" dan tata letak toko dasar diaktifkan. Dasar-dasar hanya berisi aplikasi yang disetujui oleh admin, dan yang memiliki ditambahkan ke kumpulan produk yang tersedia untuk pengguna (menggunakan setAvailableProductSet). Aplikasi di halaman diurutkan dalam urutan nilai ID produk. Jika Anda membuat tata letak toko kustom (dengan menyetel storeLayoutType = "custom" dan mengatur beranda), toko dasar dinonaktifkan.
batalkan pendaftaran POST  /enterprises/enterpriseId/unenroll Membatalkan pendaftaran perusahaan dari EMM 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 dinyatakan lain
hapus DELETE  /enterprises/enterpriseId/users/userId/entitlements/entitlementId Menghapus hak atas aplikasi untuk pengguna.
dapatkan 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.
info terbaru PUT  /enterprises/enterpriseId/users/userId/entitlements/entitlementId Menambahkan atau memperbarui hak atas aplikasi untuk pengguna.

Lisensi grup

Untuk mengetahui detail Resource Grouplicenses, lihat halaman representasi resource.

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

Pengguna lisensi grup

Untuk mengetahui detail Resource Grouplicenseusers, lihat halaman representasi resource.

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

Instal

Untuk mengetahui detail Installs Resource, lihat halaman representasi resource.

Metode Permintaan HTTP Deskripsi
URI yang terkait dengan https://www.googleapis.com/androidenterprise/v1, kecuali 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 diinstal di perangkat hingga data tersebut benar-benar dihapus.
dapatkan 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.
info terbaru PUT  /enterprises/enterpriseId/users/userId/devices/deviceId/installs/installId Permintaan untuk menginstal versi terbaru aplikasi ke perangkat. Jika aplikasi sudah diinstal, maka aplikasi akan diperbarui ke versi terbaru jika diperlukan.

Managedconfigurationsfordevice

Untuk mengetahui detail Managedconfigurationsfordevice Resource, lihat halaman representasi resource.

Metode Permintaan HTTP Deskripsi
URI yang terkait dengan https://www.googleapis.com/androidenterprise/v1, kecuali dinyatakan lain
hapus DELETE  /enterprises/enterpriseId/users/userId/devices/deviceId/managedConfigurationsForDevice/managedConfigurationForDeviceId Menghapus konfigurasi terkelola per perangkat untuk aplikasi untuk properti yang ditentukan perangkat seluler.
dapatkan 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.
info terbaru PUT  /enterprises/enterpriseId/users/userId/devices/deviceId/managedConfigurationsForDevice/managedConfigurationForDeviceId Menambahkan atau mengupdate konfigurasi terkelola per perangkat untuk aplikasi untuk perangkat tertentu.

Konfigurasi Terkelola untuk pengguna

Untuk mengetahui detail Resource Managedconfigurationsforuser, lihat halaman representasi resource.

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

Managedconfigurationssettings

Untuk mengetahui detail Resource Managedconfigurationssettings, lihat halaman representasi resource.

Metode Permintaan HTTP Deskripsi
URI yang terkait dengan https://www.googleapis.com/androidenterprise/v1, kecuali 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 dinyatakan lain
dapatkan GET  /permissions/permissionId Mengambil detail izin aplikasi Android untuk ditampilkan kepada admin perusahaan.

Produk

Untuk mengetahui detail Resource Produk, lihat halaman representasi resource.

Metode Permintaan HTTP Deskripsi
URI yang terkait dengan https://www.googleapis.com/androidenterprise/v1, kecuali dinyatakan lain
setujui 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.

Mempelajari cara menggunakan Google Play terkelola untuk mendesain dan membuat app store untuk menampilkan produk yang disetujui kepada pengguna, lihat Desain Tata Letak Toko.
generateApprovalUrl POST  /enterprises/enterpriseId/products/productId/generateApprovalUrl Menghasilkan URL yang dapat dirender dalam iframe untuk menampilkan izin akses (jika ada) dari suatu produk. Admin perusahaan harus melihatnya dan menerimanya atas nama organisasi mereka untuk menyetujui produk tersebut.

Admin harus menyetujui izin yang ditampilkan dengan berinteraksi dengan elemen UI terpisah di konsol EMM, yang pada gilirannya akan memicu penggunaan URL ini sebagai Properti approvalUrlInfo.approvalUrl di Panggilan Products.approve untuk menyetujui produk. URL ini hanya bisa digunakan untuk menampilkan izin selama maksimal 1 hari.
dapatkan 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 properti ini Google. Semua produk memiliki skema, tetapi skema ini boleh kosong jika tidak ada telah ditentukan. Skema ini dapat digunakan untuk mengisi UI yang memungkinkan admin mengonfigurasi produk. Untuk menerapkan konfigurasi terkelola berdasarkan skema yang diperoleh API, 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.
batalkan persetujuan POST  /enterprises/enterpriseId/products/productId/unapprove Menolak produk yang ditentukan (dan izin aplikasi yang relevan, jika ada)

Serviceaccountkeys

Untuk mengetahui detail Resource Serviceaccountkeys, lihat halaman representasi resource.

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

Hanya jenis kunci yang harus diisi dalam resource yang akan disisipkan.
list GET  /enterprises/enterpriseId/serviceAccountKeys Menampilkan daftar semua kredensial aktif untuk akun layanan yang terkait dengan kredensial ini perusahaan. Hanya ID dan jenis kunci yang ditampilkan. Layanan panggilan akun tersebut harus sudah diambil dengan memanggil Enterprises.GetServiceAccount dan harus ditetapkan sebagai akun layanan perusahaan dengan memanggil {i>Enterprises.SetAccount<i}

Storelayoutcluster

Untuk mengetahui detail Resource Storelayoutclusters, lihat halaman representasi resource.

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

Storelayoutpages

Untuk mengetahui detail Resource Storelayoutpages, lihat halaman representasi resource.

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

Pengguna

Untuk mengetahui detail Resource Pengguna, lihat halaman representasi resource.

Metode Permintaan HTTP Deskripsi
URI yang terkait dengan https://www.googleapis.com/androidenterprise/v1, kecuali 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 pada perangkat. Token yang dihasilkan sekali pakai dan akan habis masa berlakunya setelah beberapa menit.

Anda dapat menyediakan maksimum 10 perangkat per pengguna.

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

Resource Users yang diteruskan di isi permintaan harus mencakup accountIdentifier dan accountType.

Jika sudah ada pengguna yang memiliki ID akun yang sama, pengguna akan diperbarui dengan sumber daya tersebut. Dalam kasus ini, hanya Kolom displayName 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 untuk pengguna yang dikelola EMM karena ID sudah ditampilkan di hasil dari panggilan Users.insert.

Parameter kueri yang diperlukan: email

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

Panggilan ini hanya berfungsi dengan akun yang dikelola EMM.
setAvailableProductSet PUT  /enterprises/enterpriseId/users/userId/availableProductSet Memodifikasi seperangkat produk yang berhak diakses pengguna (disebut sebagai sebagai produk yang masuk daftar yang diizinkan). Hanya produk yang disetujui atau produk yang sebelumnya disetujui (produk dengan persetujuan yang dicabut) dapat dimasukkan ke daftar putih.
info terbaru PUT  /enterprises/enterpriseId/users/userId Memperbarui detail pengguna terkelola EMM.

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

Aplikasi Web

Untuk mengetahui detail Resource Webapps, lihat halaman representasi resource.

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