Tetap teratur dengan koleksi
Simpan dan kategorikan konten berdasarkan preferensi Anda.
Untuk mengetahui daftar metode untuk resource ini, lihat bagian akhir halaman ini.
Representasi resource
Resource Perusahaan mewakili binding antara EMM dan organisasi tertentu. Binding tersebut dapat dibuat instance-nya dengan salah satu dari dua cara berbeda menggunakan API ini sebagai berikut:
Untuk pelanggan domain terkelola Google, prosesnya melibatkan penggunaan Enterprises.enroll dan Enterprises.setAccount (bersama dengan artefak yang diperoleh dari konsol Admin dan Konsol API Google) dan dikirimkan ke EMM melalui proses yang kurang lebih manual.
Untuk pelanggan Akun Google terkelola, prosesnya melibatkan penggunaan Enterprises.generateSignupUrl dan Enterprises.completeSignup bersama dengan UI pendaftaran Google Play terkelola (mekanisme yang disediakan Google) untuk membuat binding tanpa langkah manual.
Sebagai EMM, Anda dapat mendukung salah satu atau kedua pendekatan tersebut di konsol EMM. Lihat Membuat Perusahaan untuk mengetahui detailnya.
Menyelesaikan alur pendaftaran, dengan menentukan Token penyelesaian dan
Token perusahaan.
Permintaan ini tidak boleh dipanggil beberapa kali untuk Token
Enterprise tertentu.
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.
Menghasilkan URL upgrade perusahaan untuk mengupgrade Akun Google Play perusahaan terkelola yang ada ke Managed Google Domains.
Lihat
panduan mengupgrade perusahaan untuk mengetahui detail selengkapnya.
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.
Menampilkan tata letak toko untuk perusahaan. Jika tata letak toko
belum ditetapkan, menampilkan "dasar" sebagai jenis tata letak toko dan tidak ada
halaman beranda.
Menelusuri 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.
Mengambil 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 mungkin 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.
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.
[null,null,["Terakhir diperbarui pada 2025-07-28 UTC."],[[["\u003cp\u003eAn Enterprises resource represents the connection between an EMM and an organization, established through either manual enrollment for Google-managed domains or automated signup for managed Google Play Accounts.\u003c/p\u003e\n"],["\u003cp\u003eEMMs can support either or both enrollment methods, offering flexibility in binding with organizations.\u003c/p\u003e\n"],["\u003cp\u003eThe API provides various methods to manage enterprises, including enrollment, sign-up, retrieval of enterprise details, and more.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eEnterprises\u003c/code\u003e resource includes properties like ID, primary domain, name, and administrators, offering comprehensive information about the enterprise.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers can leverage the API's methods to interact with and manage enterprise data, enabling seamless integration with their EMM solutions.\u003c/p\u003e\n"]]],[],null,["# Enterprises\n\n\u003cbr /\u003e\n\nFor a list of [methods](#methods) for this resource, see the end of this page.\n\nResource representations\n------------------------\n\nAn Enterprises resource represents the binding between an EMM and a specific organization. That binding can be instantiated in one of two different ways using this API as follows:\n\n- For Google managed domain customers, the process involves using `Enterprises.enroll` and `Enterprises.setAccount` (in conjunction with artifacts obtained from the Admin console and the Google API Console) and submitted to the EMM through a more-or-less manual process.\n- For managed Google Play Accounts customers, the process involves using `Enterprises.generateSignupUrl` and `Enterprises.completeSignup` in conjunction with the managed Google Play sign-up UI (Google-provided mechanism) to create the binding without manual steps.\n\nAs an EMM, you can support either or both approaches in your EMM console. See [Create an Enterprise](/android/work/play/emm-api/create-enterprise) for details. \n\n\u003cbr /\u003e\n\n```text\n{\n \"kind\": \"androidenterprise#enterprise\",\n \"id\": string,\n \"primaryDomain\": string,\n \"name\": string,\n \"administrator\": [\n {\n \"email\": string\n }\n ],\n \"enterpriseType\": string,\n \"managedGoogleDomainType\": string\n}\n```\n\n| Property name | Value | Description | Notes |\n|---------------------------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------|-------|\n| `administrator[]` | `list` | Admins of the enterprise. This is only supported for enterprises created via the EMM-initiated flow. | |\n| administrator[].`email` | `string` | The admin's email address. | |\n| `enterpriseType` | `string` | The type of the enterprise. \u003cbr /\u003e Acceptable values are: - \"`enterpriseTypeUnspecified`\" - \"`managedGoogleDomain`\" - \"`managedGooglePlayAccountsEnterprise`\" | |\n| `id` | `string` | The unique ID for the enterprise. | |\n| `kind` | `string` | | |\n| `managedGoogleDomainType` | `string` | The type of managed Google domain \u003cbr /\u003e Acceptable values are: - \"`managedGoogleDomainTypeUnspecified`\" - \"`typeDomain`\" - \"`typeTeam`\" | |\n| `name` | `string` | The name of the enterprise, for example, \"Example, Inc\". | |\n| `primaryDomain` | `string` | The enterprise's primary domain, such as \"example.com\". | |\n\nMethods\n-------\n\n[acknowledgeNotificationSet](/android/work/play/emm-api/v1/enterprises/acknowledgeNotificationSet)\n: Acknowledges notifications that were received from\n Enterprises.PullNotificationSet to prevent subsequent calls from returning\n the same notifications.\n\n[completeSignup](/android/work/play/emm-api/v1/enterprises/completeSignup)\n: Completes the signup flow, by specifying the Completion token and\n Enterprise token.\n This request must not be called multiple times for a given Enterprise\n Token.\n\n[createWebToken](/android/work/play/emm-api/v1/enterprises/createWebToken)\n: Returns a unique token to access an embeddable UI. To generate a\n web UI, pass the generated token into the managed Google Play javascript\n API. Each token may only be used to start one UI session. See the\n [JavaScript API documentation](https://developers.google.com/api-client-library/javascript/apis/androidenterprise/v1) for further information.\n\n[enroll](/android/work/play/emm-api/v1/enterprises/enroll)\n: Enrolls an enterprise with the calling EMM.\n\n[generateEnterpriseUpgradeUrl](/android/work/play/emm-api/v1/enterprises/generateEnterpriseUpgradeUrl)\n: Generates an enterprise upgrade URL to upgrade an existing managed Google\n Play Accounts enterprise to a managed Google domain.\n See [the guide to upgrading an enterprise](/android/work/play/emm-api/upgrade-an-enterprise) for more details.\n\n[generateSignupUrl](/android/work/play/emm-api/v1/enterprises/generateSignupUrl)\n: Generates a sign-up URL.\n\n[get](/android/work/play/emm-api/v1/enterprises/get)\n: Retrieves the name and domain of an enterprise.\n\n[getServiceAccount](/android/work/play/emm-api/v1/enterprises/getServiceAccount)\n: Returns a service account and credentials. The service account\n can be bound to the enterprise by calling setAccount. The service account\n is unique to this enterprise and EMM, and will be deleted if the enterprise\n is unbound. The credentials contain private key data and are not stored\n server-side.\n\n \u003cbr /\u003e\n\n\n This method can only be called after calling\n Enterprises.Enroll or Enterprises.CompleteSignup, and before\n Enterprises.SetAccount; at other times it will return an error.\n\n \u003cbr /\u003e\n\n\n Subsequent calls after the first will generate a new, unique set of\n credentials, and invalidate the previously generated credentials.\n\n \u003cbr /\u003e\n\n\n Once the service account is bound to the enterprise, it can be managed\n using the serviceAccountKeys resource.\n\n \u003cbr /\u003e\n\n\n \u003cbr /\u003e\n\n | **Note:** After you create a key, you might need to wait for 60 seconds or more before you perform another operation with the key. If you try to perform an operation with the key immediately after you create the key, and you receive an error, you can [retry\n | the request with exponential backoff](https://cloud.google.com/iam/docs/retry-strategy)\n\n \u003cbr /\u003e\n\n .\n\n[getStoreLayout](/android/work/play/emm-api/v1/enterprises/getStoreLayout)\n: Returns the store layout for the enterprise. If the store layout\n has not been set, returns \"basic\" as the store layout type and no\n homepage.\n\n[list](/android/work/play/emm-api/v1/enterprises/list)\n: Looks up an enterprise by domain name.\n This is only supported for enterprises created via the Google-initiated\n creation flow. Lookup of the id is not needed for enterprises created via\n the EMM-initiated flow since the EMM learns the enterprise ID in the\n callback specified in the Enterprises.generateSignupUrl call.\n\n[pullNotificationSet](/android/work/play/emm-api/v1/enterprises/pullNotificationSet)\n: Pulls and returns a notification set for the enterprises associated with\n the service account authenticated for the request. The notification set may\n be empty if no notification are pending.\n\n\n A notification set returned needs to be acknowledged within 20 seconds\n by calling Enterprises.AcknowledgeNotificationSet, unless the\n notification set is empty.\n\n\n Notifications that are not acknowledged within the 20 seconds will\n eventually be included again in the response to another PullNotificationSet\n request, and those that are never acknowledged will ultimately be deleted\n according to the Google Cloud Platform Pub/Sub system policy.\n\n\n Multiple requests might be performed concurrently to retrieve\n notifications, in which case the pending notifications (if any) will be\n split among each caller, if any are pending.\n\n\n If no notifications are present, an empty notification list is returned.\n Subsequent requests may return more notifications once they become\n available.\n\n[sendTestPushNotification](/android/work/play/emm-api/v1/enterprises/sendTestPushNotification)\n: Sends a test notification to validate the EMM integration with\n the Google Cloud Pub/Sub service for this enterprise.\n\n[setAccount](/android/work/play/emm-api/v1/enterprises/setAccount)\n: Sets the account that will be used to authenticate to the API as the\n enterprise.\n\n[setStoreLayout](/android/work/play/emm-api/v1/enterprises/setStoreLayout)\n: Sets the store layout for the enterprise. By default, storeLayoutType\n is set to \"basic\" and the basic store layout is enabled. The basic\n layout only contains apps approved by the admin, and that have\n been added to the available product set for a user (using the\n [setAvailableProductSet](/android/work/play/emm-api/v1/users/setAvailableProductSet) call). Apps on the page are sorted in order of\n their product ID value. If you create a custom store layout (by setting\n storeLayoutType = \"custom\" and setting a homepage), the basic store\n layout is disabled.\n\n[unenroll](/android/work/play/emm-api/v1/enterprises/unenroll)\n: Unenrolls an enterprise from the calling EMM."]]
