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. Managedconfigurationsfordevice
  8. Configurações gerenciadaspara usuário
  9. Managedconfigurationssettings
  10. Permissões
  11. Produtos
  12. Serviceaccountkeys
  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, salvo indicação em contrário
forceReportUpload POST  /enterprises/enterpriseId/users/userId/devices/deviceId/forceReportUpload Faz upload de um relatório com todas as mudanças nos estados do app no dispositivo desde que o último relatório foi gerado. Você pode chamar esse método até três vezes a cada 24 horas em um determinado dispositivo.
get GET  /enterprises/enterpriseId/users/userId/devices/deviceId Recupera os detalhes de um dispositivo.
getState 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ó entrará em vigor se a aplicação de 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 está ativado ou desativado. O estado do dispositivo só entrará em vigor se a aplicação de 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, é necessário impedir que contas não gerenciadas acessem o Google Play. Para isso, defina allowed_accounts na configuração gerenciada do pacote do Google Play. Consulte restringir contas no Google Play.

Empresas

Para saber mais sobre o recurso Enterprises, 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, salvo indicação em contrário
acknowledgeNotificationSet POST  /enterprises/acknowledgeNotificationSet Confirma as notificações recebidas de Enterprises.PullNotificationSet para evitar que chamadas subsequentes retornem as mesmas notificações.
completeSignup POST  /enterprises/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 corporativo.
createWebToken POST  /enterprises/enterpriseId/createWebToken Retorna um token exclusivo para acessar uma interface incorporável. Para gerar uma IU da Web, transmita o token gerado à 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.
inscrever-se POST  /enterprises/enroll Registra uma empresa no EMM de chamada.

Parâmetros de consulta obrigatórios: token

generateSignupUrl 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 para esta empresa e EMM e será excluída se a empresa estiver desvinculada. As credenciais contêm dados de chave privada e não são armazenadas do lado do servidor.

Esse método só pode ser chamado depois de chamar Enterprises.Inscrição ou Enterprises.CompleteInscrição e antes de Enterprises.SetAccount. Outras vezes, retornará um erro.

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

Quando a conta de serviço é vinculada à empresa, ela pode ser gerenciada usando o recurso serviceAccountKeys.
getStoreLayout GET  /enterprises/enterpriseId/storeLayout Retorna o layout da loja da empresa. Se o layout da loja não tiver sido definido, será retornado "básico" como o tipo de layout da loja, e não a página inicial.
list GET  /enterprises Procura uma empresa pelo nome de domínio. Isso só é compatível com empresas criadas por meio do 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 ele aprende o ID da empresa no callback especificado na chamada Enterprises.generateReferrerUrl.

Parâmetros de consulta obrigatórios: domain

pullNotificationSet POST  /enterprises/pullNotificationSet Extrai e retorna uma notificação definida 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.commitsNotificationSet, a menos que o conjunto de notificações esteja vazio.
As notificações que não forem confirmadas dentro de 20 segundos serão incluídas novamente na resposta a outra solicitação PullNotificationSet, e aquelas que não 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 as notificações. Nesse caso, as notificações pendentes (se houver) serão divididas entre cada autor da chamada, se houver alguma.
Se nenhuma notificação estiver presente, uma lista de notificações vazia será retornada. As solicitações seguintes poderão retornar mais notificações quando estiverem disponíveis.
sendTestPushNotification POST  /enterprises/enterpriseId/sendTestPushNotification Envia uma notificação de teste para validar a integração do EMM com o serviço Google Cloud Pub/Sub para esta empresa.
setAccount PUT  /enterprises/enterpriseId/account Define a conta que será usada para autenticação na API como a empresa.
setStoreLayout PUT  /enterprises/enterpriseId/storeLayout Define o layout da loja da empresa. Por padrão, storeLayoutType é definido como "básico" e o layout de armazenamento básico está 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 definindo uma página inicial, o layout de armazenamento básico será desativado.
cancelar inscrição POST  /enterprises/enterpriseId/unenroll Cancela a inscrição de uma empresa no EMM de chamada.

Direitos

Para detalhes do recurso Entitlements, 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, salvo indicação em contrário
excluir DELETE  /enterprises/enterpriseId/users/userId/entitlements/entitlementId Remove o direito de um usuário a um app. 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 de 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, salvo indicação em contrário
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áriosdelicenciamento de grupo

Para saber mais sobre o recurso Grouplicenseusers, 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, salvo indicação em contrário
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 saber mais sobre o recurso de instalações, 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, salvo indicação em contrário
excluir 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 como instalado no dispositivo até que ele seja realmente removido.
get GET  /enterprises/enterpriseId/users/userId/devices/deviceId/installs/installId Recupera detalhes da 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 gerenciadasparadispositivo

Para detalhes do 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, salvo indicação em contrário
excluir DELETE  /enterprises/enterpriseId/users/userId/devices/deviceId/managedConfigurationsForDevice/managedConfigurationForDeviceId Remove uma configuração gerenciada por dispositivo de 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 do 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 gerenciadaspara 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, salvo indicação em contrário
excluir 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ê oferecer suporte ao iframe de configurações gerenciadas, será 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 detalhes do 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, salvo indicação em contrário
list GET  /enterprises/enterpriseId/products/productId/managedConfigurationsSettings Lista todas as definições de configuração gerenciadas do 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, salvo indicação em contrário
get GET  /permissions/permissionId Recupera detalhes de uma permissão de app Android para exibição a um administrador corporativo.

Produtos

Para saber mais sobre o recurso Products, 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, salvo indicação em contrário
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.

Se quiser aprender a usar o Google Play gerenciado para projetar e criar um layout de loja para mostrar produtos aprovados aos usuários, consulte Design do 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 mostrar as permissões (se houver) de um produto. Um administrador empresarial precisa ver e aceitar essas permissões em nome da organização para aprovar o produto.

Os administradores precisam aceitar as permissões exibidas interagindo com um elemento de interface separado no console de EMM, que, por sua vez, acionará 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 mostrar 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 para este 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 interface que permite que um administrador configure o produto. Para aplicar uma configuração gerenciada com base no esquema recebido usando essa API, consulte Configurações gerenciadas pelo Google Play.
getPermissions GET  /enterprises/enterpriseId/products/productId/permissions Recupera as permissões de app Android exigidas pelo app.
list GET  /enterprises/enterpriseId/products Encontra produtos aprovados que correspondem a uma consulta ou todos os produtos aprovados se não houver consulta. Observação: este item foi descontinuado. Novas integrações não podem usar esse método e podem consultar nossas novas recomendações.
não aprovar POST  /enterprises/enterpriseId/products/productId/unapprove Não aprova o produto especificado (e as permissões do app relevantes, se houver) Observação: este 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, salvo indicação em contrário
excluir DELETE  /enterprises/enterpriseId/serviceAccountKeys/keyId Remove e invalida as credenciais especificadas para a conta de serviço associada a esta 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 empresarial chamando Enterprises.SetAccount.
inserir POST  /enterprises/enterpriseId/serviceAccountKeys Gera novas credenciais para a conta de serviço associada a esta empresa. A conta de serviço de chamada precisa ter sido recuperada chamando Enterprises.GetServiceAccount e precisa ter sido definida como a conta de serviço empresarial chamando Enterprises.SetAccount.

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

Storelayoutclusters

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

Método Solicitação HTTP Descrição
URIs relacionados a https://www.googleapis.com/androidenterprise/v1, salvo indicação em contrário
excluir 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.

Storelayoutpages

Para saber mais sobre o recurso Storelayoutpages, 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, salvo indicação em contrário
excluir DELETE  /enterprises/enterpriseId/storeLayout/pages/pageId Exclui uma página de 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 da loja.
update PUT  /enterprises/enterpriseId/storeLayout/pages/pageId Atualiza o conteúdo de uma página da loja.

Usuários

Para saber mais sobre o recurso Users, 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, salvo indicação em contrário
excluir 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 da 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.

Você pode provisionar até 10 dispositivos por usuário.

Esta chamada só funciona com contas gerenciadas por EMM.
get GET  /enterprises/enterpriseId/users/userId Recupera os detalhes de um usuário.
getAvailableProductSet GET  /enterprises/enterpriseId/users/userId/availableProductSet Recupera o conjunto de produtos a que um usuário tem direito de acesso.
inserir POST  /enterprises/enterpriseId/users Cria um novo usuário gerenciado pelo EMM.

O recurso Usuários 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, o usuário 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 DELETE  /enterprises/enterpriseId/users/userId/deviceAccess Revoga o acesso a todos os dispositivos atualmente provisionados ao usuário. O usuário não poderá mais usar a Play Store gerenciada em nenhum dos dispositivos gerenciados.

Esta chamada só funciona com contas gerenciadas por EMM.
setAvailableProductSet PUT  /enterprises/enterpriseId/users/userId/availableProductSet Modifica o conjunto de produtos que um usuário tem direito de acessar (chamados de produtos whitelisted). Somente produtos aprovados ou que foram aprovados anteriormente (produtos com aprovação revogada) podem ser incluídos na lista de permissões. 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 pelo EMM.

Só pode ser usado com usuários gerenciados por EMM (não com usuários gerenciados 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 estar sem definição 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, salvo indicação em contrário
excluir DELETE  /enterprises/enterpriseId/webApps/webAppId Exclui um app da Web atual.
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 existente.