Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Para ver uma lista de métodos desse recurso, consulte o final desta página.
Representações de recursos
Um recurso de empresa representa a vinculação entre um EMM e uma organização específica. Essa vinculação pode ser instanciada de duas maneiras diferentes usando essa API:
Para clientes de domínios gerenciados pelo Google, o processo envolve o uso de Enterprises.enroll e Enterprises.setAccount (em conjunto com artefatos obtidos do Admin Console e do Console de APIs do Google) e enviados ao EMM por um processo mais ou menos manual.
Para clientes de Contas do Google Play gerenciadas, o processo envolve o uso de Enterprises.generateSignupUrl e Enterprises.completeSignup em conjunto com a interface de inscrição do Google Play gerenciado (mecanismo fornecido pelo Google) para criar a vinculação sem etapas manuais.
Como EMM, você pode oferecer suporte a uma ou ambas as abordagens no console de EMM. Consulte Criar uma empresa para mais detalhes.
Conclui o fluxo de inscrição especificando o token de conclusão e
o token Enterprise.
Essa solicitação não pode ser chamada várias vezes para um determinado token
Enterprise.
Retorna um token exclusivo para acessar uma interface incorporável. Para gerar uma
interface da Web, transmita o token gerado para a API JavaScript
do Google Play gerenciado. Cada token só pode ser usado para iniciar uma sessão de interface. Consulte a
documentação da API JavaScript para mais informações.
Gera um URL de upgrade empresarial para fazer upgrade de um pacote de contas do Google Play gerenciado para um Managed Google Domain.
Consulte o
guia de upgrade de uma empresa para mais detalhes.
Retorna uma conta de serviço e credenciais. A conta de serviço
pode ser vinculada à empresa chamando setAccount. A conta de serviço
é exclusiva para essa empresa e para o EMM e será excluída se a empresa
for desvinculada. As credenciais contêm dados de chave privada e não são armazenadas
no servidor.
Esse método só pode ser chamado após chamar
Enterprises.Enroll ou Enterprises.CompleteSignup e antes de
Enterprises.SetAccount. Em outros momentos, ele vai retornar um erro.
As chamadas subsequentes à primeira vão gerar um conjunto de credenciais novo e exclusivo e invalidar as credenciais geradas anteriormente.
Depois que a conta de serviço é vinculada à empresa, ela pode ser gerenciada
usando o recurso serviceAccountKeys.
Retorna o layout da loja para a empresa. Se o layout da loja
não tiver sido definido, o tipo de layout da loja será "básico" e não haverá
página inicial.
Procura uma empresa pelo nome de domínio.
Isso só é aceito para empresas criadas pelo fluxo de criação iniciado pelo Google. A pesquisa do ID não é necessária para empresas criadas pelo
fluxo iniciado pelo EMM, já que o EMM descobre o ID da empresa no
callback especificado na chamada Enterprises.generateSignupUrl.
Extrai e retorna um conjunto de notificações para as empresas associadas à
conta de serviço autenticada para a solicitação. O conjunto de notificações pode
ficar vazio se nenhuma notificação estiver pendente.
Um conjunto de notificações retornado precisa ser confirmado em 20 segundos
chamando Enterprises.AcknowledgeNotificationSet, a menos que o
conjunto de notificações esteja vazio.
As notificações que não forem confirmadas em 20 segundos serão
incluídas novamente na resposta a outro pedido de PullNotificationSet, e as que nunca forem confirmadas serão excluídas
de acordo com a política do sistema Pub/Sub do Google Cloud Platform.
Várias solicitações podem ser realizadas simultaneamente para recuperar
notificações. Nesse caso, as notificações pendentes (se houver) serão
divididas entre cada autor da chamada, se houver.
Se não houver notificações, uma lista vazia será retornada.
As solicitações subsequentes podem retornar mais notificações quando elas estiverem
disponíveis.
Define o layout da loja para a empresa. Por padrão, storeLayoutType
é definido como "básico", e o layout básico da loja é ativado. O layout
básico contém apenas apps aprovados pelo administrador e que foram
adicionados ao conjunto de produtos disponíveis para um usuário (usando a
chamada
setAvailableProductSet). Os apps na página são classificados por
valor do ID do produto. Se você criar um layout personalizado da loja (definindo
storeLayoutType = "custom" e definindo uma página inicial), o layout básico
será desativado.
[null,null,["Última atualização 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."]]
