Importante: Ya no aceptamos registros nuevos para la API de EMM de Play. Más información

API Reference

Organiza tus páginas con colecciones Guarda y categoriza el contenido según tus preferencias.

Esta referencia de API se organiza por tipo de recurso. Cada tipo de recurso tiene una o más representaciones de datos y uno o más métodos.

Tipos de recursos

  1. Dispositivos
  2. Empresas
  3. Derechos
  4. Licencias de grupo
  5. Grouplicenseusers
  6. Instalaciones
  7. Managedconfigurationsfordevice
  8. Managedconfigurationsforuser
  9. Managedconfigurationssettings
  10. Permisos
  11. Productos
  12. Claves de cuenta de servicio
  13. Storelayoutclusters
  14. Storelayoutpages
  15. Usuarios
  16. Aplicaciones web

Dispositivos

Para obtener detalles sobre los recursos de dispositivos, consulta la página Representación de recursos.

Método Solicitud HTTP Descripción
URI relativos a https://www.googleapis.com/androidenterprise/v1, a menos que se indique lo contrario
forceReportUpload POST  /enterprises/enterpriseId/users/userId/devices/deviceId/forceReportUpload Carga un informe que contiene cualquier cambio en los estados de la app en el dispositivo desde que se generó el último informe. Puedes llamar a este método hasta 3 veces cada 24 horas para un dispositivo determinado.
obtener GET  /enterprises/enterpriseId/users/userId/devices/deviceId Recupera los detalles de un dispositivo.
getState GET  /enterprises/enterpriseId/users/userId/devices/deviceId/state Recupera si el acceso de un dispositivo a los servicios de Google está habilitado o inhabilitado. El estado del dispositivo solo tendrá efecto si se aplican de manera forzosa las políticas de EMM en los dispositivos Android en la Consola del administrador de Google. De lo contrario, el estado del dispositivo se ignora y todos los dispositivos tienen acceso a los servicios de Google. Solo se admite para los usuarios administrados por Google.
list GET  /enterprises/enterpriseId/users/userId/devices Recupera los ID de todos los dispositivos de un usuario.
setState PUT  /enterprises/enterpriseId/users/userId/devices/deviceId/state Establece si el acceso de un dispositivo a los servicios de Google está habilitado o inhabilitado. El estado del dispositivo solo tendrá efecto si se aplican de manera forzosa las políticas de EMM en los dispositivos Android en la Consola del administrador de Google. De lo contrario, el estado del dispositivo se ignora y todos los dispositivos tienen acceso a los servicios de Google. Solo se admite para los usuarios administrados por Google.
actualizar PUT  /enterprises/enterpriseId/users/userId/devices/deviceId Actualiza la política de dispositivo.

Para asegurarte de que la política se aplique correctamente, debes impedir que las cuentas no administradas accedan a Google Play. Para ello, establece allowed_accounts en la configuración administrada del paquete de Google Play. Consulta cómo restringir cuentas en Google Play.

Empresas

Para obtener más información sobre recursos empresariales, consulta la página de representación de recursos.

Método Solicitud HTTP Descripción
URI relativos a https://www.googleapis.com/androidenterprise/v1, a menos que se indique lo contrario
acknowledgeNotificationSet POST  /enterprises/acknowledgeNotificationSet Reconoce las notificaciones que se recibieron de Enterprises.PullNotificationSet para evitar que las llamadas posteriores muestren las mismas notificaciones.
completeSignup POST  /enterprises/completeSignup Completa el flujo de registro mediante la especificación del token de finalización y del token empresarial. No se debe llamar a esta solicitud varias veces para un token empresarial determinado.
createWebToken. POST  /enterprises/enterpriseId/createWebToken Muestra un token único para acceder a una IU integrable. Para generar una IU web, pasa el token generado a la API de JavaScript administrada de Google Play. Cada token solo se puede utilizar para iniciar una sesión de IU. Consulta la documentación de la API de JavaScript para obtener más información.
inscribirse POST  /enterprises/enroll Inscribe una empresa en el EMM que realiza la llamada.

Parámetros de consulta obligatorios: token

generateSignupUrl POST  /enterprises/signupUrl Genera una URL de registro.
obtener GET  /enterprises/enterpriseId Recupera el nombre y el dominio de una empresa.
getServiceAccount GET  /enterprises/enterpriseId/serviceAccount Muestra una cuenta de servicio y credenciales. La cuenta de servicio se puede vincular a la empresa llamando a setAccount. La cuenta de servicio es exclusiva de esta empresa y de EMM, y se borrará si la empresa no está vinculada. Las credenciales contienen datos de clave privada y no se almacenan del lado del servidor.

Este método solo se puede llamar después de llamar a Enterprises.Enroll o Enterprises.CompleteSignup, y antes de Enterprises.SetAccount. En otras ocasiones, se mostrará un error.

Las llamadas posteriores después de la primera generarán un nuevo conjunto de credenciales único y, además, invalidarán las credenciales generadas con anterioridad.

Una vez que la cuenta de servicio esté vinculada a la empresa, se puede administrar con el recurso serviceAccountKeys.
getStoreLayout. GET  /enterprises/enterpriseId/storeLayout Muestra el diseño de la tienda para la empresa. Si no se estableció el diseño de la tienda, se muestra el valor "basic" como el tipo de diseño de la tienda y no como la página principal.
list GET  /enterprises Busca una empresa por el nombre del dominio. Esto solo es compatible con las empresas creadas a través del flujo de creación iniciado por Google. La búsqueda del ID no es necesaria para las empresas creadas a través del flujo iniciado por EMM, ya que este aprende el ID de la empresa en la devolución de llamada especificada en la llamada Enterprises.generateSignupUrl.

Parámetros de consulta obligatorios: domain

pullNotificationSet POST  /enterprises/pullNotificationSet Extrae y muestra un conjunto de notificaciones para las empresas asociadas con la cuenta de servicio autenticada para la solicitud. El conjunto de notificaciones puede estar vacío si no hay una notificación pendiente.
Un conjunto de notificaciones que se muestra debe confirmar su recepción en 20 segundos llamando a Enterprises.AcknowledgeNotificationSet, a menos que esté vacío.
Las notificaciones que no se confirmen dentro de los 20 segundos se incluirán de nuevo en la respuesta a otra solicitud PullNotificationSet, y las que nunca se reconozcan se borrarán de acuerdo con la política del sistema de Google Cloud Platform Pub/Sub.
Es posible que se realicen varias solicitudes de forma simultánea para recuperar notificaciones, en cuyo caso las notificaciones pendientes (si las hay) se dividirán entre cada emisor, si es que hay alguna pendiente.
Si no hay notificaciones, se muestra una lista vacía. Las solicitudes posteriores pueden mostrar más notificaciones cuando están disponibles.
sendTestPushNotification. POST  /enterprises/enterpriseId/sendTestPushNotification Envía una notificación de prueba a fin de validar la integración de EMM con el servicio de Google Cloud Pub/Sub para esta empresa.
setAccount PUT  /enterprises/enterpriseId/account Configura la cuenta que se usará para autenticarse en la API como empresa.
setStoreLayout; PUT  /enterprises/enterpriseId/storeLayout Establece el diseño de la tienda para la empresa. De forma predeterminada, storeLayoutType se configura como "basic" y el diseño básico de la tienda está habilitado. El diseño básico solo contiene apps aprobadas por el administrador y que se agregaron al conjunto de productos disponible para un usuario (mediante la llamada setAvailableProductSet). Las apps de la página se ordenan según el valor del ID del producto. Si creas un diseño personalizado de Store (configurando storeLayoutType = "custom" y configurando una página principal), el diseño básico de tienda se inhabilita.
anular la inscripción POST  /enterprises/enterpriseId/unenroll Permite dar de baja una empresa en el EMM que realiza la llamada.

Autorizaciones

Para obtener más información sobre los recursos de derechos, consulta la página Representación de recursos.

Método Solicitud HTTP Descripción
URI relativos a https://www.googleapis.com/androidenterprise/v1, a menos que se indique lo contrario
borrar DELETE  /enterprises/enterpriseId/users/userId/entitlements/entitlementId Quita un derecho a una app para un usuario. Nota: Este elemento ya no está disponible. Las integraciones nuevas no pueden usar este método y pueden consultar nuestras recomendaciones nuevas.
obtener GET  /enterprises/enterpriseId/users/userId/entitlements/entitlementId Recupera los detalles de una autorización. Nota: Este elemento ya no está disponible. Las integraciones nuevas no pueden usar este método y pueden consultar nuestras recomendaciones nuevas.
list GET  /enterprises/enterpriseId/users/userId/entitlements Enumera todos los derechos del usuario especificado. Solo se estableció el ID. Nota: Este elemento ya no está disponible. Las integraciones nuevas no pueden usar este método y pueden consultar nuestras recomendaciones nuevas.
actualizar PUT  /enterprises/enterpriseId/users/userId/entitlements/entitlementId Agrega o actualiza una autorización para un usuario en una app. Nota: Este elemento ya no está disponible. Las integraciones nuevas no pueden usar este método y pueden consultar nuestras recomendaciones nuevas.

Licencias de grupo

Para obtener más información sobre los recursos de licencias de grupo, consulta la página Representación de recursos.

Método Solicitud HTTP Descripción
URI relativos a https://www.googleapis.com/androidenterprise/v1, a menos que se indique lo contrario
obtener GET  /enterprises/enterpriseId/groupLicenses/groupLicenseId Recupera los detalles de la licencia grupal de una empresa para un producto. Nota: Este elemento ya no está disponible. Las integraciones nuevas no pueden usar este método y pueden consultar nuestras recomendaciones nuevas.
list GET  /enterprises/enterpriseId/groupLicenses Recupera los ID de todos los productos para los que la empresa tiene una licencia de grupo. Nota: Este elemento ya no está disponible. Las integraciones nuevas no pueden usar este método y pueden consultar nuestras recomendaciones nuevas.

Usuarios del grupo de licencias

Para obtener más información sobre los recursos de licencia de grupo, consulta la página de representación de recursos.

Método Solicitud HTTP Descripción
URI relativos a https://www.googleapis.com/androidenterprise/v1, a menos que se indique lo contrario
list GET  /enterprises/enterpriseId/groupLicenses/groupLicenseId/users Recupera los ID de los usuarios a los que se les otorgaron derechos bajo la licencia. Nota: Este elemento ya no está disponible. Las integraciones nuevas no pueden usar este método y pueden consultar nuestras recomendaciones nuevas.

Instalaciones

Para obtener detalles sobre los recursos de instalaciones, consulta la página de representación de recursos.

Método Solicitud HTTP Descripción
URI relativos a https://www.googleapis.com/androidenterprise/v1, a menos que se indique lo contrario
borrar DELETE  /enterprises/enterpriseId/users/userId/devices/deviceId/installs/installId Solicitudes para quitar una app de un dispositivo. Una llamada a get o list seguirá mostrando la app como instalada en el dispositivo hasta que se quite.
obtener GET  /enterprises/enterpriseId/users/userId/devices/deviceId/installs/installId Recupera los detalles de una instalación de una app en un dispositivo.
list GET  /enterprises/enterpriseId/users/userId/devices/deviceId/installs Recupera los detalles de todas las aplicaciones instaladas en el dispositivo especificado.
actualizar PUT  /enterprises/enterpriseId/users/userId/devices/deviceId/installs/installId Solicitudes para instalar la versión más reciente de una app en un dispositivo Si la app ya está instalada, se actualiza a la última versión si es necesario.

ManagedConfigurationsfordevice

Para obtener detalles sobre el recurso Managedconfigurationsfordevice, consulta la página de representación de recursos.

Método Solicitud HTTP Descripción
URI relativos a https://www.googleapis.com/androidenterprise/v1, a menos que se indique lo contrario
borrar DELETE  /enterprises/enterpriseId/users/userId/devices/deviceId/managedConfigurationsForDevice/managedConfigurationForDeviceId Quita una configuración administrada por dispositivo de una app para el dispositivo especificado.
obtener GET  /enterprises/enterpriseId/users/userId/devices/deviceId/managedConfigurationsForDevice/managedConfigurationForDeviceId Recupera los detalles de una configuración administrada por dispositivo.
list GET  /enterprises/enterpriseId/users/userId/devices/deviceId/managedConfigurationsForDevice Enumera todas las configuraciones administradas por dispositivo para el dispositivo especificado. Solo se estableció el ID.
actualizar PUT  /enterprises/enterpriseId/users/userId/devices/deviceId/managedConfigurationsForDevice/managedConfigurationForDeviceId Agrega o actualiza una configuración administrada por dispositivo para una app en el dispositivo especificado.

ManagedConfigurationsforuser

Para obtener más información sobre ManagedConfigurationsforuser Resource, consulta la página de representación de recursos.

Método Solicitud HTTP Descripción
URI relativos a https://www.googleapis.com/androidenterprise/v1, a menos que se indique lo contrario
borrar DELETE  /enterprises/enterpriseId/users/userId/managedConfigurationsForUser/managedConfigurationForUserId Quita una configuración administrada por usuario para una app para el usuario especificado.
obtener GET  /enterprises/enterpriseId/users/userId/managedConfigurationsForUser/managedConfigurationForUserId Recupera los detalles de una configuración administrada por usuario para una app para el usuario especificado.
list GET  /enterprises/enterpriseId/users/userId/managedConfigurationsForUser Muestra una lista de todas las opciones de configuración administradas por usuario para el usuario especificado. Solo se configura el ID.
actualizar PUT  /enterprises/enterpriseId/users/userId/managedConfigurationsForUser/managedConfigurationForUserId Agrega o actualiza los ajustes de configuración administrados de una app para el usuario especificado. Si admites el iframe de configuración administrada, puedes aplicar parámetros de configuración administrados a un usuario si especificas un mcmId y sus variables de configuración asociadas (si las hay) en la solicitud. Como alternativa, todos los EMM pueden aplicar configuraciones administradas pasando una lista de propiedades administradas.

Configuración de la configuración administrada

Para obtener más información sobre los recursos de ManagedConfigurationssettings, consulta la página de representación de recursos.

Método Solicitud HTTP Descripción
URI relativos a https://www.googleapis.com/androidenterprise/v1, a menos que se indique lo contrario
list GET  /enterprises/enterpriseId/products/productId/managedConfigurationsSettings Muestra una lista de todas las opciones de configuración administradas de la app especificada.

Permisos

Para obtener detalles sobre los recursos de permisos, consulta la página Representación de recursos.

Método Solicitud HTTP Descripción
URI relativos a https://www.googleapis.com/androidenterprise/v1, a menos que se indique lo contrario
obtener GET  /permissions/permissionId Recupera los detalles de un permiso de apps para Android a fin de que se muestre a un administrador empresarial.

Productos

Para obtener detalles sobre los recursos de productos, consulta la página de representación de recursos.

Método Solicitud HTTP Descripción
URI relativos a https://www.googleapis.com/androidenterprise/v1, a menos que se indique lo contrario
aprobar POST  /enterprises/enterpriseId/products/productId/approve

Aprueba el producto especificado y los permisos relevantes de la app, si los hubiera. La cantidad máxima de productos que puedes aprobar por cliente empresarial es de 1,000.

Para obtener información sobre cómo usar Google Play administrado a fin de crear y crear un diseño de la tienda para mostrar productos aprobados a tus usuarios, consulta Diseño de Play Store.

Nota: Este elemento ya no está disponible. Las integraciones nuevas no pueden usar este método y pueden consultar nuestras recomendaciones nuevas.
generateApprovalUrl POST  /enterprises/enterpriseId/products/productId/generateApprovalUrl Genera una URL que se puede renderizar en un iframe para mostrar los permisos de un producto (si existe). Un administrador empresarial debe ver estos permisos y aceptarlos en nombre de su organización para aprobar ese producto.

Los administradores deben aceptar los permisos que se muestran interactuando con un elemento de la IU diferente en la consola de EMM, que, a su vez, debería activar el uso de esta URL como la propiedad approvalUrlInfo.approvalUrl en una llamada Products.approve para aprobar el producto. Esta URL solo se puede usar para mostrar permisos durante 1 día como máximo. Nota: Este elemento ya no está disponible. Las integraciones nuevas no pueden usar este método y pueden consultar nuestras recomendaciones nuevas.
obtener GET  /enterprises/enterpriseId/products/productId Recupera los detalles de un producto para mostrárselos a un administrador empresarial.
getAppRestrictionsSchema. GET  /enterprises/enterpriseId/products/productId/appRestrictionsSchema Recupera el esquema que define las propiedades configurables de este producto. Todos los productos tienen un esquema, pero es posible que esté vacío si no se definió ninguna configuración administrada. Este esquema se puede usar para propagar una IU que permita que un administrador configure el producto. Para aplicar una configuración administrada basada en el esquema obtenido con esta API, consulta Opciones de configuración administradas a través de Play.
getPermissions GET  /enterprises/enterpriseId/products/productId/permissions Recupera los permisos que requiere esta app para Android.
list GET  /enterprises/enterpriseId/products Encuentra productos aprobados que coincidan con una consulta o todos los productos aprobados si no hay una consulta. Nota: Este elemento ya no está disponible. Las integraciones nuevas no pueden usar este método y pueden consultar nuestras recomendaciones nuevas.
aprobar POST  /enterprises/enterpriseId/products/productId/unapprove Anula la aprobación del producto especificado (y los permisos de la app relevantes, si los hubiera). Nota: Este elemento ya no está disponible. Las integraciones nuevas no pueden usar este método y pueden consultar nuestras recomendaciones nuevas.

Claves de cuenta de servicio

Para obtener detalles sobre el recurso Serviceaccountkeys, consulta la página de representación de recursos.

Método Solicitud HTTP Descripción
URI relativos a https://www.googleapis.com/androidenterprise/v1, a menos que se indique lo contrario
borrar DELETE  /enterprises/enterpriseId/serviceAccountKeys/keyId Quita e invalida las credenciales especificadas para la cuenta de servicio asociada con esta empresa. La cuenta de servicio de llamadas debe haberse recuperado llamando a Enterprises.GetServiceAccount y se debe haber establecido como la cuenta de servicio empresarial llamando a Enterprise.SetAccount.
insertar POST  /enterprises/enterpriseId/serviceAccountKeys Genera credenciales nuevas para la cuenta de servicio asociada con esta empresa. La cuenta de servicio de llamadas debe haber sido recuperada llamando a Enterprises.GetServiceAccount y debe haberse establecido como la cuenta de servicio empresarial llamando a Enterprises.SetAccount.

Solo se debe propagar el tipo de clave en el recurso que se insertará.
list GET  /enterprises/enterpriseId/serviceAccountKeys Muestra una lista de todas las credenciales activas de la cuenta de servicio asociada con esta empresa. Solo se muestran el ID y el tipo de clave. La cuenta de servicio de llamadas debe haberse recuperado con una llamada a Enterprises.GetServiceAccount y debe haberse establecido como la cuenta de servicio empresarial mediante un llamado a Enterprise.SetAccount.

Clústeres del diseño de la tienda

Para obtener detalles sobre los recursos de Storelayoutclusters, consulta la página de representación de recursos.

Método Solicitud HTTP Descripción
URI relativos a https://www.googleapis.com/androidenterprise/v1, a menos que se indique lo contrario
borrar DELETE  /enterprises/enterpriseId/storeLayout/pages/pageId/clusters/clusterId Borra un clúster.
obtener GET  /enterprises/enterpriseId/storeLayout/pages/pageId/clusters/clusterId Recupera los detalles de un clúster.
insertar POST  /enterprises/enterpriseId/storeLayout/pages/pageId/clusters Inserta un clúster nuevo en una página.
list GET  /enterprises/enterpriseId/storeLayout/pages/pageId/clusters Recupera los detalles de todos los clústeres en la página especificada.
actualizar PUT  /enterprises/enterpriseId/storeLayout/pages/pageId/clusters/clusterId Actualiza un clúster.

Páginas de diseño de la tienda

Para obtener detalles sobre el recurso Storelayoutpages, consulta la página de representación de recursos.

Método Solicitud HTTP Descripción
URI relativos a https://www.googleapis.com/androidenterprise/v1, a menos que se indique lo contrario
borrar DELETE  /enterprises/enterpriseId/storeLayout/pages/pageId Borra una página de la tienda.
obtener GET  /enterprises/enterpriseId/storeLayout/pages/pageId Recupera los detalles de una página de la tienda.
insertar POST  /enterprises/enterpriseId/storeLayout/pages Inserta una nueva página de la tienda.
list GET  /enterprises/enterpriseId/storeLayout/pages Recupera los detalles de todas las páginas de la tienda.
actualizar PUT  /enterprises/enterpriseId/storeLayout/pages/pageId Actualiza el contenido de una página de la tienda.

Usuarios

Para obtener detalles sobre los recursos de usuario, consulta la página de representación de recursos.

Método Solicitud HTTP Descripción
URI relativos a https://www.googleapis.com/androidenterprise/v1, a menos que se indique lo contrario
borrar DELETE  /enterprises/enterpriseId/users/userId Se borró un usuario administrado por EMM.
generateAuthenticationToken POST  /enterprises/enterpriseId/users/userId/authenticationToken Genera un token de autenticación que el cliente de política de dispositivo puede usar para aprovisionar la cuenta de usuario determinada administrada por EMM en un dispositivo. El token generado es de uso único y vence después de unos minutos.

Puedes aprovisionar un máximo de 10 dispositivos por usuario.

Esta llamada solo funciona con cuentas administradas por EMM.
obtener GET  /enterprises/enterpriseId/users/userId Recupera los detalles de un usuario.
getAvailableProductSet GET  /enterprises/enterpriseId/users/userId/availableProductSet Recupera el conjunto de productos al que un usuario tiene derecho a acceder. Nota: Este elemento ya no está disponible. Las integraciones nuevas no pueden usar este método y pueden consultar nuestras recomendaciones nuevas.
insertar POST  /enterprises/enterpriseId/users Crea un usuario nuevo administrado por EMM.

El recurso Users que se pasa en el cuerpo de la solicitud debe incluir un accountIdentifier y un accountType.

Si ya existe un usuario correspondiente con el mismo identificador de cuenta, el usuario se actualizará con el recurso. En este caso, solo se puede cambiar el campo displayName.

list GET  /enterprises/enterpriseId/users Busca un usuario por su dirección de correo electrónico principal. Solo se admite para los usuarios administrados por Google. La búsqueda del ID no es necesaria para los usuarios administrados por EMM porque el ID ya se muestra en el resultado de la llamada Users.insert.

Parámetros de consulta obligatorios: email

revokeDeviceAccess DELETE  /enterprises/enterpriseId/users/userId/deviceAccess Revoca el acceso a todos los dispositivos que se hayan aprovisionado al usuario. El usuario ya no podrá usar Play Store administrado en ninguno de sus dispositivos administrados.

Esta llamada solo funciona con cuentas administradas por EMM.
setAvailableProductSet PUT  /enterprises/enterpriseId/users/userId/availableProductSet Modifica el conjunto de productos al que un usuario tiene derecho a acceder (denominados productos incluidos en la lista blanca). Solo se pueden incluir en la lista blanca los productos que están aprobados o los que ya se aprobaron (productos con aprobación revocada). Nota: Este elemento ya no está disponible. Las integraciones nuevas no pueden usar este método y pueden consultar nuestras recomendaciones nuevas.
actualizar PUT  /enterprises/enterpriseId/users/userId Actualiza los detalles de un usuario administrado por EMM.

Solo se puede usar con usuarios administrados por EMM (no a usuarios administrados por Google). Pasa los detalles nuevos en el recurso Users, en el cuerpo de la solicitud. Solo se puede cambiar el campo displayName. Los otros campos no deben estar configurados o deben tener el valor activo en este momento.

Aplicaciones web

Para obtener detalles sobre los recursos de aplicaciones web, consulta la página Representación de recursos.

Método Solicitud HTTP Descripción
URI relativos a https://www.googleapis.com/androidenterprise/v1, a menos que se indique lo contrario
borrar DELETE  /enterprises/enterpriseId/webApps/webAppId Borra una app web existente.
obtener GET  /enterprises/enterpriseId/webApps/webAppId Obtiene una aplicación web existente.
insertar POST  /enterprises/enterpriseId/webApps Crea una aplicación web nueva para la empresa.
list GET  /enterprises/enterpriseId/webApps Recupera los detalles de todas las aplicaciones web de una empresa determinada.
actualizar PUT  /enterprises/enterpriseId/webApps/webAppId Actualiza una aplicación web existente.