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. Enrollmenttokens
  3. Empresas
  4. Direitos
  5. Grouplicenses
  6. Grouplicenseusers
  7. Instalações
  8. Managedconfigurationsfordevice
  9. Managedconfigurationsforuser
  10. Managedconfigurationssettings
  11. Permissões
  12. Produtos
  13. Serviceaccountkeys
  14. Storelayoutclusters
  15. Storelayoutpages
  16. Usuários
  17. Webapps

Dispositivos

Para detalhes 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 POST  /enterprises/enterpriseId/users/userId/devices/deviceId/forceReportUpload Faz upload de um relatório com as mudanças nos estados do app no dispositivo desde a geração do último relatório. É possível chamar esse método 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 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ó entra 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 acesso aos Serviços do Google. Esse recurso está disponível apenas para 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ó entra 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 acesso aos Serviços do Google. Esse recurso está disponível apenas para 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, impeça que contas não gerenciadas acessem o Google Play definindo o allowed_accounts na configuração gerenciada do pacote do Google Play. Consulte restringir contas no Google Play.

Enrollmenttokens

Para saber mais sobre o recurso Enrollmenttokens, 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
create POST  /enterprises/enterpriseId/enrollmentTokens Cria um token de inscrição para a empresa. Esse método faz parte do EnrollmentTokensService.

Empresas

Para detalhes 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, a menos que especificado de outra forma
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 empresarial.
createWebToken POST  /enterprises/enterpriseId/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 da interface. Consulte a documentação da API JavaScript para mais informações.
enroll POST  /enterprises/enroll Registra uma empresa com o EMM de chamada.

Parâmetros de consulta obrigatórios: token

generateEnterpriseUpgradeUrl POST  /enterprises/enterpriseId/generateEnterpriseUpgradeUrl Gera um URL de upgrade empresarial para atualizar um pacote de contas do Google Play gerenciado para um Managed Google Domain. Consulte o guia de upgrade de uma empresa para mais detalhes.
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 dessa empresa e 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 Enterprises.Enroll ou Enterprises.CompleteSignup e antes de Enterprises.SetAccount. Em outros momentos, ele vai retornar um erro.

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

Depois que 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 para a empresa. Se o layout da loja não tiver sido definido, vai retornar "basic" como o tipo de layout e nenhuma página inicial.
list GET  /enterprises Pesquisa uma empresa pelo 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, já que o EMM aprende o ID da empresa no callback especificado na chamada "Enterprises.generateSignupUrl".

Parâmetros de consulta obrigatórios: domain

pullNotificationSet 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 não houver notificações pendentes.
Um conjunto de notificações retornado precisa ser confirmado em até 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 outra solicitação 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 feitas simultaneamente para recuperar notificações. Nesse caso, as notificações pendentes (se houver) serão divididas entre cada chamador, se houver alguma pendente.
Se não houver notificações, uma lista vazia será retornada. As solicitações subsequentes podem retornar mais notificações assim que elas ficarem disponíveis.
sendTestPushNotification 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 PUT  /enterprises/enterpriseId/storeLayout Define o layout da loja para a empresa. Por padrão, storeLayoutType é definido como "basic" e o layout básico da loja é ativado. O layout básico só contém 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 de acordo com o valor do ID do produto. Se você criar um layout de loja personalizado (definindo storeLayoutType = "custom" e uma página inicial), o layout básico será desativado.
unenroll POST  /enterprises/enterpriseId/unenroll Cancela a inscrição de uma empresa no EMM de chamadas.

Direitos

Para detalhes sobre o recurso Entitlements, 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
delete DELETE  /enterprises/enterpriseId/users/userId/entitlements/entitlementId Remove o direito de acesso a um app para um usuário.
get GET  /enterprises/enterpriseId/users/userId/entitlements/entitlementId Recupera os detalhes de um direito.
list GET  /enterprises/enterpriseId/users/userId/entitlements Lista todos os direitos do usuário especificado. Apenas o ID é definido.
update PUT  /enterprises/enterpriseId/users/userId/entitlements/entitlementId Adiciona ou atualiza um direito de acesso a um app para um usuário.

Grouplicenses

Para detalhes sobre o recurso GroupLicenses, 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
get GET  /enterprises/enterpriseId/groupLicenses/groupLicenseId Recupera detalhes da licença de grupo de uma empresa para um produto.
list GET  /enterprises/enterpriseId/groupLicenses Recupera os IDs de todos os produtos para os quais a empresa tem uma licença de grupo.

Grouplicenseusers

Para detalhes sobre o recurso Grouplicenseusers, 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
list GET  /enterprises/enterpriseId/groupLicenses/groupLicenseId/users Recupera os IDs dos usuários que receberam direitos na licença.

Instalações

Para saber mais sobre o recurso Installs, 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/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 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.

Managedconfigurationsfordevice

Para detalhes sobre o recurso Managedconfigurationsfordevice, 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
delete DELETE  /enterprises/enterpriseId/users/userId/devices/deviceId/managedConfigurationsForDevice/managedConfigurationForDeviceId Remove uma configuração gerenciada por dispositivo de um app para o 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 no dispositivo especificado.

Managedconfigurationsforuser

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 do usuário especificado.
list GET  /enterprises/enterpriseId/users/userId/managedConfigurationsForUser Lista todas as configurações gerenciadas por usuário para o usuário especificado. Apenas o ID é definido.
update PUT  /enterprises/enterpriseId/users/userId/managedConfigurationsForUser/managedConfigurationForUserId Adiciona ou atualiza as configurações de configuração gerenciada de um app para o usuário especificado. Se você for compatível com o iframe de configurações gerenciadas, poderá 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, todas as EMMs podem aplicar configurações gerenciadas transmitindo uma lista de propriedades gerenciadas.

Managedconfigurationssettings

Para detalhes sobre o recurso Managedconfigurationssettings, 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/products/productId/managedConfigurationsSettings Lista todas as configurações 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, a menos que especificado de outra forma
get GET  /permissions/permissionId Recupera detalhes de uma permissão de app Android para mostrar 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, a menos que especificado de outra forma
approve 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 empresarial é 1.000.

Para saber como usar o Google Play gerenciado para projetar e criar um layout de loja que mostre produtos aprovados aos usuários, consulte Design de layout da loja.
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 analisar 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 EMM, que, por sua vez, 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 mostrar permissões por até um dia.
get GET  /enterprises/enterpriseId/products/productId Recupera detalhes de um produto para mostrar a um administrador corporativo.
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 obtido usando essa API, consulte Configurações gerenciadas pelo Google Play.
getPermissions GET  /enterprises/enterpriseId/products/productId/permissions Recupera as permissões do app Android necessárias para este app.
list GET  /enterprises/enterpriseId/products Encontra produtos aprovados que correspondem a uma consulta ou todos os produtos aprovados se não houver uma consulta.
unapprove POST  /enterprises/enterpriseId/products/productId/unapprove Cancela a aprovação do produto especificado (e das permissões relevantes do app, se houver).

Serviceaccountkeys

Para detalhes sobre o recurso Serviceaccountkeys, 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/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 definida como a conta de serviço da empresa 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 definida como a conta de serviço da empresa chamando Enterprises.SetAccount.

Apenas o tipo da chave precisa 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 definida como a conta de serviço da empresa chamando Enterprises.SetAccount.

Storelayoutclusters

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.

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, 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 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, a menos que especificado de outra forma
delete DELETE  /enterprises/enterpriseId/users/userId Excluiu um usuário gerenciado por EMM.
generateAuthenticationToken POST  /enterprises/enterpriseId/users/userId/authenticationToken Gera um token de autenticação que o cliente de política de dispositivo pode usar para provisionar a conta de usuário gerenciada por EMM em um dispositivo. O token gerado é de uso único e expira após alguns minutos.

É possível provisionar até 10 dispositivos por usuário.

Essa 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 usuário gerenciado por EMM.

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

Se um usuário correspondente já existir com o mesmo identificador de conta, ele será atualizado com o recurso. Nesse caso, apenas o campo displayName pode ser mudado.
list GET  /enterprises/enterpriseId/users Procura um usuário pelo endereço de e-mail principal. Esse recurso está disponível apenas para usuários gerenciados pelo Google. A pesquisa do ID não é necessária para usuários gerenciados por EMM porque o ID já é 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 provisionados para o usuário. O usuário não poderá mais usar a Play Store gerenciada em nenhum dos dispositivos gerenciados.

Essa 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 na lista de permissões). Apenas produtos aprovados ou que foram aprovados anteriormente (produtos com aprovação revogada) podem ser adicionados à lista de permissões.
update PUT  /enterprises/enterpriseId/users/userId Atualiza os detalhes de um usuário gerenciado por EMM.

Só pode ser usado com usuários gerenciados por EMM, não pelo Google. Transmita os novos detalhes no recurso Users no corpo da solicitação. Apenas o campo displayName pode ser mudado. Os outros campos precisam estar sem definição ou ter o valor ativo no momento.

Apps da Web

Para detalhes 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 atual.
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 web apps de uma determinada empresa.
update PUT  /enterprises/enterpriseId/webApps/webAppId Atualiza um web app existente.