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
eEnterprises.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
eEnterprises.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.
{ "kind": "androidenterprise#enterprise", "id":string , "primaryDomain":string , "name":string , "administrator": [ { "email":string } ], "enterpriseType":string , "managedGoogleDomainType":string }
Nome da propriedade | Valor | Descrição | Observações |
---|---|---|---|
administrator[] |
list |
Administradores da empresa. Isso só é aceito para empresas criadas pelo fluxo iniciado pelo EMM. |
|
administrator[].email |
string |
O endereço de e-mail do administrador. | |
enterpriseType |
string |
O tipo de empresa.
Os valores aceitáveis são:
|
|
id |
string |
O ID exclusivo da empresa. |
|
kind |
string |
||
managedGoogleDomainType |
string |
O tipo de domínio gerenciado do Google
Os valores aceitáveis são:
|
|
name |
string |
O nome da empresa, por exemplo, "Exemplo Ltda". | |
primaryDomain |
string |
O domínio principal da empresa, como "example.com". |
Métodos
- acknowledgeNotificationSet
- Confirma as notificações recebidas de Enterprises.PullNotificationSet para evitar que chamadas subsequentes retornem as mesmas notificações.
- completeSignup
- Conclui o fluxo de inscrição especificando o token de conclusão e o token empresarial. Essa solicitação não pode ser chamada várias vezes para um determinado token Enterprise.
- createWebToken
- 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.
- inscrição
- Inscreve uma empresa no EMM de chamada.
- generateSignupUrl
- Gera um URL de inscrição.
- get
- Extrai o nome e o domínio de uma empresa.
- getServiceAccount
- 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 depois de 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. - getStoreLayout
- 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.
- list
- 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 aprende o ID da empresa no callback especificado na chamada Enterprises.generateSignupUrl.
- pullNotificationSet
- 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. - sendTestPushNotification
- Envia uma notificação de teste para validar a integração do EMM com o serviço Google Cloud Pub/Sub para essa empresa.
- setAccount
- Define a conta que será usada para autenticar na API como a empresa.
- setStoreLayout
- 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 (definindo storeLayoutType = "custom" e definindo uma página inicial), o layout básico será desativado.
- Cancelar inscrição
- Cancela a inscrição de uma empresa no EMM de chamada.