Important : Nous n'acceptons plus de nouvelles inscriptions à l'API EMM Play.
En savoir plus
Enterprises
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
La liste des méthodes associées à cette ressource est présentée au bas de la page.
Représentations de la ressource
Une ressource Enterprise représente l'association entre un EMM et une organisation spécifique. Cette liaison peut être instanciée de deux manières différentes à l'aide de cette API, comme suit:
- Pour les clients disposant d'un domaine géré par Google, le processus implique d'utiliser
Enterprises.enroll et Enterprises.setAccount (en plus des artefacts obtenus à partir de la console d'administration et de la console Google API) et d'envoyer les informations à l'EMM via un processus plus ou moins manuel. - Pour les clients disposant de comptes Google Play gérés, le processus consiste à utiliser
Enterprises.generateSignupUrl et Enterprises.completeSignup en conjonction avec l'UI de connexion Google Play gérée (mécanisme fourni par Google) pour créer l'association sans étapes manuelles.
En tant qu'EMM, vous pouvez accepter l'une ou les deux approches dans votre console EMM. Pour en savoir plus, consultez Créer une entreprise.
{
"kind": "androidenterprise#enterprise",
"id": string,
"primaryDomain": string,
"name": string,
"administrator": [
{
"email": string
}
],
"enterpriseType": string,
"managedGoogleDomainType": string
}
| Nom de propriété |
Valeur |
Description |
Remarques |
administrator[] |
list |
Administrateurs de l'entreprise Cette fonctionnalité n'est disponible que pour les entreprises créées via le flux lancé par l'EMM.
|
|
administrator[].email |
string |
Adresse e-mail de l'administrateur. |
|
enterpriseType |
string |
Type d'entreprise.
Les valeurs acceptées sont les suivantes :
- "
enterpriseTypeUnspecified"
- "
managedGoogleDomain"
- "
managedGooglePlayAccountsEnterprise"
|
|
id |
string |
Identifiant unique de l'entreprise.
|
|
kind |
string |
|
|
managedGoogleDomainType |
string |
Type de domaine Google géré
Les valeurs acceptées sont les suivantes :
- "
managedGoogleDomainTypeUnspecified"
- "
typeDomain"
- "
typeTeam"
|
|
name |
string |
Nom de l'entreprise, par exemple "Exemple, Inc". |
|
primaryDomain |
string |
Domaine principal de l'entreprise, par exemple "example.com". |
|
Méthodes
- acknowledgeNotificationSet
- Confirme les notifications reçues de Enterprise.PullNotificationSet pour empêcher les appels suivants de renvoyer les mêmes notifications.
- completeSignup
- Termine le parcours d'inscription en spécifiant le jeton de finalisation et le jeton d'entreprise.
Cette requête ne doit pas être appelée plusieurs fois pour un jeton d'entreprise donné.
- createWebToken
- Renvoie un jeton unique pour accéder à une UI intégrée. Pour générer une UI Web, transmettez le jeton généré à l'API JavaScript Google Play gérée. Chaque jeton ne peut être utilisé que pour démarrer une seule session d'interface utilisateur. Pour en savoir plus, consultez la
Documentation de l'API JavaScript.
- s'inscrire
- Inscris une entreprise auprès de l'EMM appelant.
- generateEnterpriseUpgradeUrl
- Génère une URL de mise à niveau d'entreprise pour mettre à niveau un compte d'entreprise Google Play Accounts existant vers un domaine Google géré.
Pour en savoir plus, consultez le
guide de mise à niveau d'une entreprise.
- generateSignupUrl
- Génère une URL d'inscription.
- get
- Récupère le nom et le domaine d'une entreprise.
- getServiceAccount
- Renvoie un compte de service et des identifiants. Le compte de service peut être associé à l'entreprise en appelant setAccount. Le compte de service est propre à cette entreprise et à l'EMM, et sera supprimé si l'entreprise n'est plus associée. Les identifiants contiennent des données de clé privée et ne sont pas stockés côté serveur.
Cette méthode ne peut être appelée qu'après l'appel de Enterprises.Enroll ou Enterprises.CompleteSignup, et avant Enterprises.SetAccount. Dans le cas contraire, elle renvoie une erreur.
Les appels suivants après le premier génèrent un nouvel ensemble d'identifiants uniques et invalident les identifiants précédemment générés.
Une fois le compte de service associé à l'entreprise, il peut être géré à l'aide de la ressource serviceAccountKeys.
.
- getStoreLayout
- Renvoie la mise en page du magasin pour l'entreprise. Si la mise en page du magasin n'a pas été définie, le type de mise en page du magasin est défini sur "standard" et aucune page d'accueil n'est renvoyée.
- liste
- Recherche une entreprise par nom de domaine.
Cette fonctionnalité n'est disponible que pour les entreprises créées via le flux de création lancé par Google. La recherche de l'ID n'est pas nécessaire pour les entreprises créées via le flux initié par l'EMM, car l'EMM apprend l'ID de l'entreprise dans le rappel spécifié dans l'appel Enterprises.generateSignupUrl.
- pullNotificationSet
- Récupère et renvoie un ensemble de notifications pour les entreprises associées au compte de service authentifié pour la requête. L'ensemble de notifications peut être vide si aucune notification n'est en attente.
Un ensemble de notifications renvoyé doit être confirmé dans un délai de 20 secondes en appelant Enterprises.AcknowledgeNotificationSet, sauf si l'ensemble de notifications est vide.
Les notifications qui ne sont pas confirmées dans un délai de 20 secondes seront finalement incluses à nouveau dans la réponse à une autre requête PullNotificationSet. Celles qui ne sont jamais confirmées seront finalement supprimées conformément au règlement du système Pub/Sub de Google Cloud Platform.
Des requêtes multiples peuvent être effectuées simultanément pour récupérer des notifications. Dans ce cas, les notifications en attente (le cas échéant) seront réparties entre chaque appelant.
Si aucune notification n'est présente, une liste de notifications vide est renvoyée.
Les requêtes ultérieures peuvent renvoyer d'autres notifications une fois qu'elles sont disponibles.
- sendTestPushNotification
- Envoi d'une notification de test pour valider l'intégration de l'EMM au service Google Cloud Pub/Sub de cette entreprise.
- setAccount
- Définit le compte qui sera utilisé pour s'authentifier auprès de l'API en tant qu'entreprise.
- setStoreLayout
- Définit la mise en page du magasin pour l'entreprise. Par défaut, storeLayoutType est défini sur "basic" (standard) et la mise en page de base est activée. La mise en page de base ne contient que les applications approuvées par l'administrateur et qui ont été ajoutées à l'ensemble de produits disponibles pour un utilisateur (à l'aide de l'appel
setAvailableProductSet). Les applications de la page sont triées par ordre de valeur de l'ID produit. Si vous créez une mise en page de magasin personnalisée (en définissant storeLayoutType = "custom" et en définissant une page d'accueil), la mise en page de magasin de base est désactivée.
- désinscription
- Désinscrit une entreprise de l'EMM appelant.
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/07/28 (UTC).
[null,null,["Dernière mise à jour le 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."]]
