Importante: não aceitamos mais novos registros para a API Play EMM. Saiba mais.

API Reference

Esta referência da API está organizada por tipo de recurso. Cada tipo de recurso tem uma ou mais representações de dados e um ou mais métodos.

Tipos de recurso

  1. Dispositivos
  2. Empresas
  3. Direitos
  4. Licenças de grupo
  5. GroupLicenseusers
  6. Instalações
  7. Managedgerenciados para o dispositivo
  8. Managedgerenciados para o usuário
  9. Configurações gerenciadas
  10. Permissões
  11. Produtos
  12. Chaves de conta de serviço
  13. Storelayoutclusters
  14. Storelayoutpages
  15. Usuários
  16. Apps da Web

Dispositivos

Para saber mais sobre o recurso Devices, consulte a página de representação do recurso.

Método Solicitação HTTP Descrição
URIs relacionados a https://www.googleapis.com/androidenterprise/v1, a menos que especificado de outra forma
forceReportUpload (link em inglês) POST  /enterprises/enterpriseId/users/userId/devices/deviceId/forceReportUpload Faz upload de um relatório contendo alterações nos estados do aplicativo no dispositivo desde que o último relatório foi gerado. Esse método pode ser chamado até três vezes a cada 24 horas para um determinado dispositivo.
get GET  /enterprises/enterpriseId/users/userId/devices/deviceId Recupera os detalhes de um dispositivo.
getState (em inglês) GET  /enterprises/enterpriseId/users/userId/devices/deviceId/state Recupera se o acesso de um dispositivo aos serviços do Google está ativado ou desativado. O estado do dispositivo só vai entrar em vigor se a aplicação das políticas de EMM em dispositivos Android estiver ativada no Google Admin Console. Caso contrário, o estado do dispositivo será ignorado e todos os dispositivos terão permissão para acessar os serviços do Google. Isso só é compatível com usuários gerenciados pelo Google.
list GET  /enterprises/enterpriseId/users/userId/devices Recupera os IDs de todos os dispositivos de um usuário.
setState. PUT  /enterprises/enterpriseId/users/userId/devices/deviceId/state Define se o acesso de um dispositivo aos serviços do Google será ativado ou desativado. O estado do dispositivo só vai entrar em vigor se a aplicação das políticas de EMM em dispositivos Android estiver ativada no Google Admin Console. Caso contrário, o estado do dispositivo será ignorado e todos os dispositivos terão permissão para acessar os serviços do Google. Isso só é compatível com usuários gerenciados pelo Google.
update PUT  /enterprises/enterpriseId/users/userId/devices/deviceId Atualiza a política do dispositivo.

Para garantir que a política seja aplicada corretamente, você precisa impedir que contas não gerenciadas acessem o Google Play definindo allowed_accounts na configuração gerenciada do pacote Google Play. Consulte Restringir contas no Google Play.

Empresas

Para saber mais sobre o Enterprise, consulte a página de representação do recurso.

Método Solicitação HTTP Descrição
URIs relacionados a https://www.googleapis.com/androidenterprise/v1, a menos que especificado de outra forma
acKnowledgeNotificationSet (em inglês) POST  /enterprises/acknowledgeNotificationSet Reconhece as notificações que foram recebidas de Enterprises.PullNotificationSet para impedir que chamadas subsequentes retornem as mesmas notificações.
completesignup (em inglês) POST  /enterprises/completeSignup Concluir 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 corporativo.
createWebToken (em inglês) POST  /enterprises/enterpriseId/createWebToken Retorna um token exclusivo para acessar uma IU incorporável. Para gerar uma IU 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 IU. Consulte a documentação da API JavaScript para mais informações.
cadastre-se POST  /enterprises/enroll Registra uma empresa com o EMM que faz a chamada.

Parâmetros de consulta obrigatórios:token

generateUrlUrl POST  /enterprises/signupUrl Gera um URL de inscrição.
get GET  /enterprises/enterpriseId Recupera o nome e o domínio de uma empresa.
getServiceAccount. GET  /enterprises/enterpriseId/serviceAccount 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 desta empresa e do 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 lado do servidor.

Esse método só pode ser chamado depois de chamar Enterprises.Enrollment ou Enterprises.CompleteEnrollment e antes de Enterprises.SetAccount. Em outros casos, ele retornará um erro.

As chamadas subsequentes após a primeira vão gerar um novo conjunto exclusivo de credenciais e invalidar as que já foram geradas.

Depois que a conta de serviço for vinculada à empresa, ela poderá ser gerenciada usando o recurso serviceAccountKeys.
getStoreLayout (link em inglês) GET  /enterprises/enterpriseId/storeLayout Retorna o layout da loja para a empresa. Se o layout da loja não tiver sido definido, será retornado "basic" como o tipo de layout da loja, e nenhuma página inicial.
list GET  /enterprises Procura uma empresa por nome de domínio. Isso só é compatível com 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, porque o EMM aprende o ID do Enterprise no callback especificado na chamada Enterprises.generatesignupUrl.

Parâmetros de consulta obrigatórios:domain

PullNotificationSet (link em inglês) POST  /enterprises/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 estar 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 nos 20 segundos serão incluídas novamente na resposta a outra solicitação PullNotificationSet, e as que nunca forem confirmadas serão excluídas de acordo com a política do sistema do 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 alguma pendente.
Se não houver notificações, uma lista de notificações vazia será retornada. As próximas solicitações poderão retornar mais notificações assim que estiverem disponíveis.
sendTestPushNotification (link em inglês) POST  /enterprises/enterpriseId/sendTestPushNotification Envia uma notificação de teste para validar a integração do EMM com o serviço do Google Cloud Pub/Sub para esta empresa.
setAccount. PUT  /enterprises/enterpriseId/account Define a conta que será usada para autenticar na API como a empresa.
setStoreLayout (link em inglês) PUT  /enterprises/enterpriseId/storeLayout Define o layout da loja para a empresa. Por padrão, storeLayoutType é definido como "basic" e o layout básico de armazenamento é ativado. O layout básico contém apenas apps aprovados pelo administrador e que foram adicionados ao conjunto de produtos disponível para um usuário (usando a chamada setAvailableProductSet). Os apps na página são classificados na ordem do valor do ID do produto. Se você criar um layout de armazenamento personalizado definindo storeLayoutType = "custom" e uma página inicial, esse layout básico vai ser desativado.
cancelar inscrição POST  /enterprises/enterpriseId/unenroll Cancela o registro de uma empresa no EMM que faz a chamada.

Direitos

Para ver detalhes sobre os recursos de direitos, consulte a página de representação do recurso.

Método Solicitação HTTP Descrição
URIs relacionados a https://www.googleapis.com/androidenterprise/v1, a menos que especificado de outra forma
delete DELETE  /enterprises/enterpriseId/users/userId/entitlements/entitlementId Remove um direito para um app de um usuário. Observação: este item foi descontinuado. Novas integrações não podem usar esse método e podem consultar nossas novas recomendações.
get GET  /enterprises/enterpriseId/users/userId/entitlements/entitlementId Recupera detalhes de um direito. Observação: este item foi descontinuado. Novas integrações não podem usar esse método e podem consultar nossas novas recomendações.
list GET  /enterprises/enterpriseId/users/userId/entitlements Lista todos os direitos do usuário especificado. Apenas o ID é definido. Observação: este item foi descontinuado. Novas integrações não podem usar esse método e podem consultar nossas novas recomendações.
update PUT  /enterprises/enterpriseId/users/userId/entitlements/entitlementId Adiciona ou atualiza um direito a um app para um usuário. Observação: este item foi descontinuado. Novas integrações não podem usar esse método e podem consultar nossas novas recomendações.

Licenças de grupo

Para saber mais sobre o recurso Grouplicenses, consulte a página de representação do recurso.

Método Solicitação HTTP Descrição
URIs relacionados a https://www.googleapis.com/androidenterprise/v1, a menos que especificado de outra forma
get GET  /enterprises/enterpriseId/groupLicenses/groupLicenseId Recupera detalhes da licença de grupo de uma empresa para um produto. Observação: este item foi descontinuado. Novas integrações não podem usar esse método e podem consultar nossas novas recomendações.
list GET  /enterprises/enterpriseId/groupLicenses Recupera IDs de todos os produtos para os quais a empresa tem uma licença de grupo. Observação: este item foi descontinuado. Novas integrações não podem usar esse método e podem consultar nossas novas recomendações.

Usuários em licença de grupo

Para saber mais sobre o recurso GroupLicenseusers, consulte a página Representação de recursos.

Método Solicitação HTTP Descrição
URIs relacionados a https://www.googleapis.com/androidenterprise/v1, a menos que especificado de outra forma
list GET  /enterprises/enterpriseId/groupLicenses/groupLicenseId/users Recupera os IDs dos usuários que receberam direitos de acordo com a licença. Observação: este item foi descontinuado. Novas integrações não podem usar esse método e podem consultar nossas novas recomendações.

Instalações

Para detalhes sobre "Installs Resource", consulte a página representação de recursos.

Método Solicitação HTTP Descrição
URIs relacionados a https://www.googleapis.com/androidenterprise/v1, a menos que especificado de outra forma
delete DELETE  /enterprises/enterpriseId/users/userId/devices/deviceId/installs/installId Solicitações para remover um app de um dispositivo. Uma chamada para get ou list ainda vai mostrar o app instalado no dispositivo até que ele seja realmente removido.
get GET  /enterprises/enterpriseId/users/userId/devices/deviceId/installs/installId Recupera detalhes de uma instalação de um app em um dispositivo.
list GET  /enterprises/enterpriseId/users/userId/devices/deviceId/installs Recupera os detalhes de todos os apps instalados no dispositivo especificado.
update PUT  /enterprises/enterpriseId/users/userId/devices/deviceId/installs/installId Solicitações para instalar a versão mais recente de um app em um dispositivo. Se o app já estiver instalado, ele será atualizado para a versão mais recente, se necessário.

Configurações gerenciadas para dispositivos

Para saber mais sobre o recurso Managedconfigurationsfordevice, consulte a página de representação do recurso.

Método Solicitação HTTP Descrição
URIs relacionados a https://www.googleapis.com/androidenterprise/v1, a menos que especificado de outra forma
delete DELETE  /enterprises/enterpriseId/users/userId/devices/deviceId/managedConfigurationsForDevice/managedConfigurationForDeviceId Remove uma configuração gerenciada por dispositivo para um app no dispositivo especificado.
get GET  /enterprises/enterpriseId/users/userId/devices/deviceId/managedConfigurationsForDevice/managedConfigurationForDeviceId Recupera detalhes de uma configuração gerenciada por dispositivo.
list GET  /enterprises/enterpriseId/users/userId/devices/deviceId/managedConfigurationsForDevice Lista todas as configurações gerenciadas por dispositivo para o dispositivo especificado. Apenas o ID é definido.
update PUT  /enterprises/enterpriseId/users/userId/devices/deviceId/managedConfigurationsForDevice/managedConfigurationForDeviceId Adiciona ou atualiza uma configuração gerenciada por dispositivo para um app para o dispositivo especificado.

Configurações gerenciadas para o usuário

Para saber mais sobre o recurso Managedconfigurationsforuser, consulte a página de representação do recurso.

Método Solicitação HTTP Descrição
URIs relacionados a https://www.googleapis.com/androidenterprise/v1, a menos que especificado de outra forma
delete DELETE  /enterprises/enterpriseId/users/userId/managedConfigurationsForUser/managedConfigurationForUserId Remove uma configuração gerenciada por usuário de um app para o usuário especificado.
get GET  /enterprises/enterpriseId/users/userId/managedConfigurationsForUser/managedConfigurationForUserId Recupera detalhes de uma configuração gerenciada por usuário para um app para o usuário especificado.
list GET  /enterprises/enterpriseId/users/userId/managedConfigurationsForUser Lista todas as configurações gerenciadas por usuário para o usuário especificado. Somente o ID é definido.
update PUT  /enterprises/enterpriseId/users/userId/managedConfigurationsForUser/managedConfigurationForUserId Adiciona ou atualiza as definições de configuração gerenciadas de um app para o usuário especificado. Se você oferece suporte ao iframe de configurações gerenciadas, é possível aplicar configurações gerenciadas a um usuário especificando um mcmId e as variáveis de configuração associadas (se houver) na solicitação. Como alternativa, todos os EMMs podem aplicar configurações gerenciadas transmitindo uma lista de propriedades gerenciadas.

Configurações gerenciadas

Para saber mais sobre o recurso Managedconfigurationssettings, consulte a página de representação do recurso.

Método Solicitação HTTP Descrição
URIs relacionados a https://www.googleapis.com/androidenterprise/v1, a menos que especificado de outra forma
list GET  /enterprises/enterpriseId/products/productId/managedConfigurationsSettings Lista todas as configurações gerenciadas para o app especificado.

Permissões

Para detalhes sobre o recurso Permissions, consulte a página Representação do recurso.

Método Solicitação HTTP Descrição
URIs relacionados a https://www.googleapis.com/androidenterprise/v1, a menos que especificado de outra forma
get GET  /permissions/permissionId Recupera detalhes de uma permissão do app Android para exibição a um administrador da empresa.

Produtos

Para saber mais sobre o recurso Products, consulte a página representação de recursos.

Método Solicitação HTTP Descrição
URIs relacionados a https://www.googleapis.com/androidenterprise/v1, a menos que especificado de outra forma
aprovar POST  /enterprises/enterpriseId/products/productId/approve

Aprova o produto especificado e as permissões relevantes do app, se houver. O número máximo de produtos que podem ser aprovados por cliente corporativo é 1.000.

Para saber como usar o Google Play gerenciado ao criar e criar um layout de loja para exibir produtos aprovados aos usuários, consulte Design de layout da loja.

Observação: este item foi descontinuado. Novas integrações não podem usar esse método e podem consultar nossas novas recomendações.
generateApprovalUrl POST  /enterprises/enterpriseId/products/productId/generateApprovalUrl Gera um URL que pode ser renderizado em um iframe para exibir as permissões (se houver) de um produto. Um administrador corporativo precisa ver essas permissões e aceitá-las em nome da organização para aprovar esse produto.

Os administradores precisam aceitar as permissões exibidas interagindo com um elemento de IU separado no console de EMM, o que aciona o uso desse URL como a propriedade approvalUrlInfo.approvalUrl em uma chamada Products.approve para aprovar o produto. Esse URL só pode ser usado para exibir permissões por até um dia. Observação: este item foi descontinuado. Novas integrações não podem usar esse método e podem consultar nossas novas recomendações.
get GET  /enterprises/enterpriseId/products/productId Recupera detalhes de um produto para exibição a um administrador da empresa.
getAppRestrictionsSchema GET  /enterprises/enterpriseId/products/productId/appRestrictionsSchema Recupera o esquema que define as propriedades configuráveis desse produto. Todos os produtos têm um esquema, mas ele pode estar vazio se nenhuma configuração gerenciada tiver sido definida. Esse esquema pode ser usado para preencher uma IU que permite ao administrador configurar o produto. Para aplicar uma configuração gerenciada com base no esquema recebido ao usar essa API, consulte Configurações gerenciadas pelo Google Play.
getPermissions (em inglês) GET  /enterprises/enterpriseId/products/productId/permissions Recupera as permissões de apps Android exigidas por esse app.
list GET  /enterprises/enterpriseId/products Encontra os produtos aprovados que correspondem a uma consulta ou todos os produtos aprovados se não houver uma consulta. Observação: este item foi descontinuado. Novas integrações não podem usar esse método e podem consultar nossas novas recomendações.
reprovar POST  /enterprises/enterpriseId/products/productId/unapprove Desaprova o produto especificado e as permissões de app relevantes, se houver. Observação: o uso deste item foi descontinuado. Novas integrações não podem usar esse método e podem consultar nossas novas recomendações.

Chaves da conta de serviço

Para saber mais sobre o recurso Serviceaccountkeys, consulte a página de representação do recurso.

Método Solicitação HTTP Descrição
URIs relacionados a https://www.googleapis.com/androidenterprise/v1, a menos que especificado de outra forma
delete DELETE  /enterprises/enterpriseId/serviceAccountKeys/keyId Remove e invalida as credenciais especificadas para a conta de serviço associada a essa empresa. A conta de serviço de chamada precisa ter sido recuperada ao chamar Enterprises.GetServiceAccount e ser definida como a conta de serviço corporativa chamando Enterprises.SetAccount.
inserir POST  /enterprises/enterpriseId/serviceAccountKeys Gera novas credenciais para a conta de serviço associada a essa empresa. A conta de serviço de chamada precisa ter sido recuperada chamando Enterprises.GetServiceAccount e ter sido definida como a conta de serviço corporativa chamando Enterprises.SetAccount.

Somente o tipo da chave precisa ser preenchido no recurso a ser inserido.
list GET  /enterprises/enterpriseId/serviceAccountKeys Lista todas as credenciais ativas para a conta de serviço associada a essa empresa. Somente o ID e o tipo de chave são retornados. A conta de serviço de chamada precisa ter sido chamada chamando Enterprises.GetServiceAccount e ter sido definida como a conta de serviço corporativa chamando Enterprises.SetAccount.

Clusters de layout de loja

Para saber mais sobre o recurso Storelayoutclusters, consulte a página de representação do recurso.

Método Solicitação HTTP Descrição
URIs relacionados a https://www.googleapis.com/androidenterprise/v1, a menos que especificado de outra forma
delete DELETE  /enterprises/enterpriseId/storeLayout/pages/pageId/clusters/clusterId Exclui um cluster.
get GET  /enterprises/enterpriseId/storeLayout/pages/pageId/clusters/clusterId Recupera detalhes de um cluster.
inserir POST  /enterprises/enterpriseId/storeLayout/pages/pageId/clusters Insere um novo cluster em uma página.
list GET  /enterprises/enterpriseId/storeLayout/pages/pageId/clusters Recupera os detalhes de todos os clusters na página especificada.
update PUT  /enterprises/enterpriseId/storeLayout/pages/pageId/clusters/clusterId Atualiza um cluster.

Páginas de layout da loja

Para saber mais sobre o recurso Storelayoutpages, consulte a página Representação de recursos.

Método Solicitação HTTP Descrição
URIs relacionados a https://www.googleapis.com/androidenterprise/v1, a menos que especificado de outra forma
delete DELETE  /enterprises/enterpriseId/storeLayout/pages/pageId Exclui uma página da loja.
get GET  /enterprises/enterpriseId/storeLayout/pages/pageId Recupera detalhes de uma página da loja.
inserir POST  /enterprises/enterpriseId/storeLayout/pages Insere uma nova página da loja.
list GET  /enterprises/enterpriseId/storeLayout/pages Recupera os detalhes de todas as páginas na loja.
update PUT  /enterprises/enterpriseId/storeLayout/pages/pageId Atualiza o conteúdo de uma página da loja.

Usuários

Para detalhes do recurso "Users", consulte a página representação de recursos.

Método Solicitação HTTP Descrição
URIs relacionados a https://www.googleapis.com/androidenterprise/v1, a menos que especificado de outra forma
delete DELETE  /enterprises/enterpriseId/users/userId Um usuário gerenciado por EMM foi excluído.
generateAuthenticationToken POST  /enterprises/enterpriseId/users/userId/authenticationToken Gera um token de autenticação que o cliente de política do dispositivo pode usar para provisionar a conta de usuário gerenciada pelo EMM em um dispositivo. O token gerado é de uso único e expira após alguns minutos.

É possível provisionar no máximo 10 dispositivos por usuário.

Esta chamada só funciona com contas gerenciadas pelo EMM.
get GET  /enterprises/enterpriseId/users/userId Recupera os detalhes de um usuário.
getAvailableProductSet (em inglês) GET  /enterprises/enterpriseId/users/userId/availableProductSet Recupera o conjunto de produtos aos quais um usuário tem direito de acesso. Observação: este item foi descontinuado. Novas integrações não podem usar esse método e podem consultar nossas novas recomendações.
inserir POST  /enterprises/enterpriseId/users Cria um novo usuário gerenciado por EMM.

O recurso Users transmitido no corpo da solicitação precisa incluir um accountIdentifier e um accountType.

Se já houver um usuário correspondente com o mesmo identificador de conta, ele será atualizado com o recurso. Nesse caso, apenas o campo displayName pode ser alterado.

list GET  /enterprises/enterpriseId/users Procura um usuário pelo endereço de e-mail principal. Isso só é compatível com usuários gerenciados pelo Google. A pesquisa do ID não é necessária para usuários gerenciados pelo EMM porque o ID já foi retornado no resultado da chamada Users.insert.

Parâmetros de consulta obrigatórios: email

revokeDeviceAccess (em inglês) DELETE  /enterprises/enterpriseId/users/userId/deviceAccess Revoga o acesso a todos os dispositivos provisionados ao usuário. O usuário não vai mais poder usar a Play Store gerenciada em nenhum dispositivo gerenciado.

Esta chamada só funciona com contas gerenciadas pelo EMM.
setAvailableProductSet (em inglês) PUT  /enterprises/enterpriseId/users/userId/availableProductSet Modifica o conjunto de produtos que um usuário tem permissão para acessar, chamados de produtos permitidos. Somente produtos aprovados ou que foram aprovados anteriormente (produtos com aprovação revogada) podem ser permitidos. Observação: este item foi descontinuado. Novas integrações não podem usar esse método e podem consultar nossas novas recomendações.
update PUT  /enterprises/enterpriseId/users/userId Atualiza os detalhes de um usuário gerenciado por EMM.

Pode ser usado apenas com usuários gerenciados pelo EMM, e não pelo Google. Transmita os novos detalhes no recurso Usuários no corpo da solicitação. Somente o campo displayName pode ser alterado. Outros campos precisam não ser definidos ou ter o valor ativo no momento.

Apps da Web

Para saber mais sobre o recurso Webapps, consulte a página de representação do recurso.

Método Solicitação HTTP Descrição
URIs relacionados a https://www.googleapis.com/androidenterprise/v1, a menos que especificado de outra forma
delete DELETE  /enterprises/enterpriseId/webApps/webAppId Exclui um app da Web.
get GET  /enterprises/enterpriseId/webApps/webAppId Recebe um app da Web existente.
inserir POST  /enterprises/enterpriseId/webApps Cria um novo app da Web para a empresa.
list GET  /enterprises/enterpriseId/webApps Recupera os detalhes de todos os apps da Web de uma determinada empresa.
update PUT  /enterprises/enterpriseId/webApps/webAppId Atualiza um app da Web.